NumberFormatterSettings

decimal

open fun decimal(style: NumberFormatter.DecimalSeparatorDisplay!): T

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 DecimalSeparatorDisplay enum to this setter. For example:

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

The default is AUTO decimal separator display.

displayOptions

open fun displayOptions(displayOptions: DisplayOptions!): T

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

equals

open fun equals(other: Any?): Boolean

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.

grouping

open fun grouping(strategy: NumberFormatter.GroupingStrategy!): T

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 GroupingStrategy enum. For example:

NumberFormatter.with().grouping(GroupingStrategy.MIN2)
  

hashCode

open fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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 equals 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 equals 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.

integerWidth

open fun integerWidth(style: IntegerWidth!): T

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 IntegerWidth#zeroFillTo(int). For example:

NumberFormatter.with().integerWidth(IntegerWidth.zeroFillTo(2))
  

notation

open fun notation(notation: Notation!): T

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 Notation factory method. For example:

NumberFormatter.with().notation(Notation.compactShort())
  

perUnit

open fun perUnit(perUnit: MeasureUnit!): T

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 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 unit, the behavior is undefined.

precision

open fun precision(precision: Precision!): T

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 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 Notation#compactShort for details), or if the unit is a currency, then standard currency rounding is used, which varies from currency to currency (see Precision#currency for details).

roundingMode

open fun roundingMode(roundingMode: RoundingMode!): T

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"

scale

open fun scale(scale: Scale!): T

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 Scale factory method to this setter. For example:

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

The default is to not apply any multiplier.

sign

open fun sign(style: NumberFormatter.SignDisplay!): T

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

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

Pass an element from the SignDisplay enum to this setter. For example:

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

The default is AUTO sign display.

symbols

open fun symbols(symbols: DecimalFormatSymbols!): T

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’345.67"
• my_MY symbols: "၁၂,၃၄၅.၆၇"

Pass this method an instance of 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 symbols(android.icu.text.NumberingSystem).

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

symbols

open fun symbols(ns: NumberingSystem!): T

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

• Latin numbering system: "12,345"
• Myanmar numbering system: "၁၂,၃၄၅"
• Math Sans Bold numbering system: "𝟭𝟮,𝟯𝟰𝟱"

Pass this method an instance of 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 symbols(android.icu.text.DecimalFormatSymbols).

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

unit

open fun unit(unit: MeasureUnit!): T

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 Measure to LocalizedNumberFormatter#format(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 MeasureUnit. For units of measure:

NumberFormatter.with().unit(MeasureUnit.METER)
  

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

See perUnit 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.

unitWidth

open fun unitWidth(style: NumberFormatter.UnitWidth!): T

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 UnitWidth enum to this setter. For example:

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

The default is the SHORT width.

usage

open fun usage(usage: String!): T

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.