Class LocalizedNumberFormatter

java.lang.Object

com.ibm.icu.number.NumberFormatterSettings<LocalizedNumberFormatter>

com.ibm.icu.number.LocalizedNumberFormatter

public class LocalizedNumberFormatter
extends NumberFormatterSettings<LocalizedNumberFormatter>

A NumberFormatter that has a locale associated with it; this means .format() methods are available.

Instances of this class are immutable and thread-safe.

See Also:

• NumberFormatter

Status:

Stable ICU 60.

Method Summary

Modifier and Type	Method	Description
FormattedNumber	format(double input)	Format the given float or double to a string using the settings specified in the NumberFormatter fluent setting chain.
FormattedNumber	format(long input)	Format the given byte, short, int, or long to a string using the settings specified in the NumberFormatter fluent setting chain.
FormattedNumber	format(Measure input)	Format the given Measure or CurrencyAmount to a string using the settings specified in the NumberFormatter fluent setting chain.
FormattedNumber	format(Number input)	Format the given BigInteger, BigDecimal, or other Number to a string using the settings specified in the NumberFormatter fluent setting chain.
com.ibm.icu.impl.number.MicroProps	formatImpl(com.ibm.icu.impl.number.DecimalQuantity fq, com.ibm.icu.impl.FormattedStringBuilder string)	Deprecated. ICU 60 This API is ICU internal only.
com.ibm.icu.impl.number.MicroProps	formatImpl(com.ibm.icu.impl.number.DecimalQuantity fq, MeasureUnit unit, com.ibm.icu.impl.FormattedStringBuilder string)	Deprecated. ICU 67 This API is ICU internal only.
String	getAffixImpl(boolean isPrefix, boolean isNegative)	Deprecated. This API is ICU internal only.
Format	toFormat()	Creates a representation of this LocalizedNumberFormat as a Format, enabling the use of this number formatter with APIs that need an object of that type, such as MessageFormat.
UnlocalizedNumberFormatter	withoutLocale()	Disassociate the locale from this formatter.

Methods inherited from class NumberFormatterSettings

decimal, displayOptions, equals, grouping, hashCode, integerWidth, macros, notation, padding, perUnit, precision, roundingMode, scale, sign, symbols, symbols, threshold, toSkeleton, unit, unitDisplayCase, unitWidth, usage

Modifier and Type	Method	Description
LocalizedNumberFormatter	decimal(NumberFormatter.DecimalSeparatorDisplay style)	Sets the decimal separator display strategy.
LocalizedNumberFormatter	displayOptions(DisplayOptions displayOptions)	Specifies the DisplayOptions.
boolean	equals(Object other)
LocalizedNumberFormatter	grouping(NumberFormatter.GroupingStrategy strategy)	Specifies the grouping strategy to use when formatting numbers.
int	hashCode()
LocalizedNumberFormatter	integerWidth(IntegerWidth style)	Specifies the minimum and maximum number of digits to render before the decimal mark.
LocalizedNumberFormatter	macros(com.ibm.icu.impl.number.MacroProps macros)	Deprecated. ICU 60 This API is ICU internal only.
LocalizedNumberFormatter	notation(Notation notation)	Specifies the notation style (simple, scientific, or compact) for rendering numbers.
LocalizedNumberFormatter	padding(com.ibm.icu.impl.number.Padder padder)	Deprecated. ICU 60 This API is ICU internal only.
LocalizedNumberFormatter	perUnit(MeasureUnit perUnit)	Sets a unit to be used in the denominator.
LocalizedNumberFormatter	precision(Precision precision)	Specifies the rounding precision to use when formatting numbers.
LocalizedNumberFormatter	roundingMode(RoundingMode roundingMode)	Specifies how to determine the direction to round a number when it has more digits than fit in the desired precision.
LocalizedNumberFormatter	scale(Scale scale)	Sets a scale (multiplier) to be used to scale the number by an arbitrary amount before formatting.
LocalizedNumberFormatter	sign(NumberFormatter.SignDisplay style)	Sets the plus/minus sign display strategy.
LocalizedNumberFormatter	symbols(DecimalFormatSymbols symbols)	Specifies the symbols (decimal separator, grouping separator, percent sign, numerals, etc.) to use when rendering numbers.
LocalizedNumberFormatter	symbols(NumberingSystem ns)	Specifies that the given numbering system should be used when fetching symbols.
LocalizedNumberFormatter	threshold(Long threshold)	Deprecated. ICU 60 This API is ICU internal only.
String	toSkeleton()	Creates a skeleton string representation of this number formatter.
LocalizedNumberFormatter	unit(MeasureUnit unit)	Specifies the unit (unit of measure, currency, or percent) to associate with rendered numbers.
LocalizedNumberFormatter	unitDisplayCase(String unitDisplayCase)	Deprecated. This API is for technology preview only.
LocalizedNumberFormatter	unitWidth(NumberFormatter.UnitWidth style)	Sets the width of the unit (measure unit or currency).
LocalizedNumberFormatter	usage(String usage)	Specifies the usage for which numbers will be formatted ("person-height", "road", "rainfall", etc.)

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

format

public FormattedNumber format(long input)

Format the given byte, short, int, or long to a string using the settings specified in the NumberFormatter fluent setting chain.

Parameters:

input - The number to format.

Returns:

A FormattedNumber object; call .toString() to get the string.

See Also:

• NumberFormatter

Status:

Stable ICU 60.

format

public FormattedNumber format(double input)

Format the given float or double to a string using the settings specified in the NumberFormatter fluent setting chain.

Parameters:

input - The number to format.

Returns:

A FormattedNumber object; call .toString() to get the string.

See Also:

• NumberFormatter

Status:

Stable ICU 60.

format

public FormattedNumber format(Number input)

Format the given BigInteger, BigDecimal, or other Number to a string using the settings specified in the NumberFormatter fluent setting chain.

Parameters:

input - The number to format.

Returns:

A FormattedNumber object; call .toString() to get the string.

See Also:

• NumberFormatter

Status:

Stable ICU 60.

format

public FormattedNumber format(Measure input)

Format the given Measure or CurrencyAmount to a string using the settings specified in the NumberFormatter fluent setting chain.

The unit specified here overrides any unit that may have been specified in the setter chain. This method is intended for cases when each input to the number formatter has a different unit.

Parameters:

input - The number to format.

Returns:

A FormattedNumber object; call .toString() to get the string.

See Also:

• NumberFormatter

Status:

Stable ICU 60.

toFormat

public Format toFormat()

Creates a representation of this LocalizedNumberFormat as a Format, enabling the use of this number formatter with APIs that need an object of that type, such as MessageFormat.

This API is not intended to be used other than for enabling API compatibility. The format(long) methods should normally be used when formatting numbers, not the Format object returned by this method.

Returns:

A Format wrapping this LocalizedNumberFormatter.

See Also:

• NumberFormatter

Status:

Stable ICU 62.

withoutLocale

public UnlocalizedNumberFormatter withoutLocale()

Disassociate the locale from this formatter.

Returns:

The fluent chain.

Status:

Stable ICU 74.

formatImpl

@Deprecated
public com.ibm.icu.impl.number.MicroProps formatImpl(com.ibm.icu.impl.number.DecimalQuantity fq,
 com.ibm.icu.impl.FormattedStringBuilder string)

Deprecated.

ICU 60 This API is ICU internal only.

This is the core entrypoint to the number formatting pipeline. It performs self-regulation: a static code path for the first few calls, and compiling a more efficient data structure if called repeatedly.

This function is very hot, being called in every call to the number formatting pipeline.

Parameters:

fq - The quantity to be formatted.

string - The string builder into which to insert the result.

Status:

Internal. This API is ICU internal only.

formatImpl

@Deprecated
public com.ibm.icu.impl.number.MicroProps formatImpl(com.ibm.icu.impl.number.DecimalQuantity fq,
 MeasureUnit unit,
 com.ibm.icu.impl.FormattedStringBuilder string)

Deprecated.

ICU 67 This API is ICU internal only.

Version of above for unit override.

Status:

Internal. This API is ICU internal only.

getAffixImpl

@Deprecated
public String getAffixImpl(boolean isPrefix,
 boolean isNegative)

Deprecated.

This API is ICU internal only. Use FormattedNumber.nextPosition(ConstrainedFieldPosition) for related functionality.

Status:

Internal. This API is ICU internal only.