# NumberRangeFormatter

Added in[API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Summary:[Methods](https://developer.android.com/reference/android/icu/number/NumberRangeFormatter#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/icu/number/NumberRangeFormatter#inhmethods)  

# NumberRangeFormatter

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/icu/number/NumberRangeFormatter "View this page in Kotlin")\|Java

`
public


abstract
class
NumberRangeFormatter
`  
`

extends `[Object](https://developer.android.com/reference/java/lang/Object)`


``


`

|---|-----------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.icu.number.NumberRangeFormatter |

<br />

*** ** * ** ***

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](https://developer.android.com/reference/android/icu/number/NumberFormatter)

## Summary

|                                                                                                                                                                                                                                       ### Public methods                                                                                                                                                                                                                                        ||
|-----------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` static `[UnlocalizedNumberRangeFormatter](https://developer.android.com/reference/android/icu/number/UnlocalizedNumberRangeFormatter) | ` `[with](https://developer.android.com/reference/android/icu/number/NumberRangeFormatter#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](https://developer.android.com/reference/android/icu/number/LocalizedNumberRangeFormatter)     | ` `[withLocale](https://developer.android.com/reference/android/icu/number/NumberRangeFormatter#withLocale(java.util.Locale))`(`[Locale](https://developer.android.com/reference/java/util/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](https://developer.android.com/reference/android/icu/number/LocalizedNumberRangeFormatter)     | ` `[withLocale](https://developer.android.com/reference/android/icu/number/NumberRangeFormatter#withLocale(android.icu.util.ULocale))`(`[ULocale](https://developer.android.com/reference/android/icu/util/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](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object)          | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object.                                                                                                                                                      | | ` boolean`                                                                     | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one.                                           | | ` void`                                                                        | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.                                                          | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`<?>` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`.                                                                                                                                                | | ` int`                                                                         | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object.                                                                                                                                                 | | ` final void`                                                                  | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor.                                                                                                                            | | ` final void`                                                                  | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor.                                                                                                                         | | ` `[String](https://developer.android.com/reference/java/lang/String)          | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object.                                                                                                                                            | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(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](https://developer.android.com/reference/java/lang/Object#wait(long))`(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](https://developer.android.com/reference/java/lang/Object#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](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
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.

<br />

|                                                                                                                                             Returns                                                                                                                                             ||
|-------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [UnlocalizedNumberRangeFormatter](https://developer.android.com/reference/android/icu/number/UnlocalizedNumberRangeFormatter) | An[UnlocalizedNumberRangeFormatter](https://developer.android.com/reference/android/icu/number/UnlocalizedNumberRangeFormatter), to be used for chaining. <br /> |

### withLocale

Added in[API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
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.

<br />

|                                                Parameters                                                 ||
|----------|-------------------------------------------------------------------------------------------------|
| `locale` | `Locale`: The locale from which to load formats and symbols for number range formatting. <br /> |

|                                                                                                                                        Returns                                                                                                                                         ||
|---------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [LocalizedNumberRangeFormatter](https://developer.android.com/reference/android/icu/number/LocalizedNumberRangeFormatter) | A[LocalizedNumberRangeFormatter](https://developer.android.com/reference/android/icu/number/LocalizedNumberRangeFormatter), to be used for chaining. <br /> |

### withLocale

Added in[API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
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.

<br />

|                                                 Parameters                                                 ||
|----------|--------------------------------------------------------------------------------------------------|
| `locale` | `ULocale`: The locale from which to load formats and symbols for number range formatting. <br /> |

|                                                                                                                                        Returns                                                                                                                                         ||
|---------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [LocalizedNumberRangeFormatter](https://developer.android.com/reference/android/icu/number/LocalizedNumberRangeFormatter) | A[LocalizedNumberRangeFormatter](https://developer.android.com/reference/android/icu/number/LocalizedNumberRangeFormatter), to be used for chaining. <br /> |