java.text
public
interface
java.text.CharacterIterator
CharacterIterator is used to sequence over a group of characters. The
iteration starts at the begin index in the group of character and continues
to one index before the end index.
Known Indirect Subclasses
Summary
Constants
|
|
|
Value |
|
char |
DONE |
A constant which indicates there is no character. |
65535 |
0x0000ffff |
Public Methods
Details
Constants
public
static
final
char
DONE
A constant which indicates there is no character.
Constant Value:
65535
(0x0000ffff)
Public Methods
public
Object
clone()
Returns a new CharacterIterator with the same properties.
Returns
- a shallow copy of this CharacterIterator
public
char
current()
Returns the character at the current index.
Returns
- the current character, or DONE if the current index is past the
end
public
char
first()
Sets the current position to the begin index and returns the character at
the begin index.
Returns
- the character at the begin index
public
int
getBeginIndex()
Returns the begin index.
Returns
- the index of the first character to iterate
public
int
getEndIndex()
Returns the end index.
Returns
- the index one past the last character to iterate
public
int
getIndex()
Returns the current index.
public
char
last()
Sets the current position to the end index - 1 and returns the character
at the current position.
Returns
- the character before the end index
public
char
next()
Increments the current index and returns the character at the new index.
Returns
- the character at the next index, or DONE if the next index is
past the end
public
char
previous()
Decrements the current index and returns the character at the new index.
Returns
- the character at the previous index, or DONE if the previous
index is past the beginning
public
char
setIndex(int location)
Sets the current index.
Parameters
location
| The index the CharacterIterator is set to. |
Returns
- the character at the new index, or DONE if the index is past the
end