com.ibm.icu.message2

Class PlainStringFormattedValue

java.lang.Object

com.ibm.icu.message2.PlainStringFormattedValue

All Implemented Interfaces:

FormattedValue, CharSequence

Deprecated.

This API is for unit testing only.

@Deprecated
public class PlainStringFormattedValue
extends Object
implements FormattedValue

Very-very rough implementation of FormattedValue, packaging a string. Expect it to change.

Status:

Internal. This API is ICU internal only.

Constructor Summary

Constructors

Constructor and Description
PlainStringFormattedValue(String value) Deprecated. This API is for unit testing only.

Method Summary

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

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

Constructor Detail

PlainStringFormattedValue

@Deprecated
public PlainStringFormattedValue(String value)

Deprecated. This API is for unit testing only.

Constructor, taking the string to store.

Parameters:

value - the string value to store

Status:

Internal. This API is ICU internal only.

Method Detail

length

@Deprecated
public int length()

Deprecated. This API is for unit testing only.

Specified by:

length in interface CharSequence

Status:

Internal. This API is ICU internal only.

charAt

@Deprecated
public char charAt(int index)

Deprecated. This API is for unit testing only.

Specified by:

charAt in interface CharSequence

Status:

Internal. This API is ICU internal only.

subSequence

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

Deprecated. This API is for unit testing only.

Specified by:

subSequence in interface CharSequence

Status:

Internal. This API is ICU internal only.

appendTo

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

Deprecated. This API is for unit testing only.

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:

Internal. This API is ICU internal only.

nextPosition

@Deprecated
public boolean nextPosition(ConstrainedFieldPosition cfpos)

Deprecated. This API is for unit testing 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:

Internal. This API is ICU internal only.

toCharacterIterator

@Deprecated
public AttributedCharacterIterator toCharacterIterator()

Deprecated. This API is for unit testing 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:

Internal. This API is ICU internal only.

toString

@Deprecated
public String toString()

Deprecated. This API is for unit testing only.

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

Specified by:

toString in interface FormattedValue

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

Returns:

The formatted string.

Status:

Internal. This API is ICU internal only.