StringCharacterIterator

public final class StringCharacterIterator extends Object
implements CharacterIterator

StringCharacterIterator implements the CharacterIterator protocol for a String. The StringCharacterIterator class iterates over the entire String.

See Also

• CharacterIterator

Inherited Constant Summary

From interface java.text.CharacterIterator

char

DONE

Constant that is returned when the iterator has reached either the end or the beginning of the text.

Public Constructor Summary

	StringCharacterIterator(String text) Constructs an iterator with an initial index of 0.
	StringCharacterIterator(String text, int pos) Constructs an iterator with the specified initial index.
	StringCharacterIterator(String text, int begin, int end, int pos) Constructs an iterator over the given range of the given string, with the index set at the specified position.

Public Method Summary

Object	clone() Creates a copy of this iterator.
char	current() Implements CharacterIterator.current() for String.
boolean	equals(Object obj) Compares the equality of two StringCharacterIterator objects.
char	first() Implements CharacterIterator.first() for String.
int	getBeginIndex() Implements CharacterIterator.getBeginIndex() for String.
int	getEndIndex() Implements CharacterIterator.getEndIndex() for String.
int	getIndex() Implements CharacterIterator.getIndex() for String.
int	hashCode() Computes a hashcode for this iterator.
char	last() Implements CharacterIterator.last() for String.
char	next() Implements CharacterIterator.next() for String.
char	previous() Implements CharacterIterator.previous() for String.
char	setIndex(int p) Implements CharacterIterator.setIndex() for String.
void	setText(String text) Reset this iterator to point to a new string.

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

From interface java.text.CharacterIterator

abstract Object	clone() Create a copy of this iterator
abstract char	current() Gets the character at the current position (as returned by getIndex()).
abstract char	first() Sets the position to getBeginIndex() and returns the character at that position.
abstract int	getBeginIndex() Returns the start index of the text.
abstract int	getEndIndex() Returns the end index of the text.
abstract int	getIndex() Returns the current index.
abstract char	last() Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty) and returns the character at that position.
abstract char	next() Increments the iterator's index by one and returns the character at the new index.
abstract char	previous() Decrements the iterator's index by one and returns the character at the new index.
abstract char	setIndex(int position) Sets the position to the specified position in the text and returns that character.

Public Constructors

public StringCharacterIterator (String text)

Constructs an iterator with an initial index of 0.

Parameters

text	the String to be iterated over

public StringCharacterIterator (String text, int pos)

Constructs an iterator with the specified initial index.

Parameters

text	The String to be iterated over
pos	Initial iterator position

public StringCharacterIterator (String text, int begin, int end, int pos)

Constructs an iterator over the given range of the given string, with the index set at the specified position.

Parameters

text	The String to be iterated over
begin	Index of the first character
end	Index of the character following the last character
pos	Initial iterator position

Public Methods

public Object clone ()

Creates a copy of this iterator.

Returns

• A copy of this

public char current ()

Implements CharacterIterator.current() for String.

Returns

• the character at the current position or DONE if the current position is off the end of the text.

See Also

• CharacterIterator.current()

public boolean equals (Object obj)

Compares the equality of two StringCharacterIterator objects.

Parameters

obj	the StringCharacterIterator object to be compared with.

Returns

• true if the given obj is the same as this StringCharacterIterator object; false otherwise.

public char first ()

Implements CharacterIterator.first() for String.

Returns

• the first character in the text, or DONE if the text is empty

See Also

• CharacterIterator.first()

public int getBeginIndex ()

Implements CharacterIterator.getBeginIndex() for String.

Returns

• the index at which the text begins.

See Also

• CharacterIterator.getBeginIndex()

public int getEndIndex ()

Implements CharacterIterator.getEndIndex() for String.

Returns

• the index after the last character in the text

See Also

• CharacterIterator.getEndIndex()

public int getIndex ()

Implements CharacterIterator.getIndex() for String.

Returns

• the current index.

See Also

• CharacterIterator.getIndex()

public int hashCode ()

Computes a hashcode for this iterator.

Returns

• A hash code

public char last ()

Implements CharacterIterator.last() for String.

Returns

• the last character in the text, or DONE if the text is empty

See Also

• CharacterIterator.last()

public char next ()

Implements CharacterIterator.next() for String.

Returns

• the character at the new position or DONE if the new position is off the end of the text range.

See Also

• CharacterIterator.next()

public char previous ()

Implements CharacterIterator.previous() for String.

Returns

• the character at the new position or DONE if the current position is equal to getBeginIndex().

See Also

• CharacterIterator.previous()

public char setIndex (int p)

Implements CharacterIterator.setIndex() for String.

Parameters

p	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()

See Also

• CharacterIterator.setIndex(int)

public void setText (String text)

Reset this iterator to point to a new string. This package-visible method is used by other java.text classes that want to avoid allocating new StringCharacterIterator objects every time their setText method is called.

Parameters

text	The String to be iterated over