Класс StringCharacterIterator

java.lang.Object

java.text.StringCharacterIterator

Все реализуемые интерфейсы:: Cloneable, CharacterIterator

public final class StringCharacterIterator extends Object implements CharacterIterator

StringCharacterIterator реализует протокол CharacterIterator для String. Класс StringCharacterIterator выполняет итерацию по всему String. Все конструкторы выбрасывают NullPointerException, если text равно null.

Начиная с:

1.1

См. также:

Краткое описание полей

Поля, объявленные в интерфейсе CharacterIterator

DONE

Модификатор и тип	Поле	Описание
`static final char`	`DONE`	Константа, возвращаемая, когда итератор достигает конца или начала текста.

Краткое описание конструкторов

Конструктор	Описание
`StringCharacterIterator(String text)`	Создает итератор с начальным индексом 0.
`StringCharacterIterator(String text, int pos)`	Создает итератор с указанным начальным индексом.
`StringCharacterIterator(String text, int begin, int end, int pos)`	Создает итератор для заданного диапазона указанной строки, устанавливая индекс в заданную позицию.

Краткое описание методов

Модификатор и тип	Метод	Описание
`Object`	`clone()`	Создает копию этого итератора.
`char`	`current()`	Реализует CharacterIterator.current() для String.
`boolean`	`equals(Object obj)`	Сравнивает на равенство два объекта StringCharacterIterator.
`char`	`first()`	Реализует CharacterIterator.first() для String.
`int`	`getBeginIndex()`	Реализует CharacterIterator.getBeginIndex() для String.
`int`	`getEndIndex()`	Реализует CharacterIterator.getEndIndex() для String.
`int`	`getIndex()`	Реализует CharacterIterator.getIndex() для String.
`int`	`hashCode()`	Вычисляет хеш-код этого итератора.
`char`	`last()`	Реализует CharacterIterator.last() для String.
`char`	`next()`	Реализует CharacterIterator.next() для String.
`char`	`previous()`	Реализует CharacterIterator.previous() для String.
`char`	`setIndex(int p)`	Реализует CharacterIterator.setIndex() для String.
`void`	`setText(String text)`	Сбрасывает этот итератор, чтобы он указывал на новую строку.

Методы, объявленные в классе Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Модификатор и тип	Метод	Описание
`protected void`	`finalize()`	Устарело, будет удалено: этот элемент API подлежит удалению в будущей версии. Метод finalization устарел и подлежит удалению в одном из следующих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Переводит текущий поток в состояние ожидания до его пробуждения, обычно в результате вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Переводит текущий поток в состояние ожидания до его пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного периода реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Переводит текущий поток в состояние ожидания до его пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного периода реального времени.

Подробное описание конструкторов

StringCharacterIterator

public StringCharacterIterator(String text)

Создает итератор с начальным индексом 0.

Параметры:: text — String, по которому выполняется итерация

StringCharacterIterator

public StringCharacterIterator(String text, int pos)

Создает итератор с указанным начальным индексом.

Параметры:: text — строка, по которой выполняется итерация; pos — начальная позиция итератора
Выбрасывает:: IllegalArgumentException — если pos не входит в диапазон (включительно) от 0 до длины text

StringCharacterIterator

public StringCharacterIterator(String text, int begin, int end, int pos)

Создает итератор для заданного диапазона указанной строки, устанавливая индекс в заданную позицию.

Параметры:: text — строка, по которой выполняется итерация; begin — индекс первого символа; end — индекс символа, следующего за последним символом; pos — начальная позиция итератора
Выбрасывает:: IllegalArgumentException — если begin и end не входят в диапазон (включительно) от 0 до длины text, если begin больше, чем end, или если pos не входит в диапазон (включительно) от begin до end

Подробное описание методов

setText

public void setText(String text)

Сбрасывает этот итератор, чтобы он указывал на новую строку. Этот видимый в пределах пакета метод используется другими классами java.text, которым необходимо избежать создания новых объектов StringCharacterIterator при каждом вызове метода setText.

Параметры:: text — строка, по которой выполняется итерация
Выбрасывает:: NullPointerException — если text равно null
Начиная с:: 1.2

first

public char first()

Реализует CharacterIterator.first() для String.

Определено в:

first в интерфейсе CharacterIterator

Возвращает:

первый символ текста или DONE, если текст пуст

См. также:

last

public char last()

Реализует CharacterIterator.last() для String.

Определено в:

last в интерфейсе CharacterIterator

Возвращает:

последний символ текста или DONE, если текст пуст

См. также:

setIndex

public char setIndex(int p)

Реализует CharacterIterator.setIndex() для String.

Определено в:

setIndex в интерфейсе CharacterIterator

Параметры:

p — позиция в тексте. Допустимые значения находятся в диапазоне от getBeginIndex() до getEndIndex(). Если указано недопустимое значение, выбрасывается IllegalArgumentException.

Возвращает:

символ в указанной позиции или DONE, если указанная позиция равна getEndIndex()

Выбрасывает:

IllegalArgumentException — если p не входит в диапазон (включительно) от getBeginIndex() до getEndIndex()

См. также:

current

public char current()

Реализует CharacterIterator.current() для String.

Определено в:

current в интерфейсе CharacterIterator

Возвращает:

символ в текущей позиции или DONE, если текущая позиция находится за концом текста.

См. также:

public char next()

Реализует CharacterIterator.next() для String.

Определено в:

next в интерфейсе CharacterIterator

Возвращает:

символ в новой позиции или DONE, если новая позиция находится за пределами диапазона текста.

См. также:

public char previous()

Реализует CharacterIterator.previous() для String.

Определено в:

previous в интерфейсе CharacterIterator

Возвращает:

символ в новой позиции или DONE, если текущая позиция равна getBeginIndex().

См. также:

getBeginIndex

public int getBeginIndex()

Реализует CharacterIterator.getBeginIndex() для String.

Определено в:

getBeginIndex в интерфейсе CharacterIterator

Возвращает:

индекс начала текста.

См. также:

getEndIndex

public int getEndIndex()

Реализует CharacterIterator.getEndIndex() для String.

Определено в:

getEndIndex в интерфейсе CharacterIterator

Возвращает:

индекс, следующий за последним символом текста

См. также:

getIndex

public int getIndex()

Реализует CharacterIterator.getIndex() для String.

Определено в:

getIndex в интерфейсе CharacterIterator

Возвращает:

текущий индекс.

См. также:

equals

public boolean equals(Object obj)

Сравнивает на равенство два объекта StringCharacterIterator.

Переопределяет:

equals в классе Object

Параметры:

obj — объект StringCharacterIterator для сравнения.

Возвращает:

true, если заданный obj совпадает с этим объектом StringCharacterIterator; в противном случае false.

См. также:

hashCode

public int hashCode()

Вычисляет хеш-код этого итератора.

Переопределяет:

hashCode в классе Object

Возвращает:

хеш-код

См. также:

clone

public Object clone()

Создает копию этого итератора.

Определено в:

clone в интерфейсе CharacterIterator

Переопределяет:

clone в классе Object

Возвращает:

копию этого объекта

См. также:

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.