com.ibm.icu.number

Enum NumberFormatter.UnitWidth

java.lang.Object

java.lang.Enum<NumberFormatter.UnitWidth>

com.ibm.icu.number.NumberFormatter.UnitWidth

All Implemented Interfaces:

Serializable, Comparable<NumberFormatter.UnitWidth>

Enclosing class:

NumberFormatter

public static enum NumberFormatter.UnitWidth
extends Enum<NumberFormatter.UnitWidth>

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 MeasureFormat.FormatWidth.

See Also:

NumberFormatter

Status:

Stable ICU 60.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FORMAL Use the formal variant of the currency symbol; for example, "NT$" for the New Taiwan dollar in zh-TW.
FULL_NAME Print the full name of the unit, without any abbreviations.
HIDDEN Format the number according to the specified unit, but do not display the unit.
ISO_CODE Use the three-digit ISO XXX code in place of the symbol for displaying currencies.
NARROW Print an abbreviated version of the unit name.
SHORT Print an abbreviated version of the unit name.
VARIANT Use the alternate variant of the currency symbol; for example, "TL" for the Turkish lira (TRY).

Method Summary

Modifier and Type	Method and Description
static NumberFormatter.UnitWidth	valueOf(String name) Returns the enum constant of this type with the specified name.
static NumberFormatter.UnitWidth[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NARROW

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.

See Also:

NumberFormatter

Status:

Stable ICU 60.

SHORT

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.

See Also:

NumberFormatter

Status:

Stable ICU 60.

FULL_NAME

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.

See Also:

NumberFormatter

Status:

Stable ICU 60.

ISO_CODE

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.

See Also:

NumberFormatter

Status:

Stable ICU 60.

FORMAL

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.

See Also:

NumberFormatter

Status:

Stable ICU 67.

VARIANT

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.

See Also:

NumberFormatter

Status:

Stable ICU 67.

HIDDEN

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.

See Also:

NumberFormatter

Status:

Stable ICU 60.

Method Detail

values

public static NumberFormatter.UnitWidth[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NumberFormatter.UnitWidth c : NumberFormatter.UnitWidth.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NumberFormatter.UnitWidth valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null