Method Detail

• toString

  String toString()

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

  Specified by:

  toString in interface CharSequence

  Overrides:

  toString in class Object

  Returns:

  The formatted string.

  Status:

  Stable ICU 64.

• appendTo

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

  Parameters:

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

  Returns:

  The same Appendable, for chaining.

  Throws:

  ICUUncheckedIOException - if the Appendable throws IOException

  Status:

  Stable ICU 64.

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

       ConstrainedFieldPosition cfpos = new ConstrainedFieldPosition();
       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; 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

  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.

  Status:

  Stable ICU 64.