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

# NumberFormatter.UnitWidth

*** ** * ** ***


`
public
static
final

enum
NumberFormatter.UnitWidth
`


`


`

`

extends https://developer.android.com/reference/java/lang/Enum<https://developer.android.com/reference/android/icu/number/NumberFormatter.UnitWidth>


`

`


`

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) |||
| ↳ | [java.lang.Enum](https://developer.android.com/reference/java/lang/Enum)\<[android.icu.number.NumberFormatter.UnitWidth](https://developer.android.com/reference/android/icu/number/NumberFormatter.UnitWidth)\> ||
|   | ↳ | android.icu.number.NumberFormatter.UnitWidth |

<br />

*** ** * ** ***

An enum declaring how to render units, including currencies. Example outputs when formatting 123
USD and 123 meters in *en-CA*:

- NARROW: "$123.00" and "123 m"
- SHORT: "US$ 123.00" and "123 m"
- FULL_NAME: "123.00 US dollars" and "123 meters"
- ISO_CODE: "USD 123.00" and undefined behavior
- HIDDEN: "123.00" and "123"


This enum is similar to `https://developer.android.com/reference/android/icu/text/MeasureFormat.FormatWidth`.
**See also:**

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

## Summary

| ### Enum values ||
|---|---|
| `https://developer.android.com/reference/android/icu/number/NumberFormatter.UnitWidth` | `FORMAL` Use the formal variant of the currency symbol; for example, "NT$" for the New Taiwan dollar in zh-TW. |
| `https://developer.android.com/reference/android/icu/number/NumberFormatter.UnitWidth` | `FULL_NAME` Print the full name of the unit, without any abbreviations. |
| `https://developer.android.com/reference/android/icu/number/NumberFormatter.UnitWidth` | `HIDDEN` Format the number according to the specified unit, but do not display the unit. |
| `https://developer.android.com/reference/android/icu/number/NumberFormatter.UnitWidth` | `ISO_CODE` Use the three-digit ISO XXX code in place of the symbol for displaying currencies. |
| `https://developer.android.com/reference/android/icu/number/NumberFormatter.UnitWidth` | `NARROW` Print an abbreviated version of the unit name. |
| `https://developer.android.com/reference/android/icu/number/NumberFormatter.UnitWidth` | `SHORT` Print an abbreviated version of the unit name. |
| `https://developer.android.com/reference/android/icu/number/NumberFormatter.UnitWidth` | `VARIANT` Use the alternate variant of the currency symbol; for example, "TL" for the Turkish lira (TRY). |

| ### Public methods ||
|---|---|
| ` static https://developer.android.com/reference/android/icu/number/NumberFormatter.UnitWidth` | ` https://developer.android.com/reference/android/icu/number/NumberFormatter.UnitWidth#valueOf(java.lang.String)(https://developer.android.com/reference/java/lang/String name) ` |
| ` static final https://developer.android.com/reference/android/icu/number/NumberFormatter.UnitWidth` | ` https://developer.android.com/reference/android/icu/number/NumberFormatter.UnitWidth#values()() ` |

### Inherited methods

From class `

https://developer.android.com/reference/java/lang/Enum

` `


final

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

Throws CloneNotSupportedException.


`


final

int` `
https://developer.android.com/reference/java/lang/Enum#compareTo(E)(https://developer.android.com/reference/android/icu/number/NumberFormatter.UnitWidth o)
`

Compares this enum with the specified object for order.


`


final

boolean` `
https://developer.android.com/reference/java/lang/Enum#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object other)
`

Returns true if the specified object is equal to this
enum constant.


`


final

void` `
https://developer.android.com/reference/java/lang/Enum#finalize()()
`

enum classes cannot have finalize methods.


`


final

https://developer.android.com/reference/java/lang/Class<https://developer.android.com/reference/android/icu/number/NumberFormatter.UnitWidth>` `
https://developer.android.com/reference/java/lang/Enum#getDeclaringClass()()
`

Returns the Class object corresponding to this enum constant's
enum type.


`


final

int` `
https://developer.android.com/reference/java/lang/Enum#hashCode()()
`

Returns a hash code for this enum constant.


`


final

https://developer.android.com/reference/java/lang/String` `
https://developer.android.com/reference/java/lang/Enum#name()()
`

Returns the name of this enum constant, exactly as declared in its
enum declaration.


`


final

int` `
https://developer.android.com/reference/java/lang/Enum#ordinal()()
`

Returns the ordinal of this enumeration constant (its position
in its enum declaration, where the initial constant is assigned
an ordinal of zero).


`


https://developer.android.com/reference/java/lang/String` `
https://developer.android.com/reference/java/lang/Enum#toString()()
`

Returns the name of this enum constant, as contained in the
declaration.


`


static

<T extends https://developer.android.com/reference/java/lang/Enum<T>>
T` `
https://developer.android.com/reference/java/lang/Enum#valueOf(java.lang.Class<T>,%20java.lang.String)(https://developer.android.com/reference/java/lang/Class<T> enumClass, https://developer.android.com/reference/java/lang/String name)
`

Returns the enum constant of the specified enum class with the
specified name.


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


From interface `

https://developer.android.com/reference/java/lang/Comparable

` `
abstract


int` `
https://developer.android.com/reference/java/lang/Comparable#compareTo(T)(https://developer.android.com/reference/android/icu/number/NumberFormatter.UnitWidth o)
`

Compares this object with the specified object for order.


## Enum values

### FORMAL

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

```
public static final NumberFormatter.UnitWidth FORMAL
```

Use the formal variant of the currency symbol; for example, "NT$" for the New Taiwan
dollar in zh-TW.


Behavior of this option with non-currency units is not defined at this time.

<br />

**See also:**

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

### FULL_NAME

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

```
public static final NumberFormatter.UnitWidth FULL_NAME
```

Print the full name of the unit, without any abbreviations.


In CLDR, this option corresponds to the default format for measure units and the "¤¤¤"
placeholder for currencies.

<br />

**See also:**

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

### HIDDEN

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

```
public static final NumberFormatter.UnitWidth HIDDEN
```

Format the number according to the specified unit, but do not display the unit. For
currencies, apply monetary symbols and formats as with SHORT, but omit the currency symbol.
For measure units, the behavior is equivalent to not specifying the unit at all.

<br />

**See also:**

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

### ISO_CODE

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

```
public static final NumberFormatter.UnitWidth ISO_CODE
```

Use the three-digit ISO XXX code in place of the symbol for displaying currencies.


Behavior of this option with non-currency units is not defined at this time.


In CLDR, this option corresponds to the "¤¤" placeholder for currencies.

<br />

**See also:**

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

### NARROW

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

```
public static final NumberFormatter.UnitWidth NARROW
```

Print an abbreviated version of the unit name. Similar to SHORT, but always use the shortest
available abbreviation or symbol. This option can be used when the context hints at the
identity of the unit. For more information on the difference between NARROW and SHORT, see
SHORT.


In CLDR, this option corresponds to the "Narrow" format for measure units and the "¤¤¤¤¤"
placeholder for currencies.

<br />

**See also:**

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

### SHORT

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

```
public static final NumberFormatter.UnitWidth SHORT
```

Print an abbreviated version of the unit name. Similar to NARROW, but use a slightly wider
abbreviation or symbol when there may be ambiguity. This is the default behavior.


For example, in *es-US*, the SHORT form for Fahrenheit is "{0} °F", but the NARROW form
is "{0}°", since Fahrenheit is the customary unit for temperature in that locale.


In CLDR, this option corresponds to the "Short" format for measure units and the "¤"
placeholder for currencies.

<br />

**See also:**

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

### VARIANT

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

```
public static final NumberFormatter.UnitWidth VARIANT
```

Use the alternate variant of the currency symbol; for example, "TL" for the Turkish
lira (TRY).


Behavior of this option with non-currency units is not defined at this time.

<br />

**See also:**

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

## Public methods

### valueOf

```
public static NumberFormatter.UnitWidth valueOf (String name)
```

<br />

<br />

| Parameters ||
|---|---|
| `name` | `String` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/icu/number/NumberFormatter.UnitWidth` | <br /> |

### values

```
public static final UnitWidth[] values ()
```

<br />

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/icu/number/NumberFormatter.UnitWidth` | <br /> |