FormattedValue
public
interface
FormattedValue
implements
CharSequence
android.icu.text.FormattedValue |
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 | |
---|---|
Public methods
appendTo
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
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
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
public abstract String toString ()
Returns the formatted string as a Java String.
Consider using appendTo(A)
for greater efficiency.
Returns | |
---|---|
String |
The formatted string. |