com.ibm.icu.number

Class FormattedNumber

java.lang.Object

com.ibm.icu.number.FormattedNumber

All Implemented Interfaces:

FormattedValue, java.lang.CharSequence

public class FormattedNumber
extends java.lang.Object
implements FormattedValue

The result of a number formatting operation. This class allows the result to be exported in several data types, including a String, an AttributedCharacterIterator, and a BigDecimal. Instances of this class are immutable and thread-safe.

See Also:

NumberFormatter

Status:

Stable ICU 60.

Method Summary

Modifier and Type	Method and Description
<A extends java.lang.Appendable> A	appendTo(A appendable) Appends the formatted string to an Appendable.
char	charAt(int index)
PluralRules.IFixedDecimal	getFixedDecimal() Deprecated. This API is ICU internal only.
java.lang.String	getGender() Deprecated. This API is for technology preview only.
DisplayOptions.NounClass	getNounClass() Gets the noun class of the formatted output.
MeasureUnit	getOutputUnit() Gets the resolved output unit.
int	length()
boolean	nextPosition(ConstrainedFieldPosition cfpos) Iterates over field positions in the FormattedValue.
java.lang.CharSequence	subSequence(int start, int end)
java.math.BigDecimal	toBigDecimal() Export the formatted number as a BigDecimal.
java.text.AttributedCharacterIterator	toCharacterIterator() Exports the formatted number as an AttributedCharacterIterator.
java.lang.String	toString() Returns the formatted string as a Java String.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Method Detail

toString

public java.lang.String toString()

Returns the formatted string as a Java String. Consider using FormattedValue.appendTo(A) for greater efficiency.

Specified by:

toString in interface FormattedValue

Specified by:

toString in interface java.lang.CharSequence

Overrides:

toString in class java.lang.Object

Returns:

The formatted string.

Status:

Stable ICU 60.

length

public int length()

Specified by:

length in interface java.lang.CharSequence

Status:

Stable ICU 64.

charAt

public char charAt(int index)

Specified by:

charAt in interface java.lang.CharSequence

Status:

Stable ICU 64.

subSequence

public java.lang.CharSequence subSequence(int start,
                                          int end)

Specified by:

subSequence in interface java.lang.CharSequence

Status:

Stable ICU 64.

appendTo

public <A extends java.lang.Appendable> A appendTo(A appendable)

Appends the formatted string to an Appendable.

If an IOException occurs when appending to the Appendable, an unchecked ICUUncheckedIOException is thrown instead.

Specified by:

appendTo in interface FormattedValue

Parameters:

appendable - The Appendable to which to append the string output.

Returns:

The same Appendable, for chaining.

Status:

Stable ICU 60.

nextPosition

public boolean nextPosition(ConstrainedFieldPosition cfpos)

Iterates over field positions in the FormattedValue. This lets you determine the position of specific types of substrings, like a month or a decimal separator. To loop over all field positions:

     ConstrainedFieldPosition cfpos = new ConstrainedFieldPosition();
     while (fmtval.nextPosition(cfpos)) {
         // handle the field position; get information from cfpos
     }
 

Specified by:

nextPosition in interface FormattedValue

Parameters:

cfpos - The object used for iteration state. This can provide constraints to iterate over only one specific field; see ConstrainedFieldPosition.constrainField(java.text.Format.Field).

Returns:

true if a new occurrence of the field was found; false otherwise.

Status:

Stable ICU 64.

toCharacterIterator

public java.text.AttributedCharacterIterator toCharacterIterator()

Exports the formatted number as an AttributedCharacterIterator.

Consider using FormattedValue.nextPosition(com.ibm.icu.text.ConstrainedFieldPosition) if you are trying to get field information.

Specified by:

toCharacterIterator in interface FormattedValue

Returns:

An AttributedCharacterIterator containing full field information.

Status:

Stable ICU 62.

toBigDecimal

public java.math.BigDecimal toBigDecimal()

Export the formatted number as a BigDecimal. This endpoint is useful for obtaining the exact number being printed after scaling and rounding have been applied by the number formatting pipeline.

Returns:

A BigDecimal representation of the formatted number.

See Also:

NumberFormatter

Status:

Stable ICU 60.

getOutputUnit

public MeasureUnit getOutputUnit()

Gets the resolved output unit.

The output unit is dependent upon the localized preferences for the usage specified via NumberFormatterSettings.usage(), and may be a unit with MeasureUnit.Complexity.MIXED unit complexity (MeasureUnit.getComplexity()), such as "foot-and-inch" or "hour-and-minute-and-second".

Returns:

MeasureUnit.

Status:

Stable ICU 68.

getNounClass

public DisplayOptions.NounClass getNounClass()

Gets the noun class of the formatted output. Returns UNDEFINED when the noun class is not supported yet.

Returns:

NounClass

Status:

Draft ICU 71..

getGender

@Deprecated
public java.lang.String getGender()

Deprecated. This API is for technology preview only.

The gender of the formatted output.

Status:

Technology Preview. This API is still in the early stages of development. Use at your own risk.

getFixedDecimal

@Deprecated
public PluralRules.IFixedDecimal getFixedDecimal()

Deprecated. This API is ICU internal only.

Status:

Internal. This API is ICU internal only.