Added in API level 30

FormattedNumber


public class FormattedNumber
extends Object implements FormattedValue

java.lang.Object
   ↳ android.icu.number.FormattedNumber


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:

Summary

Public methods

<A extends Appendable> A appendTo(A appendable)

Appends the formatted string to an Appendable.

char charAt(int index)

Returns the char value at the specified index.

DisplayOptions.NounClass getNounClass()

Gets the noun class of the formatted output.

MeasureUnit getOutputUnit()

Gets the resolved output unit.

int length()

Returns the length of this character sequence.

boolean nextPosition(ConstrainedFieldPosition cfpos)

Iterates over field positions in the FormattedValue.

CharSequence subSequence(int start, int end)

Returns a CharSequence that is a subsequence of this sequence.

BigDecimal toBigDecimal()

Export the formatted number as a BigDecimal.

AttributedCharacterIterator toCharacterIterator()

Exports the formatted number as an AttributedCharacterIterator.

String toString()

Returns a string representation of the object.

Inherited methods

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

abstract <A extends Appendable> A appendTo(A appendable)

Appends the formatted string to an Appendable.

abstract boolean nextPosition(ConstrainedFieldPosition cfpos)

Iterates over field positions in the FormattedValue.

abstract AttributedCharacterIterator toCharacterIterator()

Exports the formatted number as an AttributedCharacterIterator.

abstract String toString()

Returns the formatted string as a Java String.

abstract char charAt(int index)

Returns the char value at the specified index.

default IntStream chars()

Returns a stream of int zero-extending the char values from this sequence.

default IntStream codePoints()

Returns a stream of code point values from this sequence.

static int compare(CharSequence cs1, CharSequence cs2)

Compares two CharSequence instances lexicographically.

default boolean isEmpty()

Returns true if this character sequence is empty.

abstract int length()

Returns the length of this character sequence.

abstract CharSequence subSequence(int start, int end)

Returns a CharSequence that is a subsequence of this sequence.

abstract String toString()

Returns a string containing the characters in this sequence in the same order as this sequence.

Public methods

appendTo

Added in API level 31
public 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.

Parameters
appendable A: The Appendable to which to append the string output.

Returns
A The same Appendable, for chaining.

charAt

Added in API level 30
public char charAt (int index)

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

getNounClass

Added in API level 35
public DisplayOptions.NounClass getNounClass ()

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

Returns
DisplayOptions.NounClass NounClass

getOutputUnit

Added in API level 33
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 MeasureUnit.

length

Added in API level 30
public int 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

nextPosition

Added in API level 31
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
     }
 

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.

subSequence

Added in API level 30
public CharSequence subSequence (int start, 
                int end)

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

toBigDecimal

Added in API level 30
public 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
BigDecimal A BigDecimal representation of the formatted number.

See also:

toCharacterIterator

Added in API level 30
public AttributedCharacterIterator toCharacterIterator ()

Exports the formatted number as an AttributedCharacterIterator.

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

Returns
AttributedCharacterIterator An AttributedCharacterIterator containing full field information.

toString

Added in API level 30
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.