OpenJDK 27 · java.text.StringCharacterIterator · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private int	begin
private int	end
private int	pos
private String	text

Access	Constructor and Description
public	StringCharacterIterator(String the `String` to be iterated over text) Constructs an iterator with an initial index of 0.
public	StringCharacterIterator(String The String to be iterated over text, int Initial iterator position pos) Constructs an iterator with the specified initial index.
public	StringCharacterIterator(String The String to be iterated over text, int Index of the first character begin, int Index of the character following the last character end, int Initial iterator position pos) Constructs an iterator over the given range of the given string, with the index set at the specified position.

Method Summary

Modifier and Type	Method and Description
public Object	Returns: A copy of this clone() Overrides java.lang.Object.clone. Implements java.text.CharacterIterator.clone. Creates a copy of this iterator.
public char	current() Implements java.text.CharacterIterator.current. Implements CharacterIterator.current() for String.
public boolean	Returns: true if the given obj is the same as this StringCharacterIterator object; false otherwise. equals(Object the StringCharacterIterator object to be compared with. obj) Overrides java.lang.Object.equals. Compares the equality of two StringCharacterIterator objects.
public char	first() Implements java.text.CharacterIterator.first. Implements CharacterIterator.first() for String.
public int	getBeginIndex() Implements java.text.CharacterIterator.getBeginIndex. Implements CharacterIterator.getBeginIndex() for String.
public int	getEndIndex() Implements java.text.CharacterIterator.getEndIndex. Implements CharacterIterator.getEndIndex() for String.
public int	getIndex() Implements java.text.CharacterIterator.getIndex. Implements CharacterIterator.getIndex() for String.
public int	Returns: A hash code hashCode() Overrides java.lang.Object.hashCode. Computes a hashcode for this iterator.
public char	last() Implements java.text.CharacterIterator.last. Implements CharacterIterator.last() for String.
public char	next() Implements java.text.CharacterIterator.next. Implements CharacterIterator.next() for String.
public char	previous() Implements java.text.CharacterIterator.previous. Implements CharacterIterator.previous() for String.
public char	setIndex(int p) Implements java.text.CharacterIterator.setIndex. Implements CharacterIterator.setIndex() for String.
public void	setText(String The String to be iterated over text) Reset this iterator to point to a new string.

Inherited from java.lang.Object:: finalize getClass notify notifyAll toString wait wait wait

Field Detail

begin	back to summary
private int begin

end	back to summary
private int end

pos	back to summary
private int pos

text	back to summary
private String text

Constructor Detail

StringCharacterIterator back to summary

StringCharacterIterator	back to summary
public StringCharacterIterator(String text) Constructs an iterator with an initial index of 0. Parameters text:String the `String` to be iterated over

public StringCharacterIterator(String text)

Constructs an iterator with an initial index of 0.

Parameters

text:String: the String to be iterated over

StringCharacterIterator back to summary

StringCharacterIterator	back to summary
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 Exceptions IllegalArgumentException: if `pos` is not within the bounds of range (inclusive) from `0` to the length of `text`

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

Exceptions

IllegalArgumentException:: if pos is not within the bounds of range (inclusive) from 0 to the length of text

StringCharacterIterator back to summary

StringCharacterIterator	back to summary
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 Exceptions IllegalArgumentException: if `begin` and `end` are not within the bounds of range (inclusive) from `0` to the length of `text`, `begin` is greater than `end`, or `pos` is not within the bounds of range (inclusive) from `begin` to `end`

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

Exceptions

IllegalArgumentException:: if begin and end are not within the bounds of range (inclusive) from 0 to the length of text, begin is greater than end, or pos is not within the bounds of range (inclusive) from begin to end

Method Detail

clone	back to summary
public Object clone() Overrides java.lang.Object.clone. Implements java.text.CharacterIterator.clone. Creates a copy of this iterator. Returns:Object A copy of this

clone

back to summary

public Object clone()

Overrides java.lang.Object.clone.

Implements java.text.CharacterIterator.clone.

Creates a copy of this iterator.

Returns:Object: A copy of this

current back to summary

current	back to summary
public char current() Implements java.text.CharacterIterator.current. Implements CharacterIterator.current() for String. See Also `CharacterIterator#current`

public char current()

Implements java.text.CharacterIterator.current.

Implements CharacterIterator.current() for String.

See Also: CharacterIterator#current

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. 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.

equals

back to summary

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

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 back to summary

first	back to summary
public char first() Implements java.text.CharacterIterator.first. Implements CharacterIterator.first() for String. See Also `CharacterIterator#first`

public char first()

Implements java.text.CharacterIterator.first.

Implements CharacterIterator.first() for String.

See Also: CharacterIterator#first

getBeginIndex back to summary

getBeginIndex	back to summary
public int getBeginIndex() Implements java.text.CharacterIterator.getBeginIndex. Implements CharacterIterator.getBeginIndex() for String. See Also `CharacterIterator#getBeginIndex`

public int getBeginIndex()

Implements java.text.CharacterIterator.getBeginIndex.

Implements CharacterIterator.getBeginIndex() for String.

See Also: CharacterIterator#getBeginIndex

getEndIndex back to summary

getEndIndex	back to summary
public int getEndIndex() Implements java.text.CharacterIterator.getEndIndex. Implements CharacterIterator.getEndIndex() for String. See Also `CharacterIterator#getEndIndex`

public int getEndIndex()

Implements java.text.CharacterIterator.getEndIndex.

Implements CharacterIterator.getEndIndex() for String.

See Also: CharacterIterator#getEndIndex

getIndex back to summary

getIndex	back to summary
public int getIndex() Implements java.text.CharacterIterator.getIndex. Implements CharacterIterator.getIndex() for String. See Also `CharacterIterator#getIndex`

public int getIndex()

Implements java.text.CharacterIterator.getIndex.

Implements CharacterIterator.getIndex() for String.

See Also: CharacterIterator#getIndex

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Computes a hashcode for this iterator. Returns:int A hash code

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Computes a hashcode for this iterator.

Returns:int: A hash code

last back to summary

last	back to summary
public char last() Implements java.text.CharacterIterator.last. Implements CharacterIterator.last() for String. See Also `CharacterIterator#last`

public char last()

Implements java.text.CharacterIterator.last.

Implements CharacterIterator.last() for String.

See Also: CharacterIterator#last

next back to summary

next	back to summary
public char next() Implements java.text.CharacterIterator.next. Implements CharacterIterator.next() for String. See Also `CharacterIterator#next`

public char next()

Implements java.text.CharacterIterator.next.

Implements CharacterIterator.next() for String.

See Also: CharacterIterator#next

previous back to summary

previous	back to summary
public char previous() Implements java.text.CharacterIterator.previous. Implements CharacterIterator.previous() for String. See Also `CharacterIterator#previous`

public char previous()

Implements java.text.CharacterIterator.previous.

Implements CharacterIterator.previous() for String.

See Also: CharacterIterator#previous

setIndex back to summary

setIndex	back to summary
public char setIndex(int p) Implements java.text.CharacterIterator.setIndex. Implements CharacterIterator.setIndex() for String. Exceptions IllegalArgumentException: if `p` is not within the bounds (inclusive) of `getBeginIndex()` to `getEndIndex()` See Also `CharacterIterator#setIndex`

public char setIndex(int p)

Implements java.text.CharacterIterator.setIndex.

Implements CharacterIterator.setIndex() for String.

Exceptions

IllegalArgumentException:: if p is not within the bounds (inclusive) of getBeginIndex() to getEndIndex()

See Also

CharacterIterator#setIndex

setText back to summary

setText	back to summary
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 Exceptions NullPointerException: if `text` is `null` Since 1.2

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

Exceptions

NullPointerException:: if text is null

Since

1.2

public final Class StringCharacterIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail