|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CharacterIterator
This interface defines a mechanism for iterating over a range of characters. For a given range of text, a beginning and ending index, as well as a current index are defined. These values can be queried by the methods in this interface. Additionally, various methods allow the index to be set.
Field Summary | |
---|---|
static char |
DONE
This is a special constant value that is returned when the beginning or end of the character range has been reached. |
Method Summary | |
---|---|
Object |
clone()
This method creates a copy of this CharacterIterator . |
char |
current()
This method returns the character at the current index position |
char |
first()
This method sets the index value to the beginning of the range and returns the character there. |
int |
getBeginIndex()
This method returns the character position of the first character in the range. |
int |
getEndIndex()
This method returns the character position of the end of the text range. |
int |
getIndex()
This method returns the current value of the index. |
char |
last()
This method sets the index value to getEndIndex() - 1 and
returns the character there. |
char |
next()
This method increments the current index and then returns the character at the new index value. |
char |
previous()
This method decrements the current index and then returns the character at the new index value. |
char |
setIndex(int index)
This method sets the value of the index to the specified value, then returns the character at that position. |
Field Detail |
---|
static final char DONE
Method Detail |
---|
char current()
char next()
getEndIndex() - 1
, it will not be incremented.
DONE
if the index has reached getEndIndex() - 1char previous()
DONE
if index was already equal to the beginning index
value.char first()
DONE
if
the range is empty.char last()
getEndIndex() - 1
and
returns the character there. If the range is empty, then the index value
will be set equal to the beginning index.
DONE
if the
range is empty.int getIndex()
char setIndex(int index) throws IllegalArgumentException
index
- The new index value.
DONE
if the index
value is equal to getEndIndex()
.
IllegalArgumentException
int getBeginIndex()
int getEndIndex()
Object clone()
CharacterIterator
.
CharacterIterator
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |