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

См. также:

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

Поля, объявленные в интерфейсе java.text.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)`	Сбросить этот итератор, чтобы он указывал на новую строку.

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

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

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

StringCharacterIterator

public StringCharacterIterator(String text)

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

Параметры:: text - строка, по которой будет происходить итерация

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.
https://download.java.net/java/early_access/jdk24/docs/api/java.base/java/text/StringCharacterIterator.html