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.

This class is intended for use by a single thread.

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
@NonNull DefaultStrings	build()	Constructs an instance of DefaultStrings.
@NonNull DefaultStrings.Builder	failureMode(@Nullable DefaultStrings.FailureMode failureMode)	Applies a failure mode to this builder.
@NonNull DefaultStrings.Builder	localeSupplier(@Nullable Function<LocaleMatcher, Locale> localeSupplier)	Applies a locale supplier to this builder.
@NonNull DefaultStrings.Builder	localizedStringSupplier(@Nullable Supplier<Map<@NonNull Locale, ? extends Iterable<@NonNull LocalizedString>>> localizedStringSupplier)	Applies a localized string supplier to this builder.
@NonNull DefaultStrings.Builder	phoneticResolver(@Nullable PhoneticResolver phoneticResolver)	Applies a phonetic resolver to this builder.
@NonNull DefaultStrings.Builder	tiebreakerLocalesByLanguageCode(@Nullable Map<@NonNull String, @Nullable List<@NonNull Locale>> tiebreakerLocalesByLanguageCode)	Applies a mapping of an ISO 639 language code to its ordered "tiebreaker" fallback locales to this builder.

Methods inherited from class Object

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

Method Details

localizedStringSupplier

public @NonNull DefaultStrings.Builder localizedStringSupplier(@Nullable Supplier<Map<@NonNull Locale, ? extends Iterable<@NonNull LocalizedString>>> localizedStringSupplier)

Applies a localized string supplier to this builder.

Parameters:

localizedStringSupplier - localized string supplier, may be null

Returns:

this builder instance, useful for chaining. not null

localeSupplier

public @NonNull DefaultStrings.Builder localeSupplier(@Nullable Function<LocaleMatcher, 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

tiebreakerLocalesByLanguageCode

public @NonNull DefaultStrings.Builder tiebreakerLocalesByLanguageCode(@Nullable Map<@NonNull String, @Nullable List<@NonNull Locale>> tiebreakerLocalesByLanguageCode)

Applies a mapping of an ISO 639 language code to its ordered "tiebreaker" fallback locales to this builder.

Parameters:

tiebreakerLocalesByLanguageCode - "tiebreaker" fallback locales, may be null

Returns:

this builder instance, useful for chaining. not null

failureMode

public @NonNull 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

phoneticResolver

public @NonNull DefaultStrings.Builder phoneticResolver(@Nullable PhoneticResolver phoneticResolver)

Applies a phonetic resolver to this builder.

Parameters:

phoneticResolver - phonetic resolver, may be null (defaults to fail-fast resolver)

Returns:

this builder instance, useful for chaining. not null

build

public @NonNull DefaultStrings build()

Constructs an instance of DefaultStrings.

Returns:

an instance of DefaultStrings, not null