java.text
public final class StringCharacterIterator extends Object implements CharacterIterator
String
.
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.DONE
Constructor and Description |
---|
StringCharacterIterator(String text)
This method initializes a new instance of
StringCharacterIterator to iterate over the entire
text of the specified String . |
StringCharacterIterator(String text,
int index)
This method initializes a new instance of
StringCharacterIterator to iterate over the entire
text of the specified String . |
StringCharacterIterator(String text,
int begin,
int end,
int index)
This method initializes a new instance of
StringCharacterIterator that iterates over the text
in a subrange of the specified String . |
Modifier and Type | Method and Description |
---|---|
Object |
clone()
This method creates a copy of this
CharacterIterator . |
char |
current()
This method returns the character at the current index position
|
boolean |
equals(Object obj)
This method tests this object for equality againt the specified
object.
|
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.
|
int |
hashCode()
Return the hash code for this object.
|
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.
|
void |
setText(String text)
This method allows other classes in java.text to change the value
of the underlying text being iterated through.
|
public StringCharacterIterator(String text)
StringCharacterIterator
to iterate over the entire
text of the specified String
. The initial index
value will be set to the first character in the string.text
- The String
to iterate through (null
not permitted).NullPointerException
- if text
is null
.public StringCharacterIterator(String text, int index)
StringCharacterIterator
to iterate over the entire
text of the specified String
. The initial index
value will be set to the specified value.text
- The String
to iterate through.index
- The initial index position.public StringCharacterIterator(String text, int begin, int end, int index)
StringCharacterIterator
that iterates over the text
in a subrange of the specified String
. The
beginning and end of the range are specified by the caller, as is
the initial index position.text
- The String
to iterate through.begin
- The beginning position in the character range.end
- The ending position in the character range.index
- The initial index position.IllegalArgumentException
- If any of the range values are
invalid.public char current()
current
in interface CharacterIterator
public char next()
getEndIndex () - 1
, it will not be incremented.next
in interface CharacterIterator
DONE
if the index has reached
getEndIndex () - 1.public char previous()
previous
in interface CharacterIterator
DONE
if index was already equal to the
beginning index value.public char first()
first
in interface CharacterIterator
DONE
if the range is empty.public 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.last
in interface CharacterIterator
DONE
if the range is empty.public int getIndex()
getIndex
in interface CharacterIterator
public char setIndex(int index)
setIndex
in interface CharacterIterator
index
- The new index value.DONE
if the index value is equal to getEndIndex
.IllegalArgumentException
- If the specified index is not validpublic int getBeginIndex()
getBeginIndex
in interface CharacterIterator
public int getEndIndex()
getEndIndex
in interface CharacterIterator
public Object clone()
CharacterIterator
.clone
in interface CharacterIterator
clone
in class Object
CharacterIterator
.Cloneable
public boolean equals(Object obj)
null
.StringCharacterIterator
equals
in class Object
obj
- The object to test for equality against.true
if the specified object is equal to this
object, false
otherwise.Object.hashCode()
public int hashCode()
hashCode
in class Object
Object.equals(Object)
,
System.identityHashCode(Object)