java.text
Interface CharacterIterator

All Superinterfaces:

Cloneable

All Known Subinterfaces:

AttributedCharacterIterator

All Known Implementing Classes:

AttributedString.AttributedIterator, StringCharacterIterator

public interface CharacterIterator
extends Cloneable

CharacterIterator is used to sequence over a group of characters. The iteration starts at the begin index in the group of character and continues to one index before the end index.

Field Summary

static char

DONE A constant which indicates there is no character.

Method Summary

Object	clone() Returns a new CharacterIterator with the same properties.
char	current() Returns the character at the current index.
char	first() Sets the current position to the begin index and returns the character at the begin index.
int	getBeginIndex() Returns the begin index.
int	getEndIndex() Returns the end index.
int	getIndex() Returns the current index.
char	last() Sets the current position to the end index - 1 and returns the character at the current position.
char	next() Increments the current index and returns the character at the new index.
char	previous() Decrements the current index and returns the character at the new index.
char	setIndex(int location) Sets the current index.

Field Detail

DONE

static final char DONE

A constant which indicates there is no character.

See Also:

Constant Field Values

Method Detail

clone

Object clone()

Returns a new CharacterIterator with the same properties.

Returns:

a shallow copy of this CharacterIterator

See Also:

Cloneable

current

char current()

Returns the character at the current index.

Returns:

the current character, or DONE if the current index is past the end

first

char first()

Sets the current position to the begin index and returns the character at the begin index.

Returns:

the character at the begin index

getBeginIndex

int getBeginIndex()

Returns the begin index.

Returns:

the index of the first character to iterate

getEndIndex

int getEndIndex()

Returns the end index.

Returns:

the index one past the last character to iterate

getIndex

int getIndex()

Returns the current index.

Returns:

the current index

last

char last()

Sets the current position to the end index - 1 and returns the character at the current position.

Returns:

the character before the end index

next

char next()

Increments the current index and returns the character at the new index.

Returns:

the character at the next index, or DONE if the next index is past the end

previous

char previous()

Decrements the current index and returns the character at the new index.

Returns:

the character at the previous index, or DONE if the previous index is past the beginning

setIndex

char setIndex(int location)

Sets the current index.

Parameters:

location - The index the CharacterIterator is set to.

Returns:

the character at the new index, or DONE if the index is past the end

Throws:

IllegalArgumentException - when the new index is less than the begin index or greater than the end index