Class RelativeDateTimeFormatter.FormattedRelativeDateTime

java.lang.Object
org.graalvm.shadowed.com.ibm.icu.text.RelativeDateTimeFormatter.FormattedRelativeDateTime
All Implemented Interfaces:
CharSequence, FormattedValue
Enclosing class:
RelativeDateTimeFormatter
public static class RelativeDateTimeFormatter.FormattedRelativeDateTime extends 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.

  • Method Details

    • 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.

    • length

      public int length()
      Specified by:
      length in interface CharSequence

    • charAt

      public char charAt(int index)
      Specified by:
      charAt in interface CharSequence

    • subSequence

      public CharSequence subSequence(int start, int end)
      Specified by:
      subSequence in interface CharSequence

    • 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.

    • 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(Format.Field).
      Returns:
      true if a new occurrence of the field was found; false otherwise.

    • toCharacterIterator

      public AttributedCharacterIterator toCharacterIterator()
      Exports the formatted number as an AttributedCharacterIterator.

      Consider using FormattedValue.nextPosition(ConstrainedFieldPosition) if you are trying to get field information.

      Specified by:
      toCharacterIterator in interface FormattedValue
      Returns:
      An AttributedCharacterIterator containing full field information.