java.text
Class CollationElementIterator
java.lang.Object
|
+--java.text.CollationElementIterator
public final class
CollationElementIteratorextends
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
.
Author:- Aaron M. Renn (arenn@urbanophile.com)
NULLORDER
public static final int NULLORDER
This is a constant value that is returned to indicate that the end of
the string was encountered.
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:
getOffset
public int getOffset()
This method returns the current offset into the String
that is being iterated over.
Returns:
- The iteration index position.
next
public int next()
This method returns the collation ordering value of the next character
in the string. This method will return NULLORDER
if the
end of the string was reached.
Returns:
- The collation ordering value.
previous
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 final int primaryOrder(int order)
This method returns the primary order value for the given collation
value.
Parameters:
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 final short secondaryOrder(int order)
This method returns the secondary order value for the given collation
value.
Parameters:
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:
Throws:
setText
public void setText(java.lang.String str)
This method sets the String
that it is iterating over
to the specified String
.
Parameters:
setText
public void setText(java.text.CharacterIterator ci)
This method sets the String
that it is iterating over
to the String
represented by the specified
CharacterIterator
.
Parameters:
tertiaryOrder
public static final short tertiaryOrder(int order)
This method returns the tertiary order value for the given collation
value.
Parameters:
Returns:
- The tertiary order value of the specified collation value. This is the low eight bits.
String
as defined by the collation rules in an instance ofRuleBasedCollator
. There is no public constructor for this class. An instance is created by calling thegetCollationElementIterator
method onRuleBasedCollator
.