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/NumberFormatterSettings#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/icu/number/NumberFormatterSettings#inhmethods)

# NumberFormatterSettings

*** ** * ** ***

` public abstract class NumberFormatterSettings `   
` extends https://developer.android.com/reference/java/lang/Object ` ` `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.icu.number.NumberFormatterSettings\<T extends [android.icu.number.NumberFormatterSettings](https://developer.android.com/reference/android/icu/number/NumberFormatterSettings)\<?\>\> |

Known direct subclasses [LocalizedNumberFormatter](https://developer.android.com/reference/android/icu/number/LocalizedNumberFormatter), [UnlocalizedNumberFormatter](https://developer.android.com/reference/android/icu/number/UnlocalizedNumberFormatter) [LocalizedNumberFormatter](https://developer.android.com/reference/android/icu/number/LocalizedNumberFormatter) A NumberFormatter that has a locale associated with it; this means .format() methods are available. [UnlocalizedNumberFormatter](https://developer.android.com/reference/android/icu/number/UnlocalizedNumberFormatter) A NumberFormatter that does not yet have a locale.   

*** ** * ** ***

An abstract base class for specifying settings related to number formatting. This class is implemented by `https://developer.android.com/reference/android/icu/number/UnlocalizedNumberFormatter` and `https://developer.android.com/reference/android/icu/number/LocalizedNumberFormatter`. This class is not intended for public subclassing.
**See also:**

- `https://developer.android.com/reference/android/icu/number/NumberFormatter`

## Summary

| ### Public methods ||
|---|---|
| ` T` | ` https://developer.android.com/reference/android/icu/number/NumberFormatterSettings#decimal(android.icu.number.NumberFormatter.DecimalSeparatorDisplay)(https://developer.android.com/reference/android/icu/number/NumberFormatter.DecimalSeparatorDisplay style) ` Sets the decimal separator display strategy. |
| ` T` | ` https://developer.android.com/reference/android/icu/number/NumberFormatterSettings#displayOptions(android.icu.text.DisplayOptions)(https://developer.android.com/reference/android/icu/text/DisplayOptions displayOptions) ` Specifies the `DisplayOptions`. |
| ` boolean` | ` https://developer.android.com/reference/android/icu/number/NumberFormatterSettings#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object other) ` Indicates whether some other object is "equal to" this one. |
| ` T` | ` https://developer.android.com/reference/android/icu/number/NumberFormatterSettings#grouping(android.icu.number.NumberFormatter.GroupingStrategy)(https://developer.android.com/reference/android/icu/number/NumberFormatter.GroupingStrategy strategy) ` Specifies the grouping strategy to use when formatting numbers. |
| ` int` | ` https://developer.android.com/reference/android/icu/number/NumberFormatterSettings#hashCode()() ` Returns a hash code value for the object. |
| ` T` | ` https://developer.android.com/reference/android/icu/number/NumberFormatterSettings#integerWidth(android.icu.number.IntegerWidth)(https://developer.android.com/reference/android/icu/number/IntegerWidth style) ` Specifies the minimum and maximum number of digits to render before the decimal mark. |
| ` T` | ` https://developer.android.com/reference/android/icu/number/NumberFormatterSettings#notation(android.icu.number.Notation)(https://developer.android.com/reference/android/icu/number/Notation notation) ` Specifies the notation style (simple, scientific, or compact) for rendering numbers. |
| ` T` | ` https://developer.android.com/reference/android/icu/number/NumberFormatterSettings#perUnit(android.icu.util.MeasureUnit)(https://developer.android.com/reference/android/icu/util/MeasureUnit perUnit) ` Sets a unit to be used in the denominator. |
| ` T` | ` https://developer.android.com/reference/android/icu/number/NumberFormatterSettings#precision(android.icu.number.Precision)(https://developer.android.com/reference/android/icu/number/Precision precision) ` Specifies the rounding precision to use when formatting numbers. |
| ` T` | ` https://developer.android.com/reference/android/icu/number/NumberFormatterSettings#roundingMode(java.math.RoundingMode)(https://developer.android.com/reference/java/math/RoundingMode roundingMode) ` Specifies how to determine the direction to round a number when it has more digits than fit in the desired precision. |
| ` T` | ` https://developer.android.com/reference/android/icu/number/NumberFormatterSettings#scale(android.icu.number.Scale)(https://developer.android.com/reference/android/icu/number/Scale scale) ` Sets a scale (multiplier) to be used to scale the number by an arbitrary amount before formatting. |
| ` T` | ` https://developer.android.com/reference/android/icu/number/NumberFormatterSettings#sign(android.icu.number.NumberFormatter.SignDisplay)(https://developer.android.com/reference/android/icu/number/NumberFormatter.SignDisplay style) ` Sets the plus/minus sign display strategy. |
| ` T` | ` https://developer.android.com/reference/android/icu/number/NumberFormatterSettings#symbols(android.icu.text.NumberingSystem)(https://developer.android.com/reference/android/icu/text/NumberingSystem ns) ` Specifies that the given numbering system should be used when fetching symbols. |
| ` T` | ` https://developer.android.com/reference/android/icu/number/NumberFormatterSettings#symbols(android.icu.text.DecimalFormatSymbols)(https://developer.android.com/reference/android/icu/text/DecimalFormatSymbols symbols) ` Specifies the symbols (decimal separator, grouping separator, percent sign, numerals, etc.) to use when rendering numbers. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/icu/number/NumberFormatterSettings#toSkeleton()() ` Creates a skeleton string representation of this number formatter. |
| ` T` | ` https://developer.android.com/reference/android/icu/number/NumberFormatterSettings#unit(android.icu.util.MeasureUnit)(https://developer.android.com/reference/android/icu/util/MeasureUnit unit) ` Specifies the unit (unit of measure, currency, or percent) to associate with rendered numbers. |
| ` T` | ` https://developer.android.com/reference/android/icu/number/NumberFormatterSettings#unitWidth(android.icu.number.NumberFormatter.UnitWidth)(https://developer.android.com/reference/android/icu/number/NumberFormatter.UnitWidth style) ` Sets the width of the unit (measure unit or currency). |
| ` T` | ` https://developer.android.com/reference/android/icu/number/NumberFormatterSettings#usage(java.lang.String)(https://developer.android.com/reference/java/lang/String usage) ` Specifies the usage for which numbers will be formatted ("person-height", "road", "rainfall", etc.) When a `usage` is specified, the output unit will change depending on the `Locale` and the unit quantity. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` 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 https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` 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` ` 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` ` 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

### decimal

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

```
public T decimal (NumberFormatter.DecimalSeparatorDisplay style)
```

Sets the decimal separator display strategy. This affects integer numbers with no fraction part. Most common values:

- Auto: "1"
- Always: "1."

Pass an element from the `https://developer.android.com/reference/android/icu/number/NumberFormatter.DecimalSeparatorDisplay` enum to this setter. For example:

```
NumberFormatter.with().decimal(DecimalSeparatorDisplay.ALWAYS)
```

The default is AUTO decimal separator display.

<br />

| Parameters ||
|---|---|
| `style` | `NumberFormatter.DecimalSeparatorDisplay`: The decimal separator display strategy to use when rendering numbers. <br /> |

| Returns ||
|---|---|
| `T` | The fluent chain <br /> |

**See also:**

- `https://developer.android.com/reference/android/icu/number/NumberFormatter.DecimalSeparatorDisplay`

### displayOptions

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

```
public T displayOptions (DisplayOptions displayOptions)
```

Specifies the `DisplayOptions`. For example, `GrammaticalCase` specifies the desired case for a unit formatter's output (e.g. accusative, dative, genitive).

<br />

| Parameters ||
|---|---|
| `displayOptions` | `DisplayOptions` <br /> |

| Returns ||
|---|---|
| `T` | The fluent chain. <br /> |

### equals

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

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

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.

<br />

| Parameters ||
|---|---|
| `other` | `Object`: the reference object with which to compare. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### grouping

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

```
public T grouping (NumberFormatter.GroupingStrategy strategy)
```

Specifies the grouping strategy to use when formatting numbers.

- Default grouping: "12,300" and "1,230"
- Grouping with at least 2 digits: "12,300" and "1230"
- No grouping: "12300" and "1230"

The exact grouping widths will be chosen based on the locale.

Pass this method an element from the `https://developer.android.com/reference/android/icu/number/NumberFormatter.GroupingStrategy` enum. For example:

```
NumberFormatter.with().grouping(GroupingStrategy.MIN2)
```
The default is to perform grouping according to locale data; most locales, but not all locales, enable it by default.

<br />

<br />

| Parameters ||
|---|---|
| `strategy` | `NumberFormatter.GroupingStrategy`: The grouping strategy to use. <br /> |

| Returns ||
|---|---|
| `T` | The fluent chain. <br /> |

**See also:**

- `https://developer.android.com/reference/android/icu/number/NumberFormatter.GroupingStrategy`

### hashCode

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

```
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 `https://developer.android.com/reference/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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.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 `https://developer.android.com/reference/java/lang/Object#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.

<br />

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |

### integerWidth

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

```
public T integerWidth (IntegerWidth style)
```

Specifies the minimum and maximum number of digits to render before the decimal mark.

- Zero minimum integer digits: ".08"
- One minimum integer digit: "0.08"
- Two minimum integer digits: "00.08"

Pass this method the return value of `https://developer.android.com/reference/android/icu/number/IntegerWidth#zeroFillTo(int)`. For example:

```
NumberFormatter.with().integerWidth(IntegerWidth.zeroFillTo(2))
```
The default is to have one minimum integer digit.

<br />

<br />

| Parameters ||
|---|---|
| `style` | `IntegerWidth`: The integer width to use. <br /> |

| Returns ||
|---|---|
| `T` | The fluent chain. <br /> |

**See also:**

- `https://developer.android.com/reference/android/icu/number/IntegerWidth`

### notation

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

```
public T notation (Notation notation)
```

Specifies the notation style (simple, scientific, or compact) for rendering numbers.

- Simple notation: "12,300"
- Scientific notation: "1.23E4"
- Compact notation: "12K"

All notation styles will be properly localized with locale data, and all notation styles are compatible with units, rounding strategies, and other number formatter settings.

Pass this method the return value of a `https://developer.android.com/reference/android/icu/number/Notation` factory method. For example:

```
NumberFormatter.with().notation(Notation.compactShort())
```
The default is to use simple notation.

<br />

<br />

| Parameters ||
|---|---|
| `notation` | `Notation`: The notation strategy to use. <br /> |

| Returns ||
|---|---|
| `T` | The fluent chain. <br /> |

**See also:**

- `https://developer.android.com/reference/android/icu/number/Notation`

### perUnit

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

```
public T perUnit (MeasureUnit perUnit)
```

Sets a unit to be used in the denominator. For example, to format "3 m/s", pass METER to the unit and SECOND to the perUnit.

Pass this method any instance of `https://developer.android.com/reference/android/icu/util/MeasureUnit`. For example:

```
NumberFormatter.with().unit(MeasureUnit.METER).perUnit(MeasureUnit.SECOND)
```

The default is not to display any unit in the denominator.

If a per-unit is specified without a primary unit via `https://developer.android.com/reference/android/icu/number/NumberFormatterSettings#unit(android.icu.util.MeasureUnit)`, the behavior is undefined.

<br />

| Parameters ||
|---|---|
| `perUnit` | `MeasureUnit`: The unit to render in the denominator. <br /> |

| Returns ||
|---|---|
| `T` | The fluent chain <br /> |

**See also:**

- `https://developer.android.com/reference/android/icu/number/NumberFormatterSettings#unit(android.icu.util.MeasureUnit)`

### precision

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

```
public T precision (Precision precision)
```

Specifies the rounding precision to use when formatting numbers.

- Round to 3 decimal places: "3.142"
- Round to 3 significant figures: "3.14"
- Round to the closest nickel: "3.15"
- Do not perform rounding: "3.1415926..."

Pass this method the return value of one of the factory methods on `https://developer.android.com/reference/android/icu/number/Precision`. For example:

```
NumberFormatter.with().precision(Precision.fixedFraction(2))
```

In most cases, the default rounding precision is to round to 6 fraction places; i.e., `Precision.maxFraction(6)`. The exceptions are if compact notation is being used, then the compact notation rounding precision is used (see `https://developer.android.com/reference/android/icu/number/Notation#compactShort()` for details), or if the unit is a currency, then standard currency rounding is used, which varies from currency to currency (see `https://developer.android.com/reference/android/icu/number/Precision#currency(android.icu.util.Currency.CurrencyUsage)` for details).

<br />

| Parameters ||
|---|---|
| `precision` | `Precision`: The rounding precision to use. <br /> |

| Returns ||
|---|---|
| `T` | The fluent chain. <br /> |

**See also:**

- `https://developer.android.com/reference/android/icu/number/Precision`

### roundingMode

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

```
public T roundingMode (RoundingMode roundingMode)
```

Specifies how to determine the direction to round a number when it has more digits than fit in the desired precision. When formatting 1.235:

- Ceiling rounding mode with integer precision: "2"
- Half-down rounding mode with 2 fixed fraction digits: "1.23"
- Half-up rounding mode with 2 fixed fraction digits: "1.24"

The default is HALF_EVEN. For more information on rounding mode, see the ICU userguide here: https://unicode-org.github.io/icu/userguide/format_parse/numbers/rounding-modes

<br />

<br />

| Parameters ||
|---|---|
| `roundingMode` | `RoundingMode`: The rounding mode to use. <br /> |

| Returns ||
|---|---|
| `T` | The fluent chain. <br /> |

**See also:**

- `https://developer.android.com/reference/android/icu/number/Precision`

### scale

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

```
public T scale (Scale scale)
```

Sets a scale (multiplier) to be used to scale the number by an arbitrary amount before formatting. Most common values:

- Multiply by 100: useful for percentages.
- Multiply by an arbitrary value: useful for unit conversions.

Pass an element from a `https://developer.android.com/reference/android/icu/number/Scale` factory method to this setter. For example:

```
NumberFormatter.with().scale(Scale.powerOfTen(2))
```

The default is to not apply any multiplier.

<br />

| Parameters ||
|---|---|
| `scale` | `Scale`: An amount to be multiplied against numbers before formatting. <br /> |

| Returns ||
|---|---|
| `T` | The fluent chain <br /> |

**See also:**

- `https://developer.android.com/reference/android/icu/number/Scale`

### sign

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

```
public T sign (NumberFormatter.SignDisplay style)
```

Sets the plus/minus sign display strategy. Most common values:

- Auto: "123", "-123"
- Always: "+123", "-123"
- Accounting: "$123", "($123)"

Pass an element from the `https://developer.android.com/reference/android/icu/number/NumberFormatter.SignDisplay` enum to this setter. For example:

```
NumberFormatter.with().sign(SignDisplay.ALWAYS)
```

The default is AUTO sign display.

<br />

| Parameters ||
|---|---|
| `style` | `NumberFormatter.SignDisplay`: The sign display strategy to use when rendering numbers. <br /> |

| Returns ||
|---|---|
| `T` | The fluent chain <br /> |

**See also:**

- `https://developer.android.com/reference/android/icu/number/NumberFormatter.SignDisplay`

### symbols

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

```
public T symbols (NumberingSystem ns)
```

Specifies that the given numbering system should be used when fetching symbols.

- Latin numbering system: "12,345"
- Myanmar numbering system: "\\u1041\\u1042,\\u1043\\u1044\\u1045"
- Math Sans Bold numbering system: "\\ud835\\udfed\\ud835\\udfee,\\ud835\\udfef\\ud835\\udff0\\ud835\\udff1"

Pass this method an instance of `https://developer.android.com/reference/android/icu/text/NumberingSystem`. For example, to force the locale to always use the Latin alphabet numbering system (ASCII digits):

```
NumberFormatter.with().symbols(NumberingSystem.LATIN)
```

**Note:** Calling this method will override the DecimalFormatSymbols previously specified in `https://developer.android.com/reference/android/icu/number/NumberFormatterSettings#symbols(android.icu.text.DecimalFormatSymbols)`.

The default is to choose the best numbering system for the locale.

<br />

| Parameters ||
|---|---|
| `ns` | `NumberingSystem`: The NumberingSystem to use. <br /> |

| Returns ||
|---|---|
| `T` | The fluent chain. <br /> |

**See also:**

- `https://developer.android.com/reference/android/icu/text/NumberingSystem`

### symbols

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

```
public T symbols (DecimalFormatSymbols symbols)
```

Specifies the symbols (decimal separator, grouping separator, percent sign, numerals, etc.) to use when rendering numbers.

- *en_US* symbols: "12,345.67"
- *fr_FR* symbols: "12 345,67"
- *de_CH* symbols: "12\\u2019345.67"
- *my_MY* symbols: "\\u1041\\u1042,\\u1043\\u1044\\u1045.\\u1046\\u1047"

Pass this method an instance of `https://developer.android.com/reference/android/icu/text/DecimalFormatSymbols`. For example:

```
NumberFormatter.with().symbols(DecimalFormatSymbols.getInstance(new ULocale("de_CH")))
```

**Note:** DecimalFormatSymbols automatically chooses the best numbering system based on the locale. In the examples above, the first three are using the Latin numbering system, and the fourth is using the Myanmar numbering system.

**Note:** The instance of DecimalFormatSymbols will be copied: changes made to the symbols object after passing it into the fluent chain will not be seen.

**Note:** Calling this method will override the NumberingSystem previously specified in `https://developer.android.com/reference/android/icu/number/NumberFormatterSettings#symbols(android.icu.text.NumberingSystem)`.

The default is to choose the symbols based on the locale specified in the fluent chain.

<br />

| Parameters ||
|---|---|
| `symbols` | `DecimalFormatSymbols`: The DecimalFormatSymbols to use. <br /> |

| Returns ||
|---|---|
| `T` | The fluent chain. <br /> |

**See also:**

- `https://developer.android.com/reference/android/icu/text/DecimalFormatSymbols`

### toSkeleton

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

```
public String toSkeleton ()
```

Creates a skeleton string representation of this number formatter. A skeleton string is a locale-agnostic serialized form of a number formatter.

Not all options are capable of being represented in the skeleton string; for example, a DecimalFormatSymbols object. If any such option is encountered, an `https://developer.android.com/reference/java/lang/UnsupportedOperationException` is thrown.

The returned skeleton is in normalized form, such that two number formatters with equivalent behavior should produce the same skeleton.

For more information on number skeleton strings, see: https://unicode-org.github.io/icu/userguide/format_parse/numbers/skeletons.html

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | A number skeleton string with behavior corresponding to this number formatter. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/UnsupportedOperationException` | If the number formatter has an option that cannot be represented in a skeleton string. |

### unit

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

```
public T unit (MeasureUnit unit)
```

Specifies the unit (unit of measure, currency, or percent) to associate with rendered numbers.

- Unit of measure: "12.3 meters"
- Currency: "$12.30"
- Percent: "12.3%"

**Note:** The unit can also be specified by passing a `https://developer.android.com/reference/android/icu/util/Measure` to `https://developer.android.com/reference/android/icu/number/LocalizedNumberFormatter#format(android.icu.util.Measure)`. Units specified via the format method take precedence over units specified here. This setter is designed for situations when the unit is constant for the duration of the number formatting process.

All units will be properly localized with locale data, and all units are compatible with notation styles, rounding strategies, and other number formatter settings.

Pass this method any instance of `https://developer.android.com/reference/android/icu/util/MeasureUnit`. For units of measure:

```
NumberFormatter.with().unit(MeasureUnit.METER)
```
Currency:

```
NumberFormatter.with().unit(Currency.getInstance("USD"))
```

See `https://developer.android.com/reference/android/icu/number/NumberFormatterSettings#perUnit(android.icu.util.MeasureUnit)` for information on how to format strings like "5 meters per second".

If the input usage is correctly set the output unit **will change** according to `usage`, `locale` and `unit` value.

<br />

<br />

| Parameters ||
|---|---|
| `unit` | `MeasureUnit`: The unit to render. <br /> |

| Returns ||
|---|---|
| `T` | The fluent chain. <br /> |

**See also:**

- `https://developer.android.com/reference/android/icu/util/MeasureUnit`
- `https://developer.android.com/reference/android/icu/util/Currency`
- `https://developer.android.com/reference/android/icu/number/NumberFormatterSettings#perUnit(android.icu.util.MeasureUnit)`

### unitWidth

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

```
public T unitWidth (NumberFormatter.UnitWidth style)
```

Sets the width of the unit (measure unit or currency). Most common values:

- Short: "$12.00", "12 m"
- ISO Code: "USD 12.00"
- Full name: "12.00 US dollars", "12 meters"

Pass an element from the `https://developer.android.com/reference/android/icu/number/NumberFormatter.UnitWidth` enum to this setter. For example:

```
NumberFormatter.with().unitWidth(UnitWidth.FULL_NAME)
```

The default is the SHORT width.

<br />

| Parameters ||
|---|---|
| `style` | `NumberFormatter.UnitWidth`: The width to use when rendering numbers. <br /> |

| Returns ||
|---|---|
| `T` | The fluent chain <br /> |

**See also:**

- `https://developer.android.com/reference/android/icu/number/NumberFormatter.UnitWidth`

### usage

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

```
public T usage (String usage)
```

Specifies the usage for which numbers will be formatted ("person-height", "road", "rainfall", etc.)

When a `usage` is specified, the output unit will change depending on the `Locale` and the unit quantity. For example, formatting length measurements specified in meters:

```
NumberFormatter.with().usage("person").unit(MeasureUnit.METER).locale(new ULocale("en-US"))
```

- When formatting 0.25, the output will be "10 inches".
- When formatting 1.50, the output will be "4 feet and 11 inches".

The input unit specified via unit() determines the type of measurement being formatted (e.g. "length" when the unit is "foot"). The usage requested will be looked for only within this category of measurement units.

The output unit can be found via FormattedNumber.getOutputUnit().

If the usage has multiple parts (e.g. "land-agriculture-grain") and does not match a known usage preference, the last part will be dropped repeatedly until a match is found (e.g. trying "land-agriculture", then "land"). If a match is still not found, usage will fall back to "default".

Setting usage to an empty string clears the usage (disables usage-based localized formatting).

Setting a usage string but not a correct input unit will result in an U_ILLEGAL_ARGUMENT_ERROR.

When using usage, specifying rounding or precision is unnecessary. Specifying a precision in some manner will override the default formatting.

<br />

| Parameters ||
|---|---|
| `usage` | `String`: A usage parameter from the units resource. <br /> |

| Returns ||
|---|---|
| `T` | The fluent chain <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | in case of Setting a usage string but not a correct input unit. |