Package com.lokalized

Class DefaultStrings.Builder

java.lang.Object

com.lokalized.DefaultStrings.Builder

Enclosing class:

DefaultStrings

@NotThreadSafe
public static class DefaultStrings.Builder
extends Object

Builder used to construct instances of DefaultStrings.

You cannot provide both a localeSupplier and a languageRangesSupplier - you must choose one or neither.

This class is intended for use by a single thread.

Author:

Mark Allen

Constructor Summary

Constructors

Constructor	Description
Builder(String fallbackLanguageCode, Supplier<Map<Locale,? extends Iterable<LocalizedString>>> localizedStringSupplier)	Constructs a strings builder with a default language code and localized string supplier.

Method Summary

Modifier and Type	Method	Description
DefaultStrings	build()	Constructs an instance of DefaultStrings.
DefaultStrings.Builder	failureMode(DefaultStrings.FailureMode failureMode)	Applies a failure mode to this builder.
DefaultStrings.Builder	languageRangesSupplier(Supplier<List<Locale.LanguageRange>> languageRangesSupplier)	Applies a supplier of language ranges to this builder.
DefaultStrings.Builder	localeSupplier(Supplier<Locale> localeSupplier)	Applies a locale supplier to this builder.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(@Nonnull
 String fallbackLanguageCode,
 @Nonnull
 Supplier<Map<Locale,? extends Iterable<LocalizedString>>> localizedStringSupplier)

Constructs a strings builder with a default language code and localized string supplier.

The fallback language code must be an ISO 639 alpha-2 or alpha-3 language code. When a language has both an alpha-2 code and an alpha-3 code, the alpha-2 code must be used.

Parameters:

fallbackLanguageCode - fallback language code, not null

localizedStringSupplier - supplier of localized strings, not null

Method Details

localeSupplier

@Nonnull
public DefaultStrings.Builder localeSupplier(@Nullable
 Supplier<Locale> localeSupplier)

Applies a locale supplier to this builder.

Parameters:

localeSupplier - locale supplier, may be null

Returns:

this builder instance, useful for chaining. not null

languageRangesSupplier

@Nonnull
public DefaultStrings.Builder languageRangesSupplier(@Nullable
 Supplier<List<Locale.LanguageRange>> languageRangesSupplier)

Applies a supplier of language ranges to this builder.

Parameters:

languageRangesSupplier - language ranges supplier, may be null

Returns:

this builder instance, useful for chaining. not null

failureMode

@Nonnull
public DefaultStrings.Builder failureMode(@Nullable
 DefaultStrings.FailureMode failureMode)

Applies a failure mode to this builder.

Parameters:

failureMode - strategy for dealing with lookup failures, may be null

Returns:

this builder instance, useful for chaining. not null

build

@Nonnull
public DefaultStrings build()

Constructs an instance of DefaultStrings.

Returns:

an instance of DefaultStrings, not null