com.ibm.icu.message2

Class FormattedMessage

java.lang.Object

com.ibm.icu.message2.FormattedMessage

All Implemented Interfaces:

FormattedValue, CharSequence

Deprecated.

This API is for ICU internal use only.

@Deprecated
public class FormattedMessage
extends Object
implements FormattedValue

Not yet implemented: The result of a message formatting operation.

This contains information about where the various fields and placeholders ended up in the final result.

This class allows the result to be exported in several data types, including a String, AttributedCharacterIterator, more (TBD).

Status:

Technology Preview. This API is still in the early stages of development. Use at your own risk.

Constructor Summary

Constructors

Constructor and Description
FormattedMessage() Deprecated. This API is for ICU internal use only.

Method Summary

Modifier and Type	Method and Description
<A extends Appendable> A	appendTo(A appendable) Deprecated. This API is for ICU internal use only.
char	charAt(int index) Deprecated. This API is for ICU internal use only.
int	length() Deprecated. This API is for ICU internal use only.
boolean	nextPosition(ConstrainedFieldPosition cfpos) Deprecated. This API is for ICU internal use only.
CharSequence	subSequence(int start, int end) Deprecated. This API is for ICU internal use only.
AttributedCharacterIterator	toCharacterIterator() Deprecated. This API is for ICU internal use only.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.icu.text.FormattedValue

toString

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Constructor Detail

FormattedMessage

@Deprecated
public FormattedMessage()

Deprecated. This API is for ICU internal use only.

Not yet implemented.

Status:

Technology Preview. This API is still in the early stages of development. Use at your own risk.

Method Detail

length

@Deprecated
public int length()

Deprecated. This API is for ICU internal use only.

Not yet implemented.

Specified by:

length in interface CharSequence

Status:

Technology Preview. This API is still in the early stages of development. Use at your own risk.

charAt

@Deprecated
public char charAt(int index)

Deprecated. This API is for ICU internal use only.

Not yet implemented.

Specified by:

charAt in interface CharSequence

Status:

Technology Preview. This API is still in the early stages of development. Use at your own risk.

subSequence

@Deprecated
public CharSequence subSequence(int start,
                                            int end)

Deprecated. This API is for ICU internal use only.

Not yet implemented.

Specified by:

subSequence in interface CharSequence

Status:

Technology Preview. This API is still in the early stages of development. Use at your own risk.

appendTo

@Deprecated
public <A extends Appendable> A appendTo(A appendable)

Deprecated. This API is for ICU internal use only.

Not yet implemented. 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:

Technology Preview. This API is still in the early stages of development. Use at your own risk.

nextPosition

@Deprecated
public boolean nextPosition(ConstrainedFieldPosition cfpos)

Deprecated. This API is for ICU internal use only.

Not yet implemented. 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:

Technology Preview. This API is still in the early stages of development. Use at your own risk.

toCharacterIterator

@Deprecated
public AttributedCharacterIterator toCharacterIterator()

Deprecated. This API is for ICU internal use only.

Not yet implemented. 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:

Technology Preview. This API is still in the early stages of development. Use at your own risk.