API Overview API Index Package Overview Direct link to this page
JDK 1.6
  java.text. CollationElementIterator View Source
Author(s)
Helena Shih, Laura Werner, Richard Gillam
Since
Version
1.24 07/27/98
Serial
Hierarchy
 Object
      CollationElementIterator
Implements
Subclasses
Description
publicfinal class CollationElementIterator
  The CollationElementIterator class is used as an iterator to walk through each character of an international string.
See also:    Collator RuleBasedCollator
Constructors
pack-private CollationElementIterator (CharacterIterator sourceText, RuleBasedCollator owner)
  CollationElementIterator constructor.
pack-private CollationElementIterator (String sourceText, RuleBasedCollator owner)
  CollationElementIterator constructor.
Methods
Hide/Show inherited methods
public int getMaxExpansion (int order)
  Return the maximum length of any expansion sequences that end with the specified comparison order.
public int getOffset ()
  Returns the character offset in the original text corresponding to the next collation element.
pack-privatefinalstatic boolean isIgnorable (int order)
  Check if a comparison order is ignorable.
public int next ()
  Get the next collation element in the string.
public int previous ()
  Get the previous collation element in the string.
publicfinalstatic int primaryOrder (int order)
  Return the primary component of a collation element.
public void reset ()
  Resets the cursor to the beginning of the string.
publicfinalstatic short secondaryOrder (int order)
  Return the secondary component of a collation element.
public void setOffset (int newOffset)
  Sets the iterator to point to the collation element corresponding to the specified character (the parameter is a CHARACTER offset in the original string, not an offset into its corresponding sequence of collation elements).
public void setText (CharacterIterator source)
  Set a new string over which to iterate.
public void setText (String source)
  Set a new string over which to iterate.
pack-privatefinal int strengthOrder (int order)
  Get the comparison order in the desired strength.
publicfinalstatic short tertiaryOrder (int order)
  Return the tertiary component of a collation element.
Fields
Hide/Show inherited fields
publicfinalstatic int NULLORDER = "-1"
Null order which indicates the end of string is reached by the cursor.
pack-privatefinalstatic int UNMAPPEDCHARVALUE = "2147418112"
Nested Classes
Generated By: JavaOnTracks Doclet 0.1.4     ©Thibaut Colar