open class LocalizedNumberRangeFormatter : NumberRangeFormatterSettings<LocalizedNumberRangeFormatter!>
A NumberRangeFormatter that has a locale associated with it; this means .formatRange() methods are available. Instances of this class are immutable and thread-safe.
Summary
| Public methods |
| open FormattedNumberRange! |
Format the given doubles to a string using the settings specified in the NumberRangeFormatter fluent setting chain.
|
| open FormattedNumberRange! |
Format the given integers to a string using the settings specified in the NumberRangeFormatter fluent setting chain.
|
| open FormattedNumberRange! |
Format the given Numbers to a string using the settings specified in the NumberRangeFormatter fluent setting chain.
|
| open UnlocalizedNumberRangeFormatter! |
Disassociate the locale from this formatter.
|
| Inherited functions |
From class NumberRangeFormatterSettings
T |
collapse(collapse: NumberRangeFormatter.RangeCollapse!)
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.
|
Boolean |
equals(other: Any?)
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.
|
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 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.
|
T |
identityFallback(identityFallback: NumberRangeFormatter.RangeIdentityFallback!)
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.
|
T |
numberFormatterBoth(formatter: UnlocalizedNumberFormatter!)
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.
|
T |
numberFormatterFirst(formatterFirst: UnlocalizedNumberFormatter!)
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.
|
T |
numberFormatterSecond(formatterSecond: UnlocalizedNumberFormatter!)
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.
|
|
Public methods
open fun formatRange(
first: Double,
second: Double
): FormattedNumberRange!
Format the given doubles to a string using the settings specified in the NumberRangeFormatter fluent setting chain.
| Parameters |
first |
Double: The first number in the range, usually to the left in LTR locales. |
second |
Double: The second number in the range, usually to the right in LTR locales. |
open fun formatRange(
first: Int,
second: Int
): FormattedNumberRange!
Format the given integers to a string using the settings specified in the NumberRangeFormatter fluent setting chain.
| Parameters |
first |
Int: The first number in the range, usually to the left in LTR locales. |
second |
Int: The second number in the range, usually to the right in LTR locales. |
open fun formatRange(
first: Number!,
second: Number!
): FormattedNumberRange!
Format the given Numbers to a string using the settings specified in the NumberRangeFormatter fluent setting chain.
| Parameters |
first |
Number!: The first number in the range, usually to the left in LTR locales. |
second |
Number!: The second number in the range, usually to the right in LTR locales. |
| Exceptions |
java.lang.IllegalArgumentException |
if first or second is null |
