StringCharacterIterator (Java SE 15 & JDK 15) (original) (raw)
All Implemented Interfaces:
[Cloneable](../lang/Cloneable.html "interface in java.lang")
, [CharacterIterator](CharacterIterator.html "interface in java.text")
public final class StringCharacterIterator extends Object implements CharacterIterator
StringCharacterIterator
implements theCharacterIterator
protocol for a String
. The StringCharacterIterator
class iterates over the entire String
.
Since:
1.1
See Also:
Field Summary
Constructor Summary
Constructors
Constructor | Description |
---|---|
StringCharacterIterator(String text) | Constructs an iterator with an initial index of 0. |
StringCharacterIterator(String text, int pos) | Constructs an iterator with the specified initial index. |
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. |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
Object | clone() | Creates a copy of this iterator. |
char | current() | Implements CharacterIterator.current() for String. |
boolean | equals(Object obj) | Compares the equality of two StringCharacterIterator objects. |
char | first() | Implements CharacterIterator.first() for String. |
int | getBeginIndex() | Implements CharacterIterator.getBeginIndex() for String. |
int | getEndIndex() | Implements CharacterIterator.getEndIndex() for String. |
int | getIndex() | Implements CharacterIterator.getIndex() for String. |
int | hashCode() | Computes a hashcode for this iterator. |
char | last() | Implements CharacterIterator.last() for String. |
char | next() | Implements CharacterIterator.next() for String. |
char | previous() | Implements CharacterIterator.previous() for String. |
char | setIndex(int p) | Implements CharacterIterator.setIndex() for String. |
void | setText(String text) | Reset this iterator to point to a new string. |
Constructor Details
StringCharacterIterator
public StringCharacterIterator(String text)
Constructs an iterator with an initial index of 0.
Parameters:
text
- theString
to be iterated overStringCharacterIterator
public StringCharacterIterator(String text, int pos)
Constructs an iterator with the specified initial index.
Parameters:
text
- The String to be iterated over
pos
- Initial iterator positionStringCharacterIterator
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
- The String to be iterated over
begin
- Index of the first character
end
- Index of the character following the last character
pos
- Initial iterator positionMethod Details
setText
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
- The String to be iterated over
Since:
1.2first
public char first()
Implements CharacterIterator.first() for String.
Specified by:
[first](CharacterIterator.html#first%28%29)
in interface[CharacterIterator](CharacterIterator.html "interface in java.text")
Returns:
the first character in the text, or DONE if the text is empty
See Also:
CharacterIterator.first()last
public char last()
Implements CharacterIterator.last() for String.
Specified by:
[last](CharacterIterator.html#last%28%29)
in interface[CharacterIterator](CharacterIterator.html "interface in java.text")
Returns:
the last character in the text, or DONE if the text is empty
See Also:
CharacterIterator.last()setIndex
public char setIndex(int p)
Implements CharacterIterator.setIndex() for String.
Specified by:
[setIndex](CharacterIterator.html#setIndex%28int%29)
in interface[CharacterIterator](CharacterIterator.html "interface in java.text")
Parameters:
p
- 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()
See Also:
CharacterIterator.setIndex(int)current
public char current()
Implements CharacterIterator.current() for String.
Specified by:
[current](CharacterIterator.html#current%28%29)
in interface[CharacterIterator](CharacterIterator.html "interface in java.text")
Returns:
the character at the current position or DONE if the current position is off the end of the text.
See Also:
CharacterIterator.current()next
public char next()
Implements CharacterIterator.next() for String.
Specified by:
[next](CharacterIterator.html#next%28%29)
in interface[CharacterIterator](CharacterIterator.html "interface in java.text")
Returns:
the character at the new position or DONE if the new position is off the end of the text range.
See Also:
CharacterIterator.next()previous
public char previous()
Implements CharacterIterator.previous() for String.
Specified by:
[previous](CharacterIterator.html#previous%28%29)
in interface[CharacterIterator](CharacterIterator.html "interface in java.text")
Returns:
the character at the new position or DONE if the current position is equal to getBeginIndex().
See Also:
CharacterIterator.previous()getBeginIndex
public int getBeginIndex()
Implements CharacterIterator.getBeginIndex() for String.
Specified by:
[getBeginIndex](CharacterIterator.html#getBeginIndex%28%29)
in interface[CharacterIterator](CharacterIterator.html "interface in java.text")
Returns:
the index at which the text begins.
See Also:
CharacterIterator.getBeginIndex()getEndIndex
public int getEndIndex()
Implements CharacterIterator.getEndIndex() for String.
Specified by:
[getEndIndex](CharacterIterator.html#getEndIndex%28%29)
in interface[CharacterIterator](CharacterIterator.html "interface in java.text")
Returns:
the index after the last character in the text
See Also:
CharacterIterator.getEndIndex()getIndex
public int getIndex()
Implements CharacterIterator.getIndex() for String.
Specified by:
[getIndex](CharacterIterator.html#getIndex%28%29)
in interface[CharacterIterator](CharacterIterator.html "interface in java.text")
Returns:
the current index.
See Also:
CharacterIterator.getIndex()equals
public boolean equals(Object obj)
Compares the equality of two StringCharacterIterator objects.
Overrides:
[equals](../lang/Object.html#equals%28java.lang.Object%29)
in class[Object](../lang/Object.html "class in java.lang")
Parameters:
obj
- the StringCharacterIterator object to be compared with.
Returns:
true if the given obj is the same as this StringCharacterIterator object; false otherwise.
See Also:
Object.hashCode(), HashMaphashCode
public int hashCode()
Computes a hashcode for this iterator.
Overrides:
[hashCode](../lang/Object.html#hashCode%28%29)
in class[Object](../lang/Object.html "class in java.lang")
Returns:
A hash code
See Also:
Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)clone
Creates a copy of this iterator.
Specified by:
[clone](CharacterIterator.html#clone%28%29)
in interface[CharacterIterator](CharacterIterator.html "interface in java.text")
Overrides:
[clone](../lang/Object.html#clone%28%29)
in class[Object](../lang/Object.html "class in java.lang")
Returns:
A copy of this
See Also:
Cloneable