java.text

Class CollationElementIterator

public final class CollationElementIterator extends Object

This class walks through the character collation elements of a String as defined by the collation rules in an instance of RuleBasedCollator. There is no public constructor for this class. An instance is created by calling the getCollationElementIterator method on RuleBasedCollator.

Field Summary
static int	NULLORDER This is a constant value that is returned to indicate that the end of the string was encountered.

Method Summary
int	getMaxExpansion(int value) This method returns the maximum length of any expansion sequence that ends with the specified collation order value.
int	getOffset() This method returns the current offset into the `String` that is being iterated over.
int	next() This method returns the collation ordering value of the next character sequence in the string (it may be an extended character following collation rules).
int	previous() This method returns the collation ordering value of the previous character in the string.
static int	primaryOrder(int order) This method returns the primary order value for the given collation value.
void	reset() This method resets the internal position pointer to read from the beginning of the `String` again.
static short	secondaryOrder(int order) This method returns the secondary order value for the given collation value.
void	setOffset(int offset) This method sets the iteration index position into the current `String` to the specified value.
void	setText(String text) This method sets the `String` that it is iterating over to the specified `String`.
void	setText(CharacterIterator source) This method sets the `String` that it is iterating over to the `String` represented by the specified `CharacterIterator`.
static short	tertiaryOrder(int order) This method returns the tertiary order value for the given collation value.

Field Detail

NULLORDER

public static final int NULLORDER

This is a constant value that is returned to indicate that the end of the string was encountered.

Method Detail

getMaxExpansion

public int getMaxExpansion(int value)

This method returns the maximum length of any expansion sequence that ends with the specified collation order value. (Whatever that means).

Parameters: value The collation order value

Returns: The maximum length of an expansion sequence.

getOffset

public int getOffset()

This method returns the current offset into the String that is being iterated over.

Returns: The iteration index position.

Since: 1.2

public int next()

This method returns the collation ordering value of the next character sequence in the string (it may be an extended character following collation rules). This method will return NULLORDER if the end of the string was reached.

Returns: The collation ordering value.

public int previous()

This method returns the collation ordering value of the previous character in the string. This method will return NULLORDER if the beginning of the string was reached.

Returns: The collation ordering value.

primaryOrder

public static int primaryOrder(int order)

This method returns the primary order value for the given collation value.

Parameters: order The collation value returned from next() or previous().

Returns: The primary order value of the specified collation value. This is the high 16 bits.

reset

public void reset()

This method resets the internal position pointer to read from the beginning of the String again.

secondaryOrder

public static short secondaryOrder(int order)

This method returns the secondary order value for the given collation value.

Parameters: order The collation value returned from next() or previous().

Returns: The secondary order value of the specified collation value. This is the bits 8-15.

setOffset

public void setOffset(int offset)

This method sets the iteration index position into the current String to the specified value. This value must not be negative and must not be greater than the last index position in the String.

Parameters: offset The new iteration index position.

Throws: IllegalArgumentException If the new offset is not valid.

setText

public void setText(String text)

This method sets the String that it is iterating over to the specified String.

Parameters: text The new String to iterate over.

Since: 1.2

setText

public void setText(CharacterIterator source)

This method sets the String that it is iterating over to the String represented by the specified CharacterIterator.

Parameters: source The CharacterIterator containing the new String to iterate over.

tertiaryOrder

public static short tertiaryOrder(int order)

This method returns the tertiary order value for the given collation value.

Parameters: order The collation value returned from next() or previous().

Returns: The tertiary order value of the specified collation value. This is the low eight bits.