Class LocalizedString.ExpressionTranslation

java.lang.Object

com.lokalized.LocalizedString.PlaceholderDefinition

com.lokalized.LocalizedString.ExpressionTranslation

Enclosing class:

LocalizedString

@Immutable
public static final class LocalizedString.ExpressionTranslation
extends LocalizedString.PlaceholderDefinition

A generated fragment with a required default translation and optional ordered expression-driven alternatives.

The first alternative whose expression matches supplies the fragment. If none match, the default translation is used. The one-argument constructor creates a translation-only scoped fragment.

Since:

3.0.0

Author:

Mark Allen

Constructor Summary

Constructors

Constructor	Description
ExpressionTranslation(@NonNull String translation)	Constructs a translation-only generated fragment.
ExpressionTranslation(@NonNull String translation, @NonNull List<@NonNull LocalizedString.ExpressionAlternative> alternatives)	Constructs a generated fragment with a default translation and ordered expression-driven alternatives.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object other)	Checks if this object is equal to another one.
@NonNull List<@NonNull LocalizedString.ExpressionAlternative>	getAlternatives()	Gets the ordered expression-driven alternatives.
@NonNull String	getTranslation()	Gets the default fragment translation.
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

ExpressionTranslation

public ExpressionTranslation(@NonNull String translation)

Constructs a translation-only generated fragment.

Parameters:

translation - the fragment translation, not null

ExpressionTranslation

public ExpressionTranslation(@NonNull String translation,
 @NonNull List<@NonNull LocalizedString.ExpressionAlternative> alternatives)

Constructs a generated fragment with a default translation and ordered expression-driven alternatives.

Parameters:

translation - the default fragment translation, not null

alternatives - the ordered expression-driven alternatives, not null or empty

Throws:

NullPointerException - if alternatives contains a null element

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

getTranslation

public @NonNull String getTranslation()

Gets the default fragment translation.

Returns:

the default fragment translation, not null

getAlternatives

public @NonNull List<@NonNull LocalizedString.ExpressionAlternative> getAlternatives()

Gets the ordered expression-driven alternatives.

Returns:

the ordered expression-driven alternatives, empty for a translation-only fragment, not null