java.text
Class RuleBasedBreakIterator.SafeCharIterator

java.lang.Object
  java.text.RuleBasedBreakIterator.SafeCharIterator

All Implemented Interfaces:

CharacterIterator, Cloneable

Enclosing class:

RuleBasedBreakIterator

private static final class RuleBasedBreakIterator.SafeCharIterator

extends Object

implements CharacterIterator, Cloneable

Field Summary

private CharacterIterator	base
private int	currentIndex
private int	rangeLimit
private int	rangeStart

Fields inherited from interface java.text.CharacterIterator

DONE

Constructor Summary

(package private)

RuleBasedBreakIterator.SafeCharIterator(CharacterIterator base)

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.
char	setIndex(int i) 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

base

private CharacterIterator base

rangeStart

private int rangeStart

rangeLimit

private int rangeLimit

currentIndex

private int currentIndex

Constructor Detail

RuleBasedBreakIterator.SafeCharIterator

RuleBasedBreakIterator.SafeCharIterator(CharacterIterator base)

Method Detail

first

public char first()

Description copied from interface: CharacterIterator

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:

CharacterIterator.getBeginIndex()

last

public char last()

Description copied from interface: CharacterIterator

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:

CharacterIterator.getEndIndex()

current

public char current()

Description copied from interface: CharacterIterator

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:

CharacterIterator.getIndex()

next

public char next()

Description copied from interface: CharacterIterator

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

Description copied from interface: CharacterIterator

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 i)

Description copied from interface: CharacterIterator

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

Specified by:

setIndex in interface CharacterIterator

Parameters:

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

Description copied from interface: CharacterIterator

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

Description copied from interface: CharacterIterator

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

Description copied from interface: CharacterIterator

Returns the current index.

Specified by:

getIndex in interface CharacterIterator

Returns:

the current index.

clone

public Object clone()

Description copied from interface: CharacterIterator

Create a copy of this iterator

Specified by:

clone in interface CharacterIterator

Overrides:

clone in class Object

Returns:

a clone of this instance.

See Also:

Cloneable