Class LocalizedString.Builder

java.lang.Object

com.lokalized.LocalizedString.Builder

Enclosing class:

LocalizedString

@NotThreadSafe
public static class LocalizedString.Builder
extends Object

Builder used to construct instances of LocalizedString.

This class is intended for use by a single thread.

Author:

Mark Allen

Constructor Summary

Constructors

Constructor	Description
Builder(@NonNull String key)	Constructs a localized string builder with the given key.

Method Summary

Modifier and Type	Method	Description
@NonNull LocalizedString.Builder	alternatives(@Nullable List<@NonNull LocalizedString> alternatives)	Applies alternative expression-driven translations to this builder.
@NonNull LocalizedString	build()	Constructs an instance of LocalizedString.
@NonNull LocalizedString.Builder	commentary(@Nullable String commentary)	Applies commentary (usage/translation notes) to this builder.
@NonNull LocalizedString.Builder	placeholderDefinitions(@Nullable Map<@NonNull String, ? extends @NonNull LocalizedString.PlaceholderDefinition> placeholderDefinitions)	Applies generated-placeholder definitions to this builder.
@NonNull LocalizedString.Builder	translation(@Nullable String translation)	Applies a default translation to this builder.

Methods inherited from class Object

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

Constructor Details

Builder

public Builder(@NonNull String key)

Constructs a localized string builder with the given key.

Parameters:

key - this string's translation key, not null

Method Details

translation

public @NonNull LocalizedString.Builder translation(@Nullable String translation)

Applies a default translation to this builder.

Parameters:

translation - a default translation, may be null

Returns:

this builder instance, useful for chaining. not null

commentary

public @NonNull LocalizedString.Builder commentary(@Nullable String commentary)

Applies commentary (usage/translation notes) to this builder.

Parameters:

commentary - commentary (usage/translation notes), may be null

Returns:

this builder instance, useful for chaining. not null

placeholderDefinitions

public @NonNull LocalizedString.Builder placeholderDefinitions(@Nullable Map<@NonNull String, ? extends @NonNull LocalizedString.PlaceholderDefinition> placeholderDefinitions)

Applies generated-placeholder definitions to this builder.

Parameters:

placeholderDefinitions - generated-placeholder definitions keyed by placeholder name, may be null

Returns:

this builder instance, useful for chaining. not null

Since:

3.0.0

alternatives

public @NonNull LocalizedString.Builder alternatives(@Nullable List<@NonNull LocalizedString> alternatives)

Applies alternative expression-driven translations to this builder.

Parameters:

alternatives - alternative expression-driven translations, may be null

Returns:

this builder instance, useful for chaining. not null

build

public @NonNull LocalizedString build()

Constructs an instance of LocalizedString.

Returns:

an instance of LocalizedString, not null

Throws:

NullPointerException - if a configured collection contains a null key, value, or element