Package com.ibm.icu.text

Class DateIntervalFormat.FormattedDateInterval

  • All Implemented Interfaces:
    FormattedValue, java.lang.CharSequence
    Enclosing class:
    DateIntervalFormat
    public static final class DateIntervalFormat.FormattedDateInterval
extends java.lang.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.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      <A extends java.lang.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.
      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.

      • 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 java.lang.String toString()
        Returns the formatted string as a Java String. Consider using FormattedValue.appendTo(A) for greater efficiency.
        Specified by:
        toString in interface java.lang.CharSequence
        Specified by:
        toString in interface FormattedValue
        Overrides:
        toString in class java.lang.Object
        Returns:
        The formatted string.

      • length

        public int length()
        Specified by:
        length in interface java.lang.CharSequence

      • charAt

        public char charAt​(int index)
        Specified by:
        charAt in interface java.lang.CharSequence

      • subSequence

        public java.lang.CharSequence subSequence​(int start,
                                          int end)
        Specified by:
        subSequence in interface java.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 interface FormattedValue
        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: 
             ConstrainableFieldPosition cfpos = new ConstrainableFieldPosition();
     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.