FormattedValue

Kotlin |Java

public interface FormattedValue
implements CharSequence

android.icu.text.FormattedValue

Known indirect subclasses

DateIntervalFormat.FormattedDateInterval, FormattedNumber, FormattedNumberRange, ListFormatter.FormattedList, RelativeDateTimeFormatter.FormattedRelativeDateTime

DateIntervalFormat.FormattedDateInterval	An immutable class containing the result of a date interval formatting operation.
FormattedNumber	The result of a number formatting operation.
FormattedNumberRange	The result of a number range formatting operation.
ListFormatter.FormattedList	An immutable class containing the result of a list formatting operation.
RelativeDateTimeFormatter.FormattedRelativeDateTime	Represents the result of a formatting operation of a relative datetime.

An abstract formatted value: a string with associated field attributes. Many formatters format to classes implementing FormattedValue.

Summary

Public methods
`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.

Inherited methods

From interface


        
          java.lang.CharSequence

`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 abstract 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.

Throws
`ICUUncheckedIOException`	if the Appendable throws IOException

nextPosition

Added in API level 31

public abstract 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.

toCharacterIterator

Added in API level 31

public abstract 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 31

public abstract String toString ()

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

Returns
`String`	The formatted string.