public Class FormattedNumber

Implements com.ibm.icu.text.FormattedValue.appendTo.

Doc from com.ibm.icu.text.FormattedValue.appendTo.

Appends the formatted string to an Appendable.

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

Parameters

appendable:A

The Appendable to which to append the string output.

Returns:A

The same Appendable, for chaining.

Annotations

@Override

ICU Status

Stable since ICU 60.

Implements java.lang.CharSequence.charAt.

Doc from java.lang.CharSequence.charAt.

Returns the char value at the specified index. An index ranges from zero to length() - 1. The first char value of the sequence is at index zero, the next at index one, and so on, as for array indexing.

If the char value specified by the index is a surrogate, the surrogate value is returned.

Parameters

index:int

the index of the char value to be returned

Returns:char

the specified char value

Annotations

@Override

ICU Status

Stable since ICU 64.

Annotations

@Deprecated

ICU Status

Internal ICU component.

The gender of the formatted output.

Annotations

@Deprecated

ICU Status

Internal ICU component: 69 technology preview

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

Returns:DisplayOptions.NounClass

NounClass

ICU Status

Stable since ICU 72.

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

MeasureUnit.

ICU Status

Stable since ICU 68.

Implements java.lang.CharSequence.length.

Doc from java.lang.CharSequence.length.

Returns the length of this character sequence. The length is the number of 16-bit chars in the sequence.

Returns:int

the number of chars in this sequence

Annotations

@Override

ICU Status

Stable since ICU 64.

Implements com.ibm.icu.text.FormattedValue.nextPosition.

Doc from com.ibm.icu.text.FormattedValue.nextPosition.

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
    }

Parameters

cfpos:ConstrainedFieldPosition

The object used for iteration state. This can provide constraints to iterate over only one specific field; see ConstrainedFieldPosition#constrainField.

Returns:boolean

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

Annotations

@Override

ICU Status

Stable since ICU 64.

Implements java.lang.CharSequence.subSequence.

Doc from java.lang.CharSequence.subSequence.

Returns a CharSequence that is a subsequence of this sequence. The subsequence starts with the char value at the specified index and ends with the char value at index end - 1. The length (in chars) of the returned sequence is end - start, so if start == end then an empty sequence is returned.

Parameters

start:int

the start index, inclusive

end:int

the end index, exclusive

Returns:CharSequence

the specified subsequence

Annotations

@Override

ICU Status

Stable since ICU 64.

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:BigDecimal

A BigDecimal representation of the formatted number.

ICU Status

Stable since ICU 60.

See Also

NumberFormatter

Implements com.ibm.icu.text.FormattedValue.toCharacterIterator.

Doc from com.ibm.icu.text.FormattedValue.toCharacterIterator.

Exports the formatted number as an AttributedCharacterIterator.

Consider using nextPosition if you are trying to get field information.

Returns:AttributedCharacterIterator

An AttributedCharacterIterator containing full field information.

Annotations

@Override

ICU Status

Stable since ICU 62.

Overrides java.lang.Object.toString.

Implements com.ibm.icu.text.FormattedValue.toString.

Doc from com.ibm.icu.text.FormattedValue.toString.

Returns the formatted string as a Java String. Consider using appendTo for greater efficiency.

Returns:String

The formatted string.

Annotations

@Override

ICU Status

Stable since ICU 60.