Class TranslationOptions

java.lang.Object

com.lokalized.TranslationOptions

@ThreadSafe
public final class TranslationOptions
extends Object

Per-invocation options for localized string lookup.

These options override the defaults configured on a Strings instance for a single lookup. Instances are structurally immutable and safe to share. A configured TranslationFailureHandler or TranslationFallbackPolicy may be invoked concurrently when the same options are used by concurrent lookups; application-supplied implementations must therefore be thread-safe.

Since:

3.0.0

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TranslationOptions.Builder	Builder used to construct TranslationOptions instances.

Method Summary

Modifier and Type	Method	Description
static @NonNull TranslationOptions.Builder	builder()	Creates a translation options builder.
boolean	equals(@Nullable Object other)	Checks if this object is equal to another one.
static @NonNull TranslationOptions	forLanguageRanges(@NonNull List<@NonNull Locale.LanguageRange> languageRanges)	Gets options which use the specified language ranges for a single lookup.
static @NonNull TranslationOptions	forLocale(@NonNull Locale locale)	Gets options which use the specified locale for a single lookup.
@NonNull Optional<@NonNull BidiIsolation>	getBidiIsolation()	Gets the bidirectional isolation override, if configured.
@NonNull Optional<@NonNull List<@NonNull Locale.LanguageRange>>	getLanguageRanges()	Gets the language-range override, if configured.
@NonNull Optional<@NonNull Locale>	getLocale()	Gets the locale override, if configured.
@NonNull Optional<@NonNull TranslationFailureHandler>	getTranslationFailureHandler()	Gets the translation failure handler override, if configured.
@NonNull Optional<@NonNull TranslationFallbackPolicy>	getTranslationFallbackPolicy()	Gets the locale-fallback policy override, if configured.
int	hashCode()	A hash code for this object.
static @NonNull TranslationOptions	none()	Gets options which do not override any Strings instance defaults.
@NonNull TranslationOptions.Builder	toBuilder()	Creates a builder initialized with this instance's values.
@NonNull String	toString()	Generates a String representation of this object.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

none

public static @NonNull TranslationOptions none()

Gets options which do not override any Strings instance defaults.

Returns:

empty translation options, not null

forLocale

public static @NonNull TranslationOptions forLocale(@NonNull Locale locale)

Gets options which use the specified locale for a single lookup.

Parameters:

locale - locale to use, not null

Returns:

translation options, not null

Throws:

IllegalArgumentException - if the locale is not well-formed

forLanguageRanges

public static @NonNull TranslationOptions forLanguageRanges(@NonNull List<@NonNull Locale.LanguageRange> languageRanges)

Gets options which use the specified language ranges for a single lookup.

Parameters:

languageRanges - language ranges to use, not null

Returns:

translation options, not null

Throws:

IllegalArgumentException - if more than LocaleMatcher.MAXIMUM_LANGUAGE_RANGES language ranges are supplied

builder

public static @NonNull TranslationOptions.Builder builder()

Creates a translation options builder.

Returns:

the builder, not null

getLocale

public @NonNull Optional<@NonNull Locale> getLocale()

Gets the locale override, if configured.

Returns:

an optional containing the locale override when configured, otherwise empty. not null

getLanguageRanges

public @NonNull Optional<@NonNull List<@NonNull Locale.LanguageRange>> getLanguageRanges()

Gets the language-range override, if configured.

Returns:

an optional containing the language-range override when configured, otherwise empty. not null

getBidiIsolation

public @NonNull Optional<@NonNull BidiIsolation> getBidiIsolation()

Gets the bidirectional isolation override, if configured.

Returns:

an optional containing the bidirectional isolation override when configured, otherwise empty. not null

getTranslationFailureHandler

public @NonNull Optional<@NonNull TranslationFailureHandler> getTranslationFailureHandler()

Gets the translation failure handler override, if configured.

The handler may be invoked concurrently when these options are shared and must be thread-safe.

Returns:

an optional containing the translation failure handler override when configured, otherwise empty. not null

getTranslationFallbackPolicy

public @NonNull Optional<@NonNull TranslationFallbackPolicy> getTranslationFallbackPolicy()

Gets the locale-fallback policy override, if configured.

The policy may be invoked concurrently when these options are shared and must be thread-safe.

Returns:

configured fallback policy, or empty, not null

toBuilder

public @NonNull TranslationOptions.Builder toBuilder()

Creates a builder initialized with this instance's values.

Returns:

the builder, not null

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