java.awt.font
Class CharArrayIterator

java.lang.Object
  java.awt.font.CharArrayIterator

All Implemented Interfaces:

CharacterIterator, Cloneable

class CharArrayIterator

extends Object

implements CharacterIterator

Field Summary

private int	begin
private char[]	chars
private int	pos

Fields inherited from interface java.text.CharacterIterator

DONE

Constructor Summary

(package private)	CharArrayIterator(char[] chars)
(package private)	CharArrayIterator(char[] chars, int begin)

Method Summary

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

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

chars

private char[] chars

pos

private int pos

begin

private int begin

Constructor Detail

CharArrayIterator

CharArrayIterator(char[] chars)

CharArrayIterator

CharArrayIterator(char[] chars,
                  int begin)

Method Detail

first

public char first()

Sets the position to getBeginIndex() and returns the character at that position.

Specified by:

first in interface CharacterIterator

Returns:

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

See Also:

getBeginIndex

last

public char last()

Sets the position to getEndIndex()-1 (getEndIndex() if the text is empty) and returns the character at that position.

Specified by:

last in interface CharacterIterator

Returns:

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

See Also:

getEndIndex

current

public char current()

Gets the character at the current position (as returned by getIndex()).

Specified by:

current in interface CharacterIterator

Returns:

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

See Also:

getIndex

next

public char next()

Increments the iterator's index by one and returns the character at the new index. If the resulting index is greater or equal to getEndIndex(), the current index is reset to getEndIndex() and a value of DONE is returned.

Specified by:

next in interface CharacterIterator

Returns:

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

previous

public char previous()

Decrements the iterator's index by one and returns the character at the new index. If the current index is getBeginIndex(), the index remains at getBeginIndex() and a value of DONE is returned.

Specified by:

previous in interface CharacterIterator

Returns:

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

setIndex

public char setIndex(int position)

Sets the position to the specified position in the text and returns that character.

Specified by:

setIndex in interface CharacterIterator

Parameters:

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

getBeginIndex

public int getBeginIndex()

Returns the start index of the text.

Specified by:

getBeginIndex in interface CharacterIterator

Returns:

the index at which the text begins.

getEndIndex

public int getEndIndex()

Returns the end index of the text. This index is the index of the first character following the end of the text.

Specified by:

getEndIndex in interface CharacterIterator

Returns:

the index after the last character in the text

getIndex

public int getIndex()

Returns the current index.

Specified by:

getIndex in interface CharacterIterator

Returns:

the current index.

clone

public Object clone()

Create a copy of this iterator

Specified by:

clone in interface CharacterIterator

Overrides:

clone in class Object

Returns:

A copy of this

See Also:

Cloneable

reset

void reset(char[] chars)

reset

void reset(char[] chars,
           int begin)