Package com.ibm.icu.text

Class DateIntervalFormat.FormattedDateInterval

java.lang.Object

com.ibm.icu.text.DateIntervalFormat.FormattedDateInterval

All Implemented Interfaces:

FormattedValue, CharSequence

Enclosing class:

DateIntervalFormat

public static final class DateIntervalFormat.FormattedDateInterval
extends Object
implements FormattedValue

An immutable class containing the result of a date interval formatting operation. Instances of this class are immutable and thread-safe. Not intended for public subclassing.

Status:

Stable ICU 64.

Method Summary

Modifier and Type	Method	Description
<A extends Appendable> A	appendTo(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.
CharSequence	subSequence(int start, int end)
AttributedCharacterIterator	toCharacterIterator()	Exports the formatted number as an AttributedCharacterIterator.
String	toString()	Returns the formatted string as a Java String.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Method Detail

toString

public String toString()

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

Specified by:

toString in interface CharSequence

Specified by:

toString in interface FormattedValue

Overrides:

toString in class Object

Returns:

The formatted string.

Status:

Stable ICU 64.

length

public int length()

Specified by:

length in interface CharSequence

Status:

Stable ICU 64.

charAt

public char charAt(int index)

Specified by:

charAt in interface CharSequence

Status:

Stable ICU 64.

subSequence

public CharSequence subSequence(int start,
                                int end)

Specified by:

subSequence in interface CharSequence

Status:

Stable ICU 64.

appendTo

public <A extends 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 interface FormattedValue

Parameters:

appendable - The Appendable to which to append the string output.

Returns:

The same Appendable, for chaining.

Status:

Stable ICU 64.

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 interface FormattedValue

Parameters:

cfpos - The object used for iteration state. This can provide constraints to iterate over only one specific field; see ConstrainedFieldPosition.constrainField(java.text.Format.Field).

Returns:

true if a new occurrence of the field was found; false otherwise.

Status:

Stable ICU 64.

toCharacterIterator

public 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 interface FormattedValue

Returns:

An AttributedCharacterIterator containing full field information.

Status:

Stable ICU 64.