Package com.ibm.icu.text
Interface FormattedValue
-
- All Superinterfaces:
java.lang.CharSequence
- All Known Implementing Classes:
DateIntervalFormat.FormattedDateInterval
,FormattedNumber
,FormattedNumberRange
,RelativeDateTimeFormatter.FormattedRelativeDateTime
public interface FormattedValue extends java.lang.CharSequence
An abstract formatted value: a string with associated field attributes. Many formatters format to classes implementing FormattedValue.- Author:
- sffc
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description <A extends java.lang.Appendable>
AappendTo(A appendable)
Appends the formatted string to an Appendable.boolean
nextPosition(ConstrainedFieldPosition cfpos)
Iterates over field positions in the FormattedValue.java.text.AttributedCharacterIterator
toCharacterIterator()
Exports the formatted number as an AttributedCharacterIterator.java.lang.String
toString()
Returns the formatted string as a Java String.
-
-
-
Method Detail
-
toString
java.lang.String toString()
Returns the formatted string as a Java String. Consider usingappendTo(A)
for greater efficiency.- Specified by:
toString
in interfacejava.lang.CharSequence
- Overrides:
toString
in classjava.lang.Object
- Returns:
- The formatted string.
-
appendTo
<A extends java.lang.Appendable> 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
- The Appendable to which to append the string output.- Returns:
- The same Appendable, for chaining.
-
nextPosition
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:ConstrainableFieldPosition cfpos = new ConstrainableFieldPosition(); 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
java.text.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.
-
-