International Components for Unicode for Java (icu4j) 74.2 · com.ibm.icu.number.NumberRangeFormatterSettings

Modifier and Type	Field and Description
private final int	key
pack-priv static final int	KEY_COLLAPSE
pack-priv static final int	KEY_FORMATTER_1
pack-priv static final int	KEY_FORMATTER_2
pack-priv static final int	KEY_IDENTITY_FALLBACK
pack-priv static final int	KEY_LOCALE
pack-priv static final int	KEY_MACROS
pack-priv static final int	KEY_MAX
pack-priv static final int	KEY_SAME_FORMATTERS
private final NumberRangeFormatterSettings<?>	parent
private volatile RangeMacroProps	resolvedMacros
private final Object	value

Access	Constructor and Description
pack-priv	NumberRangeFormatterSettings(NumberRangeFormatterSettings<?> parent, int key, Object value)

Method Summary

Modifier and Type	Method and Description
public T	Returns: The fluent chain. collapse(NumberRangeFormatter.RangeCollapse The collapsing strategy to use for this range. collapse) Sets the aggressiveness of "collapsing" fields across the range separator.
pack-priv abstract T	create(int key, Object value)
public boolean	equals(Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public T	Returns: The fluent chain. identityFallback(NumberRangeFormatter.RangeIdentityFallback The strategy to use when formatting two numbers that end up being the same. identityFallback) Sets the behavior when the two sides of the range are the same.
public T	Returns: The fluent chain. numberFormatterBoth(UnlocalizedNumberFormatter The formatter to use for both numbers in the range. formatter) Sets the NumberFormatter instance to use for the numbers in the range.
public T	Returns: The fluent chain. numberFormatterFirst(UnlocalizedNumberFormatter The formatter to use for the first number in the range. formatterFirst) Sets the NumberFormatter instance to use for the first number in the range.
public T	Returns: The fluent chain. numberFormatterSecond(UnlocalizedNumberFormatter The formatter to use for the second number in the range. formatterSecond) Sets the NumberFormatter instances to use for the second number in the range.
pack-priv RangeMacroProps	resolve()

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

key	back to summary
private final int key

KEY_COLLAPSE	back to summary
pack-priv static final int KEY_COLLAPSE

KEY_FORMATTER_1	back to summary
pack-priv static final int KEY_FORMATTER_1

KEY_FORMATTER_2	back to summary
pack-priv static final int KEY_FORMATTER_2

KEY_IDENTITY_FALLBACK	back to summary
pack-priv static final int KEY_IDENTITY_FALLBACK

KEY_LOCALE	back to summary
pack-priv static final int KEY_LOCALE

KEY_MACROS	back to summary
pack-priv static final int KEY_MACROS

KEY_MAX	back to summary
pack-priv static final int KEY_MAX

KEY_SAME_FORMATTERS	back to summary
pack-priv static final int KEY_SAME_FORMATTERS

parent	back to summary
private final NumberRangeFormatterSettings<?> parent

resolvedMacros	back to summary
private volatile RangeMacroProps resolvedMacros

value	back to summary
private final Object value

NumberRangeFormatterSettings	back to summary
pack-priv NumberRangeFormatterSettings(NumberRangeFormatterSettings<?> parent, int key, Object value)

Method Detail

collapse back to summary

collapse	back to summary
public T collapse(NumberRangeFormatter.RangeCollapse collapse) Sets the aggressiveness of "collapsing" fields across the range separator. Possible values: ALL: "3-5K miles" UNIT: "3K - 5K miles" NONE: "3K miles - 5K miles" AUTO: usually UNIT or NONE, depending on the locale and formatter settings The default value is AUTO. Parameters collapse:NumberRangeFormatter.RangeCollapse The collapsing strategy to use for this range. Returns:T The fluent chain. ICU Status Stable since ICU 63. See Also `NumberRangeFormatter`

public T collapse(NumberRangeFormatter.RangeCollapse collapse)

Sets the aggressiveness of "collapsing" fields across the range separator. Possible values:

ALL: "3-5K miles"
UNIT: "3K - 5K miles"
NONE: "3K miles - 5K miles"
AUTO: usually UNIT or NONE, depending on the locale and formatter settings

The default value is AUTO.

Parameters

collapse:NumberRangeFormatter.RangeCollapse: The collapsing strategy to use for this range.

Returns:T

The fluent chain.

ICU Status

Stable since ICU 63.

See Also

NumberRangeFormatter

create	back to summary
pack-priv abstract T create(int key, Object value)

equals back to summary

equals	back to summary
public boolean equals(Object other) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters other:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override ICU Status Stable since ICU 63.

public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

other:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

ICU Status

Stable since ICU 63.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override ICU Status Stable since ICU 63.

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

ICU Status

Stable since ICU 63.

identityFallback back to summary

identityFallback	back to summary
public T identityFallback(NumberRangeFormatter.RangeIdentityFallback identityFallback) Sets the behavior when the two sides of the range are the same. This could happen if the same two numbers are passed to the formatRange function, or if different numbers are passed to the function but they become the same after rounding rules are applied. Possible values: SINGLE_VALUE: "5 miles" APPROXIMATELY_OR_SINGLE_VALUE: "~5 miles" or "5 miles", depending on whether the number was the same before rounding was applied APPROXIMATELY: "~5 miles" RANGE: "5-5 miles" (with collapse=UNIT) The default value is APPROXIMATELY. Parameters identityFallback:NumberRangeFormatter.RangeIdentityFallback The strategy to use when formatting two numbers that end up being the same. Returns:T The fluent chain. ICU Status Stable since ICU 63. See Also `NumberRangeFormatter`

public T identityFallback(NumberRangeFormatter.RangeIdentityFallback identityFallback)

Sets the behavior when the two sides of the range are the same. This could happen if the same two numbers are passed to the formatRange function, or if different numbers are passed to the function but they become the same after rounding rules are applied. Possible values:

SINGLE_VALUE: "5 miles"
APPROXIMATELY_OR_SINGLE_VALUE: "~5 miles" or "5 miles", depending on whether the number was the same before rounding was applied
APPROXIMATELY: "~5 miles"
RANGE: "5-5 miles" (with collapse=UNIT)

The default value is APPROXIMATELY.

Parameters

identityFallback:NumberRangeFormatter.RangeIdentityFallback: The strategy to use when formatting two numbers that end up being the same.

Returns:T

The fluent chain.

ICU Status

Stable since ICU 63.

See Also

NumberRangeFormatter

numberFormatterBoth back to summary

numberFormatterBoth	back to summary
public T numberFormatterBoth(UnlocalizedNumberFormatter formatter) Sets the NumberFormatter instance to use for the numbers in the range. The same formatter is applied to both sides of the range. The NumberFormatter instances must not have a locale applied yet; the locale specified on the NumberRangeFormatter will be used. Parameters formatter:UnlocalizedNumberFormatter The formatter to use for both numbers in the range. Returns:T The fluent chain. Annotations @SuppressWarnings:unchecked ICU Status Stable since ICU 63. See Also `NumberFormatter`, `NumberRangeFormatter`

public T numberFormatterBoth(UnlocalizedNumberFormatter formatter)

Sets the NumberFormatter instance to use for the numbers in the range. The same formatter is applied to both sides of the range.

The NumberFormatter instances must not have a locale applied yet; the locale specified on the NumberRangeFormatter will be used.

Parameters

formatter:UnlocalizedNumberFormatter: The formatter to use for both numbers in the range.

Returns:T

The fluent chain.

Annotations

@SuppressWarnings:unchecked

ICU Status

Stable since ICU 63.

numberFormatterFirst back to summary

numberFormatterFirst	back to summary
public T numberFormatterFirst(UnlocalizedNumberFormatter formatterFirst) Sets the NumberFormatter instance to use for the first number in the range. The NumberFormatter instance must not have a locale applied yet; the locale specified on the NumberRangeFormatter will be used. Parameters formatterFirst:UnlocalizedNumberFormatter The formatter to use for the first number in the range. Returns:T The fluent chain. Annotations @SuppressWarnings:unchecked ICU Status Stable since ICU 63. See Also `NumberFormatter`, `NumberRangeFormatter`

public T numberFormatterFirst(UnlocalizedNumberFormatter formatterFirst)

Sets the NumberFormatter instance to use for the first number in the range.

The NumberFormatter instance must not have a locale applied yet; the locale specified on the NumberRangeFormatter will be used.

Parameters

formatterFirst:UnlocalizedNumberFormatter: The formatter to use for the first number in the range.

Returns:T

The fluent chain.

Annotations

@SuppressWarnings:unchecked

ICU Status

Stable since ICU 63.

numberFormatterSecond back to summary

numberFormatterSecond	back to summary
public T numberFormatterSecond(UnlocalizedNumberFormatter formatterSecond) Sets the NumberFormatter instances to use for the second number in the range. The NumberFormatter instance must not have a locale applied yet; the locale specified on the NumberRangeFormatter will be used. Parameters formatterSecond:UnlocalizedNumberFormatter The formatter to use for the second number in the range. Returns:T The fluent chain. Annotations @SuppressWarnings:unchecked ICU Status Stable since ICU 63. See Also `NumberFormatter`, `NumberRangeFormatter`

public T numberFormatterSecond(UnlocalizedNumberFormatter formatterSecond)

Sets the NumberFormatter instances to use for the second number in the range.

The NumberFormatter instance must not have a locale applied yet; the locale specified on the NumberRangeFormatter will be used.

Parameters

formatterSecond:UnlocalizedNumberFormatter: The formatter to use for the second number in the range.

Returns:T

The fluent chain.

Annotations

@SuppressWarnings:unchecked

ICU Status

Stable since ICU 63.

resolve	back to summary
pack-priv RangeMacroProps resolve()

public abstract Class NumberRangeFormatterSettings<T extends com.ibm.icu.number.NumberRangeFormatterSettings<?>>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail