Index (Frames) | Index (No Frames) | Package | Package Tree | Tree
java.text

Class StringCharacterIterator

java.lang.Object
|
+--java.text.StringCharacterIterator

All Implemented Interfaces:

CharacterIterator


public final class StringCharacterIterator

extends Object

implements CharacterIterator

This class iterates over a range of characters in a String. For a given range of text, a beginning and ending index, as well as a current index are defined. These values can be queried by the methods in this interface. Additionally, various methods allow the index to be set.

Authors:

Constructor Summary

StringCharacterIterator(java.lang.String text)

This method initializes a new instance of StringCharacterIterator to iterate over the entire text of the specified String.
StringCharacterIterator(java.lang.String text, int index)

This method initializes a new instance of StringCharacterIterator to iterate over the entire text of the specified String.
StringCharacterIterator(java.lang.String text, int begin, int end, int index)

This method initializes a new instance of StringCharacterIterator that iterates over the text in a subrange of the specified String.

Method Summary

java.lang.Objectclone()

This method creates a copy of this CharacterIterator.
charcurrent()

This method returns the character at the current index position
booleanequals(java.lang.Object obj)

This method tests this object for equality againt the specified object.
charfirst()

This method sets the index value to the beginning of the range and returns the character there.
intgetBeginIndex()

This method returns the character position of the first character in the range.
intgetEndIndex()

This method returns the character position of the end of the text range.
intgetIndex()

This method returns the current value of the index.
charlast()

This method sets the index value to getEndIndex () - 1 and returns the character there.
charnext()

This method increments the current index and then returns the character at the new index value.
charprevious()

This method decrements the current index and then returns the character at the new index value.
charsetIndex(int index)

This method sets the value of the index to the specified value, then returns the character at that position.
voidsetText(java.lang.String text)

This method allows other classes in java.text to change the value of the underlying text being iterated through.

Constructor Details

StringCharacterIterator

public StringCharacterIterator(java.lang.String text)

This method initializes a new instance of StringCharacterIterator to iterate over the entire text of the specified String. The initial index value will be set to the first character in the string.

Parameters:


StringCharacterIterator

public StringCharacterIterator(java.lang.String text, int index)

This method initializes a new instance of StringCharacterIterator to iterate over the entire text of the specified String. The initial index value will be set to the specified value.

Parameters:


StringCharacterIterator

public StringCharacterIterator(java.lang.String text, int begin, int end, int index)

This method initializes a new instance of StringCharacterIterator that iterates over the text in a subrange of the specified String. The beginning and end of the range are specified by the caller, as is the initial index position.

Parameters:


Method Details

clone

public Object clone()

This method creates a copy of this CharacterIterator.

Returns:


current

public char current()

This method returns the character at the current index position

Returns:


equals

public boolean equals(java.lang.Object obj)

This method tests this object for equality againt the specified object. This will be true if and only if the specified object:

Parameters:

Returns:


first

public char first()

This method sets the index value to the beginning of the range and returns the character there.

Returns:


getBeginIndex

public int getBeginIndex()

This method returns the character position of the first character in the range.

Returns:


getEndIndex

public int getEndIndex()

This method returns the character position of the end of the text range. This will actually be the index of the first character following the end of the range. In the event the text range is empty, this will be equal to the first character in the range.

Returns:


getIndex

public int getIndex()

This method returns the current value of the index.

Returns:


last

public char last()

This method sets the index value to getEndIndex () - 1 and returns the character there. If the range is empty, then the index value will be set equal to the beginning index.

Returns:


next

public char next()

This method increments the current index and then returns the character at the new index value. If the index is already at getEndIndex () - 1, it will not be incremented.

Returns:


previous

public char previous()

This method decrements the current index and then returns the character at the new index value. If the index value is already at the beginning index, it will not be decremented.

Returns:


setIndex

public char setIndex(int index)

This method sets the value of the index to the specified value, then returns the character at that position.

Parameters:

Returns:

Throws:


setText

public void setText(java.lang.String text)

This method allows other classes in java.text to change the value of the underlying text being iterated through.

Parameters: