Class LocalizedString.LanguageFormTranslationRule

java.lang.Object

com.lokalized.LocalizedString.LanguageFormTranslationRule

Enclosing class:

LocalizedString

@Immutable
public static class LocalizedString.LanguageFormTranslationRule
extends Object

Defines a selector-based translation rule for a multi-axis placeholder translation.

Rules may optionally provide a when map. An empty map represents the default rule.

Author:

Mark Allen

Constructor Summary

Constructors

Constructor	Description
LanguageFormTranslationRule(@NonNull String value)	Constructs a default translation rule with no conditions.
LanguageFormTranslationRule(@NonNull Map<@NonNull LanguageFormType, @NonNull LanguageForm> whenByLanguageFormType, @NonNull String value)	Constructs a translation rule with the given selector conditions and value.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object other)	Checks if this object is equal to another one.
@NonNull String	getValue()	Gets the value for this rule.
@NonNull Map<@NonNull LanguageFormType, @NonNull LanguageForm>	getWhenByLanguageFormType()	Gets the selector conditions for this rule.
int	hashCode()	A hash code for this object.
@NonNull String	toString()	Generates a String representation of this object.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

LanguageFormTranslationRule

public LanguageFormTranslationRule(@NonNull String value)

Constructs a default translation rule with no conditions.

Parameters:

value - the value to use when this rule matches, not null

LanguageFormTranslationRule

public LanguageFormTranslationRule(@NonNull Map<@NonNull LanguageFormType, @NonNull LanguageForm> whenByLanguageFormType,
 @NonNull String value)

Constructs a translation rule with the given selector conditions and value.

Parameters:

whenByLanguageFormType - selector conditions that must be satisfied for this rule to match, not null

value - the value to use when this rule matches, not null

Method Details

toString

public @NonNull String toString()

Generates a String representation of this object.

Overrides:

toString in class Object

Returns:

a string representation of this object, not null

equals

public boolean equals(@Nullable Object other)

Checks if this object is equal to another one.

Overrides:

equals in class Object

Parameters:

other - the object to check, null returns false

Returns:

true if this is equal to the other object, false otherwise

hashCode

public int hashCode()

A hash code for this object.

Overrides:

hashCode in class Object

Returns:

a suitable hash code

getWhenByLanguageFormType

public @NonNull Map<@NonNull LanguageFormType, @NonNull LanguageForm> getWhenByLanguageFormType()

Gets the selector conditions for this rule.

Returns:

the selector conditions for this rule, not null

getValue

public @NonNull String getValue()

Gets the value for this rule.

Returns:

the value for this rule, not null