NumberRangeFormatter

Kotlin |Java

public abstract class NumberRangeFormatter
extends Object

java.lang.Object
↳	android.icu.number.NumberRangeFormatter

The main entrypoint to the formatting of ranges of numbers, including currencies and other units of measurement.

Usage example:

 NumberRangeFormatter.with()
         .identityFallback(RangeIdentityFallback.APPROXIMATELY_OR_SINGLE_VALUE)
         .numberFormatterFirst(NumberFormatter.with().unit(MeasureUnit.METER))
         .numberFormatterSecond(NumberFormatter.with().unit(MeasureUnit.KILOMETER))
         .locale(ULocale.UK)
         .formatRange(750, 1.2)
         .toString();
 // => "750 m - 1.2 km"

Like NumberFormatter, NumberRangeFormatter instances (i.e., LocalizedNumberRangeFormatter and UnlocalizedNumberRangeFormatter) are immutable and thread-safe. This API is based on the fluent design pattern popularized by libraries such as Google's Guava.

See also:

NumberFormatter

Summary

Public methods
`static UnlocalizedNumberRangeFormatter`	`with()` Call this method at the beginning of a NumberRangeFormatter fluent chain in which the locale is not currently known at the call site.
`static LocalizedNumberRangeFormatter`	`withLocale(Locale locale)` Call this method at the beginning of a NumberRangeFormatter fluent chain in which the locale is known at the call site.
`static LocalizedNumberRangeFormatter`	`withLocale(ULocale locale)` Call this method at the beginning of a NumberRangeFormatter fluent chain in which the locale is known at the call site.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

with

Added in API level 30

public static UnlocalizedNumberRangeFormatter with ()

Call this method at the beginning of a NumberRangeFormatter fluent chain in which the locale is not currently known at the call site.

Returns
`UnlocalizedNumberRangeFormatter`	An `UnlocalizedNumberRangeFormatter`, to be used for chaining.

withLocale

Added in API level 30

public static LocalizedNumberRangeFormatter withLocale (Locale locale)

Call this method at the beginning of a NumberRangeFormatter fluent chain in which the locale is known at the call site.

Parameters
`locale`	`Locale`: The locale from which to load formats and symbols for number range formatting.

Returns
`LocalizedNumberRangeFormatter`	A `LocalizedNumberRangeFormatter`, to be used for chaining.

withLocale

Added in API level 30

public static LocalizedNumberRangeFormatter withLocale (ULocale locale)

Call this method at the beginning of a NumberRangeFormatter fluent chain in which the locale is known at the call site.

Parameters
`locale`	`ULocale`: The locale from which to load formats and symbols for number range formatting.

Returns
`LocalizedNumberRangeFormatter`	A `LocalizedNumberRangeFormatter`, to be used for chaining.