Class PluralOperands.Builder

java.lang.Object

com.lokalized.PluralOperands.Builder

Enclosing class:

PluralOperands

@NotThreadSafe
public static final class PluralOperands.Builder
extends Object

Builder for PluralOperands.

Since:

3.0.0

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
@NonNull PluralOperands	build()	Builds immutable plural operands.
@NonNull PluralOperands.Builder	compactExponent(@Nullable Integer compactExponent)	Specifies the compact-decimal exponent used by the CLDR c and e operands.
@NonNull PluralOperands.Builder	runtimeLimits(@Nullable TranslationRuntimeLimits runtimeLimits)	Applies safety limits to operand construction.
@NonNull PluralOperands.Builder	visibleDecimalPlaces(@Nullable Integer visibleDecimalPlaces)	Specifies the number of decimal places that will be visible to the user.

Methods inherited from class Object

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

Method Details

visibleDecimalPlaces

public @NonNull PluralOperands.Builder visibleDecimalPlaces(@Nullable Integer visibleDecimalPlaces)

Specifies the number of decimal places that will be visible to the user.

If omitted, BigDecimal scale is preserved and other Number types use their normalized decimal places. Reducing the scale does not round implicitly: callers must supply an already-rounded number, otherwise build() throws ArithmeticException. The active TranslationRuntimeLimits determine the accepted maximum; the library default is TranslationRuntimeLimits.DEFAULT_MAXIMUM_VISIBLE_DECIMAL_PLACES and the hard ceiling is PluralOperands.MAXIMUM_VISIBLE_DECIMAL_PLACES.

Parameters:

visibleDecimalPlaces - the visible decimal places, from zero through the active runtime limit, or null to use the number's natural scale

Returns:

this builder, not null

compactExponent

public @NonNull PluralOperands.Builder compactExponent(@Nullable Integer compactExponent)

Specifies the compact-decimal exponent used by the CLDR c and e operands.

The number supplied to this builder is the displayed mantissa, not the expanded value. For example, a compact display such as 1M is represented by the number 1 and a compact exponent of 6, not by the number 1000000 and an exponent of 6. The active TranslationRuntimeLimits determine the accepted maximum; the library default is TranslationRuntimeLimits.DEFAULT_MAXIMUM_COMPACT_EXPONENT and the hard ceiling is PluralOperands.MAXIMUM_COMPACT_EXPONENT.

Parameters:

compactExponent - the compact-decimal exponent, from zero through the active runtime limit, or null to use zero

Returns:

this builder, not null

runtimeLimits

public @NonNull PluralOperands.Builder runtimeLimits(@Nullable TranslationRuntimeLimits runtimeLimits)

Applies safety limits to operand construction.

Parameters:

runtimeLimits - runtime limits, or null to use the library defaults

Returns:

this builder, not null

Since:

3.0.0

build

public @NonNull PluralOperands build()

Builds immutable plural operands.

Returns:

immutable plural operands, not null

Throws:

ArithmeticException - if the requested visible decimal places would require rounding

IllegalArgumentException - if the number implementation is unsupported, the number is non-finite, or the number, visible decimal places, or compact exponent exceeds a supported safety limit