Class DefaultStrings

java.lang.Object

com.lokalized.DefaultStrings

All Implemented Interfaces:

LocaleMatcher, Strings

@ThreadSafe
public class DefaultStrings
extends Object
implements Strings

Default implementation of a localized string provider.

It is recommended to use a single instance of this class across your entire application.

In multi-tenant systems like a web application where each user might have a different locale, your localeSupplier might return the locale specified by the current request, e.g. from a set of Locale.LanguageRange parsed from the Accept-Language header.

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultStrings.Builder	Builder used to construct instances of DefaultStrings.
static enum	DefaultStrings.FailureMode	Strategies for handling localized string lookup failures.

Method Summary

Modifier and Type	Method	Description
Locale	bestMatchFor(List<Locale.LanguageRange> languageRanges)	Given a list of language ranges (e.g. as parsed from an Accept-Language HTTP request header), determine the best-matching localized strings file's locale.
Locale	bestMatchFor(Locale locale)	Given a language range, determine the best-matching localized strings file's locale.
String	get(String key)	Gets a localized string for the given key.
String	get(String key, Map<String,Object> placeholders)	Gets a localized string for the given key.
DefaultStrings.FailureMode	getFailureMode()	Gets the strategy for handling string lookup failures.
Locale	getFallbackLocale()	Gets the fallback locale.
Function<LocaleMatcher, Locale>	getLocaleSupplier()	Gets the locale supplier.
Map<Locale, Set<LocalizedString>>	getLocalizedStringsByLocale()	Gets the set of localized strings for each locale.
Map<String, List<Locale>>	getTiebreakerLocalesByLanguageCode()	Gets the mapping of a mapping of an ISO 639 language code to its ordered "tiebreaker" fallback locales.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

get

@Nonnull
public String get(@Nonnull
 String key)

Description copied from interface: Strings

Gets a localized string for the given key.

If no localized string is available, the key is returned.

Specified by:

get in interface Strings

Parameters:

key - the localization key, not null

Returns:

a localized string for the key, not null

get

@Nonnull
public String get(@Nonnull
 String key,
 @Nullable
 Map<String,Object> placeholders)

Description copied from interface: Strings

Gets a localized string for the given key.

If no localized string is available, the key is returned.

Specified by:

get in interface Strings

Parameters:

key - the localization key, not null

placeholders - the placeholders to insert into the string, may be null

Returns:

a localized string for the key, not null

bestMatchFor

@Nonnull
public Locale bestMatchFor(@Nonnull
 Locale locale)

Description copied from interface: LocaleMatcher

Given a language range, determine the best-matching localized strings file's locale.

Specified by:

bestMatchFor in interface LocaleMatcher

Parameters:

locale - the locale for which to find the best match.

Returns:

the best-matching locale, not null

bestMatchFor

@Nonnull
public Locale bestMatchFor(@Nonnull
 List<Locale.LanguageRange> languageRanges)

Description copied from interface: LocaleMatcher

Given a list of language ranges (e.g. as parsed from an Accept-Language HTTP request header), determine the best-matching localized strings file's locale.

Specified by:

bestMatchFor in interface LocaleMatcher

Parameters:

languageRanges - the ordered list of language ranges for which to find the best match.

Returns:

the best-matching locale, not null

getLocalizedStringsByLocale

@Nonnull
public Map<Locale, Set<LocalizedString>> getLocalizedStringsByLocale()

Gets the set of localized strings for each locale.

Returns:

the set of localized strings for each locale, not null

getLocaleSupplier

@Nonnull
public Function<LocaleMatcher, Locale> getLocaleSupplier()

Gets the locale supplier.

Returns:

the locale supplier, not null

getTiebreakerLocalesByLanguageCode

@Nonnull
public Map<String, List<Locale>> getTiebreakerLocalesByLanguageCode()

Gets the mapping of a mapping of an ISO 639 language code to its ordered "tiebreaker" fallback locales.

Returns:

the per-language-code "tiebreaker" locales, not null

getFailureMode

@Nonnull
public DefaultStrings.FailureMode getFailureMode()

Gets the strategy for handling string lookup failures.

Returns:

the strategy for handling string lookup failures, not null

getFallbackLocale

@Nonnull
public Locale getFallbackLocale()

Gets the fallback locale.

Returns:

the fallback locale, not null