Package com.ibm.icu.text
Class RelativeDateTimeFormatter.FormattedRelativeDateTime
- java.lang.Object
-
- com.ibm.icu.text.RelativeDateTimeFormatter.FormattedRelativeDateTime
-
- All Implemented Interfaces:
FormattedValue
,java.lang.CharSequence
- Enclosing class:
- RelativeDateTimeFormatter
public static class RelativeDateTimeFormatter.FormattedRelativeDateTime extends java.lang.Object implements FormattedValue
Represents the result of a formatting operation of a relative datetime. Access the string value or field information. Instances of this class are immutable and thread-safe. Not intended for public subclassing.
-
-
Field Summary
Fields Modifier and Type Field Description private FormattedStringBuilder
string
-
Constructor Summary
Constructors Modifier Constructor Description private
FormattedRelativeDateTime(FormattedStringBuilder string)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description <A extends java.lang.Appendable>
AappendTo(A appendable)
Appends the formatted string to an Appendable.char
charAt(int index)
int
length()
boolean
nextPosition(ConstrainedFieldPosition cfpos)
Iterates over field positions in the FormattedValue.java.lang.CharSequence
subSequence(int start, int end)
java.text.AttributedCharacterIterator
toCharacterIterator()
Exports the formatted number as an AttributedCharacterIterator.java.lang.String
toString()
Returns the formatted string as a Java String.
-
-
-
Field Detail
-
string
private final FormattedStringBuilder string
-
-
Constructor Detail
-
FormattedRelativeDateTime
private FormattedRelativeDateTime(FormattedStringBuilder string)
-
-
Method Detail
-
toString
public java.lang.String toString()
Returns the formatted string as a Java String. Consider usingFormattedValue.appendTo(A)
for greater efficiency.- Specified by:
toString
in interfacejava.lang.CharSequence
- Specified by:
toString
in interfaceFormattedValue
- Overrides:
toString
in classjava.lang.Object
- Returns:
- The formatted string.
-
length
public int length()
- Specified by:
length
in interfacejava.lang.CharSequence
-
charAt
public char charAt(int index)
- Specified by:
charAt
in interfacejava.lang.CharSequence
-
subSequence
public java.lang.CharSequence subSequence(int start, int end)
- Specified by:
subSequence
in interfacejava.lang.CharSequence
-
appendTo
public <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.- Specified by:
appendTo
in interfaceFormattedValue
- Parameters:
appendable
- The Appendable to which to append the string output.- Returns:
- The same Appendable, for chaining.
-
nextPosition
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 }
- Specified by:
nextPosition
in interfaceFormattedValue
- 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
public java.text.AttributedCharacterIterator toCharacterIterator()
Exports the formatted number as an AttributedCharacterIterator.Consider using
FormattedValue.nextPosition(com.ibm.icu.text.ConstrainedFieldPosition)
if you are trying to get field information.- Specified by:
toCharacterIterator
in interfaceFormattedValue
- Returns:
- An AttributedCharacterIterator containing full field information.
-
-