Package com.ibm.icu.text
Interface FormattedValue
- All Superinterfaces:
CharSequence
- All Known Implementing Classes:
DateIntervalFormat.FormattedDateInterval
,FormattedMessage
,FormattedNumber
,FormattedNumberRange
,ListFormatter.FormattedList
,PlainStringFormattedValue
,RelativeDateTimeFormatter.FormattedRelativeDateTime
An abstract formatted value: a string with associated field attributes.
Many formatters format to classes implementing FormattedValue.
- Author:
- sffc
-
Method Summary
Modifier and TypeMethodDescription<A extends Appendable>
AappendTo
(A appendable) Appends the formatted string to an Appendable.boolean
Iterates over field positions in the FormattedValue.Exports the formatted number as an AttributedCharacterIterator.toString()
Returns the formatted string as a Java String.Methods inherited from interface java.lang.CharSequence
charAt, chars, codePoints, isEmpty, length, subSequence
-
Method Details
-
toString
String toString()Returns the formatted string as a Java String. Consider usingappendTo(A)
for greater efficiency.- Specified by:
toString
in interfaceCharSequence
- Overrides:
toString
in classObject
- Returns:
- The formatted string.
-
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
- The Appendable to which to append the string output.- Returns:
- The same Appendable, for chaining.
- Throws:
ICUUncheckedIOException
- if the Appendable throws IOException
-
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
- The object used for iteration state. This can provide constraints to iterate over only one specific field; seeConstrainedFieldPosition.constrainField(java.text.Format.Field)
.- Returns:
- true if a new occurrence of the field was found; false otherwise.
-
toCharacterIterator
AttributedCharacterIterator toCharacterIterator()Exports the formatted number as an AttributedCharacterIterator.Consider using
nextPosition(com.ibm.icu.text.ConstrainedFieldPosition)
if you are trying to get field information.- Returns:
- An AttributedCharacterIterator containing full field information.
-