Class LocaleMatchResult

java.lang.Object

com.lokalized.LocaleMatchResult

All Implemented Interfaces:

Serializable

@Immutable
public final class LocaleMatchResult
extends Object
implements Serializable

Strict, immutable diagnostic result for locale negotiation.

This value supports Java serialization, including its requested Locale.LanguageRange values.

Since:

3.0.0

Author:

Mark Allen

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
LocaleMatchResult(@NonNull List<@NonNull Locale.LanguageRange> requestedLanguageRanges, @Nullable Locale locale, @Nullable Locale.LanguageRange languageRange, @Nullable Double effectiveWeight, @NonNull LocaleMatchType matchType, @NonNull Locale fallbackLocale, @NonNull List<@NonNull Locale> consideredLocales)	Constructs a locale match result.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object object)
@NonNull List<@NonNull Locale>	getConsideredLocales()	Gets the ordered supported locales considered by negotiation.
@NonNull Optional<@NonNull Double>	getEffectiveWeight()	Gets the selected locale's effective preference weight after specific-range overrides.
@NonNull Locale	getFallbackLocale()	Gets the configured fallback that LocaleMatcher.bestMatchFor(List) would use for no match.
@NonNull Optional<@NonNull Locale.LanguageRange>	getLanguageRange()	Gets the preference range associated with the selection.
@NonNull Optional<@NonNull Locale>	getLocale()	Gets the selected supported locale.
@NonNull LocaleMatchType	getMatchType()	Gets the relationship used for the selection.
@NonNull List<@NonNull Locale.LanguageRange>	getRequestedLanguageRanges()	Gets the language ranges supplied for negotiation in caller order.
int	hashCode()
@NonNull Boolean	isMatch()	Reports whether negotiation selected an acceptable supported locale.
@NonNull String	toString()

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

LocaleMatchResult

public LocaleMatchResult(@NonNull List<@NonNull Locale.LanguageRange> requestedLanguageRanges,
 @Nullable Locale locale,
 @Nullable Locale.LanguageRange languageRange,
 @Nullable Double effectiveWeight,
 @NonNull LocaleMatchType matchType,
 @NonNull Locale fallbackLocale,
 @NonNull List<@NonNull Locale> consideredLocales)

Constructs a locale match result. This is public so custom LocaleMatcher implementations can expose the same diagnostics.

Parameters:

requestedLanguageRanges - ranges supplied for negotiation, not null

locale - selected supported locale, or null for no match

languageRange - range associated with the selection, or null for no match

effectiveWeight - selected locale's effective quality, or null for no match

matchType - match relationship, not null

fallbackLocale - configured fallback locale, not null

consideredLocales - supported locales considered, not null

Throws:

IllegalArgumentException - if more than LocaleMatcher.MAXIMUM_LANGUAGE_RANGES requested language ranges are supplied, any locale is malformed, considered locales have duplicate language tags, matched and unmatched state is mixed, the effective weight is outside (0, 1], or selected/fallback locales were not considered

Method Details

getRequestedLanguageRanges

public @NonNull List<@NonNull Locale.LanguageRange> getRequestedLanguageRanges()

Gets the language ranges supplied for negotiation in caller order.

Returns:

language ranges supplied for negotiation in caller order, not null

getLocale

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

Gets the selected supported locale.

Returns:

selected supported locale, or empty when no locale was acceptable, not null

getLanguageRange

public @NonNull Optional<@NonNull Locale.LanguageRange> getLanguageRange()

Gets the preference range associated with the selection.

Returns:

preference range associated with the selection, or empty for no match, not null

getEffectiveWeight

public @NonNull Optional<@NonNull Double> getEffectiveWeight()

Gets the selected locale's effective preference weight after specific-range overrides.

Returns:

selected locale's effective preference weight after specific-range overrides, or empty for no match, not null

getMatchType

public @NonNull LocaleMatchType getMatchType()

Gets the relationship used for the selection.

Returns:

relationship used for the selection, or LocaleMatchType.NONE, not null

getFallbackLocale

public @NonNull Locale getFallbackLocale()

Gets the configured fallback that LocaleMatcher.bestMatchFor(List) would use for no match.

Returns:

configured fallback that LocaleMatcher.bestMatchFor(List) would use for no match, not null

getConsideredLocales

public @NonNull List<@NonNull Locale> getConsideredLocales()

Gets the ordered supported locales considered by negotiation.

Returns:

ordered supported locales considered by negotiation, not null

isMatch

public @NonNull Boolean isMatch()

Reports whether negotiation selected an acceptable supported locale.

Returns:

whether negotiation selected an acceptable supported locale, not null

equals

public boolean equals(@Nullable Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public @NonNull String toString()

Overrides:

toString in class Object