| java.lang.Object | |
| ↳ | java.text.CollationElementIterator |
Created by a RuleBasedCollator to iterate through a string. The
result of each iteration is a 32-bit collation element that defines the
ordering priority of the next character or sequence of characters in the
source string.
For illustration, consider the following in Spanish:
"ca": the first collation element is collation_element('c') and second collation element is collation_element('a').
Since "ch" in Spanish sorts as one entity, the example below returns one collation element for the two characters 'c' and 'h':
"cha": the first collation element is collation_element('ch') and the second one is collation_element('a').
In German, since the character '\u0086' is a composed character of 'a' and 'e', the iterator returns two collation elements for the single character '\u0086':
"\u0086b": the first collation element is collation_element('a'), the second one is collation_element('e'), and the third collation element is collation_element('b').
Note that calls to next and previous can not be mixed.
To change iteration direction, reset, setOffset or setText
must be called to reset the iterator. If a change of direction is done without one
of these calls, the result is undefined.
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | NULLORDER |
This constant is returned by the iterator in the methods
next() and previous() when the end or the
beginning of the source string has been reached, and there are no more
valid collation elements to return.
|
|||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Returns the maximum length of any expansion sequence that ends with the
specified collation element.
| |||||||||||
Returns the character offset in the source string corresponding to the
next collation element.
| |||||||||||
Returns the next collation element in the source string or
NULLORDER if
the end of the iteration has been reached.
| |||||||||||
Returns the previous collation element in the source string or
NULLORDER if
the start of the iteration has been reached.
| |||||||||||
Returns the primary order of the specified collation element, i.e.
| |||||||||||
Repositions the cursor to point at the first element of the current
string.
| |||||||||||
Returns the secondary order of the specified collation element, i.e.
| |||||||||||
Points the iterator at the collation element associated with the
character in the source string which is found at the supplied offset.
| |||||||||||
Sets a new source string iterator for iteration, and resets the offset to
the beginning of the text.
| |||||||||||
Sets a new source string for iteration, and resets the offset to the
beginning of the text.
| |||||||||||
Returns the tertiary order of the specified collation element, i.e.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
This constant is returned by the iterator in the methods
next() and previous() when the end or the
beginning of the source string has been reached, and there are no more
valid collation elements to return.
Returns the maximum length of any expansion sequence that ends with the
specified collation element. Returns 1 if there is no expansion
with this collation element as the last element.
| order | a collation element that has been previously obtained from a
call to either the next() or previous()
method.
|
|---|
Returns the character offset in the source string corresponding to the next collation element. This value could be any of:
Developers
setOffset(offset) sets the index in the middle of a contraction,
getOffset() returns the index of the first character in the
contraction, which may not be equal to the original offset that was set.
Hence calling getOffset() immediately after
setOffset(offset) does not guarantee that the original offset set
will be returned.Returns the next collation element in the source string or NULLORDER if
the end of the iteration has been reached.
Returns the previous collation element in the source string or NULLORDER if
the start of the iteration has been reached.
Returns the primary order of the specified collation element, i.e. the first 16 bits. This value is unsigned.
| order | the element of the collation. |
|---|
Repositions the cursor to point at the first element of the current
string. The next call to next() or previous() will
return the first and last collation element in the string, respectively.
If the RuleBasedCollator used by this iterator has had its
attributes changed, calling reset() reinitializes the iterator to
use the new attributes.
Returns the secondary order of the specified collation element, i.e. the 16th to 23th bits, inclusive. This value is unsigned.
| order | the element of the collator. |
|---|
Points the iterator at the collation element associated with the
character in the source string which is found at the supplied offset.
After this call completes, an invocation of the next() method
will return this collation element.
If newOffset corresponds to a character which is part of a
sequence that maps to a single collation element then the iterator is
adjusted to the start of that sequence. As a result of this, any
subsequent call made to getOffset() may not return the same value
set by this method.
If the decomposition mode is on, and offset is in the middle of a decomposable range of source text, the iterator may not return a correct result for the next forwards or backwards iteration. The user must ensure that the offset is not in the middle of a decomposable range.
| newOffset | the character offset into the original source string to set. Note that this is not an offset into the corresponding sequence of collation elements. |
|---|
Sets a new source string iterator for iteration, and resets the offset to the beginning of the text.
| source | the new source string iterator for iteration. |
|---|
Sets a new source string for iteration, and resets the offset to the beginning of the text.
| source | the new source string for iteration. |
|---|
Returns the tertiary order of the specified collation element, i.e. the last 8 bits. This value is unsigned.
| order | the element of the collation. |
|---|