java.text
Class StringCharacterIterator
java.lang.Object
|
+--java.text.StringCharacterIterator
All Implemented Interfaces:
CharacterIterator
This class iterates over a range of characters in a 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.
Authors:- Aaron M. Renn (arenn@urbanophile.com)
- Tom Tromey <tromey@cygnus.com>
StringCharacterIterator
public StringCharacterIterator(java.lang.String text)
This method initializes a new instance of
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.
Parameters:
StringCharacterIterator
public StringCharacterIterator(java.lang.String text, int index)
This method initializes a new instance of
StringCharacterIterator
to iterate over the entire
text of the specified String
. The initial index
value will be set to the specified value.
Parameters:
StringCharacterIterator
public StringCharacterIterator(java.lang.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
. The
beginning and end of the range are specified by the caller, as is
the initial index position.
Parameters:
clone
public Object clone()
This method creates a copy of this CharacterIterator
.
Returns:
- A copy of this
CharacterIterator
.
current
public char current()
This method returns the character at the current index position
Returns:
- The character at the current index position.
equals
public boolean equals(java.lang.Object obj)
This method tests this object for equality againt the specified
object. This will be true if and only if the specified object:
- is not
null
.
- is an instance of
StringCharacterIterator
- has the same text as this object
- has the same beginning, ending, and current index as this object.
Parameters:
Returns:
true
if the specified object is equal to this
object, false
otherwise.
first
public char first()
This method sets the index value to the beginning of the range and returns
the character there.
Returns:
- The character at the beginning of the range, or
DONE
if the range is empty.
getBeginIndex
public int getBeginIndex()
This method returns the character position of the first character in the
range.
Returns:
- The index of the first character in the range.
getEndIndex
public int getEndIndex()
This method returns the character position of the end of the text range.
This will actually be the index of the first character following the
end of the range. In the event the text range is empty, this will be
equal to the first character in the range.
Returns:
- The index of the end of the range.
getIndex
public int getIndex()
This method returns the current value of the index.
Returns:
last
public char last()
This method sets the index value to getEndIndex () - 1
and
returns the character there. If the range is empty, then the index value
will be set equal to the beginning index.
Returns:
- The character at the end of the range, or
DONE
if the range is empty.
next
public char next()
This method increments the current index and then returns the
character at the new index value. If the index is already at
getEndIndex () - 1
, it will not be incremented.
Returns:
- The character at the position of the incremented index
value, or
DONE
if the index has reached
getEndIndex () - 1.
previous
public char previous()
This method decrements the current index and then returns the
character at the new index value. If the index value is already
at the beginning index, it will not be decremented.
Returns:
- The character at the position of the decremented index
value, or
DONE
if index was already equal to the
beginning index value.
setIndex
public char setIndex(int index)
This method sets the value of the index to the specified value, then
returns the character at that position.
Parameters:
Returns:
- The character at the new index value or
DONE
if the index value is equal to getEndIndex
.
Throws:
setText
public void setText(java.lang.String text)
This method allows other classes in java.text to change the value
of the underlying text being iterated through.
Parameters:
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.