public final class java.text.CollationElementIterator extends java.lang.Object
see also: java.text.Collator, java.text.RuleBasedCollator
methods: getMaxExpansion(int order), getOffset(), next(), previous(), primaryOrder(int order), reset(), secondaryOrder(int order), setOffset(int newOffset), setText(CharacterIterator source), setText(String source), tertiaryOrder(int order)
The CollationElementIterator class is used as an iterator to walk through each character of an international string. Use the iterator to return the ordering priority of the positioned character. The ordering priority of a character, which we refer to as a key, defines how a character is collated in the given collation object.
For example, consider the following in Spanish:
"ca" -> the first key is key('c') and second key is key('a').
"cha" -> the first key is key('ch') and second key is key('a').
And in German,
"äb"-> the first key is key('a'), the second key is key('e'), and
the third key is key('b').
The key of a character is an integer composed of primary order(short), secondary order(byte), and tertiary order(byte). Java strictly defines the size and signedness of its primitive data types. Therefore, the static functions primaryOrder, secondaryOrder, and tertiaryOrder return int, short, and short respectively to ensure the correctness of the key value.
Example of the iterator usage,
// get the first key of the string
String str = "This is a test";
CollationElementIterator c =
new CollationElementIterator(str, 0, str.length(),
int primaryOrder = CollationElementIterator.primaryOrder(c->next());
CollationElementIterator.next returns the collation order of the next character. A collation order consists of primary order, secondary order and tertiary order. The data type of the collation order is int. The first 16 bits of a collation order is its primary order; the next 8 bits is the secondary order and the last 8 bits is the tertiary order.
source: Sun's Java documentation for JDK 1.3
Sun Microsystems: www.sun.com | Sun's Java: java.sun.com | JDK 1.3 API docs: http://java.sun.com/j2se/1.3/docs/api/index.html