# Print output for @column tags ?> NumberRangeFormatterSettings - Android SDK | Android Developers

Most visited

Recently visited

NumberRangeFormatterSettings

public abstract class NumberRangeFormatterSettings
extends Object

java.lang.Object
   ↳ android.icu.number.NumberRangeFormatterSettings<T extends android.icu.number.NumberRangeFormatterSettings<?>>


An abstract base class for specifying settings related to number formatting. This class is implemented by UnlocalizedNumberRangeFormatter and LocalizedNumberRangeFormatter. This class is not intended for public subclassing.

See also:

Summary

Public methods

T collapse(NumberRangeFormatter.RangeCollapse collapse)

Sets the aggressiveness of "collapsing" fields across the range separator.

boolean equals(Object other)

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

int hashCode()

Returns a hash code value for the object.

T identityFallback(NumberRangeFormatter.RangeIdentityFallback identityFallback)

Sets the behavior when the two sides of the range are the same.

T numberFormatterBoth(UnlocalizedNumberFormatter formatter)

Sets the NumberFormatter instance to use for the numbers in the range.

T numberFormatterFirst(UnlocalizedNumberFormatter formatterFirst)

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

T numberFormatterSecond(UnlocalizedNumberFormatter formatterSecond)

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

Inherited methods

Public methods

collapse

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.

See also:

equals

public boolean equals (Object other)

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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

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.

hashCode

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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(Object) 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(java.lang.Object) 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.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
int a hash code value for this object.

identityFallback

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.

See also:

numberFormatterBoth

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.

See also:

numberFormatterFirst

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.

See also:

numberFormatterSecond

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.

See also: