Added in API level 1

Summary: Inherited Constants | Ctors | Methods | Inherited Methods

StringCharacterIterator

public final class StringCharacterIterator
extends Object implements CharacterIterator

java.lang.Object
↳	java.text.StringCharacterIterator

---

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

See also:

• CharacterIterator

Summary

Inherited constants
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 constructors
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 methods
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 methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
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

StringCharacterIterator

Added in API level 1

public StringCharacterIterator (String text)

Constructs an iterator with an initial index of 0.

Parameters
text	String: the String to be iterated over

StringCharacterIterator

Added in API level 1

public StringCharacterIterator (String text, 
                int pos)

Constructs an iterator with the specified initial index.

Parameters
text	String: The String to be iterated over
pos	int: Initial iterator position

StringCharacterIterator

Added in API level 1

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	String: The String to be iterated over
begin	int: Index of the first character
end	int: Index of the character following the last character
pos	int: Initial iterator position

Public methods

clone

Added in API level 1

public Object clone ()

Creates a copy of this iterator.

Returns
Object	A copy of this

current

Added in API level 1

public char current ()

Implements CharacterIterator.current() for String.

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

See also:

• CharacterIterator.current()

equals

Added in API level 1

public boolean equals (Object obj)

Compares the equality of two StringCharacterIterator objects.

Parameters
obj	Object: the StringCharacterIterator object to be compared with.

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

first

Added in API level 1

public char first ()

Implements CharacterIterator.first() for String.

Returns
char	the first character in the text, or DONE if the text is empty

See also:

• CharacterIterator.first()

getBeginIndex

Added in API level 1

public int getBeginIndex ()

Implements CharacterIterator.getBeginIndex() for String.

Returns
int	the index at which the text begins.

See also:

• CharacterIterator.getBeginIndex()

getEndIndex

Added in API level 1

public int getEndIndex ()

Implements CharacterIterator.getEndIndex() for String.

Returns
int	the index after the last character in the text

See also:

• CharacterIterator.getEndIndex()

getIndex

Added in API level 1

public int getIndex ()

Implements CharacterIterator.getIndex() for String.

Returns
int	the current index.

See also:

• CharacterIterator.getIndex()

hashCode

Added in API level 1

public int hashCode ()

Computes a hashcode for this iterator.

Returns
int	A hash code

last

Added in API level 1

public char last ()

Implements CharacterIterator.last() for String.

Returns
char	the last character in the text, or DONE if the text is empty

See also:

• CharacterIterator.last()

next

Added in API level 1

public char next ()

Implements CharacterIterator.next() for String.

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

See also:

• CharacterIterator.next()

previous

Added in API level 1

public char previous ()

Implements CharacterIterator.previous() for String.

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

See also:

• CharacterIterator.previous()

setIndex

Added in API level 1

public char setIndex (int p)

Implements CharacterIterator.setIndex() for String.

Parameters
p	int: the position within the text. Valid values range from getBeginIndex() to getEndIndex(). An IllegalArgumentException is thrown if an invalid value is supplied.

Returns
char	the character at the specified position or DONE if the specified position is equal to getEndIndex()

See also:

• CharacterIterator.setIndex(int)

setText

Added in API level 1

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	String: The String to be iterated over