Package com.ibm.icu.impl
Class UCharacterIteratorWrapper
java.lang.Object
com.ibm.icu.impl.UCharacterIteratorWrapper
- All Implemented Interfaces:
Cloneable
,CharacterIterator
This class is a wrapper around UCharacterIterator and implements the
CharacterIterator protocol
-
Field Summary
FieldsFields inherited from interface java.text.CharacterIterator
DONE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Create a copy of this iteratorchar
current()
Gets the character at the current position (as returned by getIndex()).char
first()
Sets the position to getBeginIndex() and returns the character at that position.int
Returns the start index of the text.int
Returns the end index of the text.int
getIndex()
Returns the current index.char
last()
Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty) and returns the character at that position.char
next()
Increments the iterator's index by one and returns the character at the new index.char
previous()
Decrements the iterator's index by one and returns the character at the new index.char
setIndex
(int position) Sets the position to the specified position in the text and returns that character.
-
Field Details
-
iterator
-
-
Constructor Details
-
UCharacterIteratorWrapper
-
-
Method Details
-
first
public char first()Sets the position to getBeginIndex() and returns the character at that position.- Specified by:
first
in interfaceCharacterIterator
- Returns:
- the first character in the text, or DONE if the text is empty
- See Also:
-
last
public char last()Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty) and returns the character at that position.- Specified by:
last
in interfaceCharacterIterator
- Returns:
- the last character in the text, or DONE if the text is empty
- See Also:
-
current
public char current()Gets the character at the current position (as returned by getIndex()).- Specified by:
current
in interfaceCharacterIterator
- Returns:
- the character at the current position or DONE if the current position is off the end of the text.
- See Also:
-
next
public char next()Increments the iterator's index by one and returns the character at the new index. If the resulting index is greater or equal to getEndIndex(), the current index is reset to getEndIndex() and a value of DONE is returned.- Specified by:
next
in interfaceCharacterIterator
- Returns:
- the character at the new position or DONE if the new position is off the end of the text range.
-
previous
public char previous()Decrements the iterator's index by one and returns the character at the new index. If the current index is getBeginIndex(), the index remains at getBeginIndex() and a value of DONE is returned.- Specified by:
previous
in interfaceCharacterIterator
- Returns:
- the character at the new position or DONE if the current position is equal to getBeginIndex().
-
setIndex
public char setIndex(int position) Sets the position to the specified position in the text and returns that character.- Specified by:
setIndex
in interfaceCharacterIterator
- Parameters:
position
- the position within the text. Valid values range from getBeginIndex() to getEndIndex(). An IllegalArgumentException is thrown if an invalid value is supplied.- Returns:
- the character at the specified position or DONE if the specified position is equal to getEndIndex()
-
getBeginIndex
public int getBeginIndex()Returns the start index of the text.- Specified by:
getBeginIndex
in interfaceCharacterIterator
- Returns:
- the index at which the text begins.
-
getEndIndex
public int getEndIndex()Returns the end index of the text. This index is the index of the first character following the end of the text.- Specified by:
getEndIndex
in interfaceCharacterIterator
- Returns:
- the index after the last character in the text
-
getIndex
public int getIndex()Returns the current index.- Specified by:
getIndex
in interfaceCharacterIterator
- Returns:
- the current index.
-
clone
Create a copy of this iterator- Specified by:
clone
in interfaceCharacterIterator
- Overrides:
clone
in classObject
- Returns:
- A copy of this
-