Класс 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

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

Конструктор	Описание
`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

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

StringCharacterIterator

public StringCharacterIterator(String text)

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

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

StringCharacterIterator

public StringCharacterIterator(String text, int pos)

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

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

StringCharacterIterator

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

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

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

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

setText

public void setText(String text)

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

Параметры:: text — строка String, по которой выполняется итерация
Исключения:: 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.
https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/text/StringCharacterIterator.html