Интерфейс AttributedCharacterIterator

Все суперинтерфейсы:: CharacterIterator, Cloneable

public interface AttributedCharacterIterator extends CharacterIterator

AttributedCharacterIterator позволяет выполнять итерацию как по тексту, так и по связанным с ним сведениям об атрибутах.

Атрибут представляет собой пару ключ/значение, идентифицируемую по ключу. У двух атрибутов одного символа не может быть одинаковых ключей.

Значения атрибутов являются неизменяемыми либо не должны изменяться клиентами или хранилищем. Они всегда передаются по ссылке, а не копируются.

Диапазон относительно атрибута — это максимальный диапазон текста, для которого выполняется одно из условий:

атрибут не определён или null для всего диапазона;
значение атрибута определено и имеет одинаковое не-null значение для всего диапазона.

Диапазон относительно набора атрибутов — это максимальный диапазон текста, для которого данное условие выполняется для каждого атрибута из набора.

При получении диапазона без явного указания атрибутов (то есть при вызове getRunStart() и getRunLimit()) любые смежные сегменты текста с одинаковыми атрибутами (одинаковым набором пар атрибут/значение) считаются отдельными диапазонами, если атрибуты были заданы для этих сегментов текста отдельно.

Возвращаемые индексы ограничены диапазоном итератора.

Возвращаемые сведения об атрибутах ограничены диапазонами, содержащими текущий символ.

Ключи атрибутов являются экземплярами AttributedCharacterIterator.Attribute и его подклассов, таких как TextAttribute.

Начиная с версии:

1.2

См. также:

Краткое описание вложенных классов

Модификатор и тип	Интерфейс	Описание
`static class`	`AttributedCharacterIterator.Attribute`	Определяет ключи атрибутов, используемые для идентификации текстовых атрибутов.

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

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

DONE

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

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

Модификатор и тип	Метод	Описание
`Set<AttributedCharacterIterator.Attribute>`	`getAllAttributeKeys()`	Возвращает ключи всех атрибутов, определённых в диапазоне текста итератора.
`Object`	`getAttribute(AttributedCharacterIterator.Attribute attribute)`	Возвращает значение указанного `attribute` для текущего символа.
`Map<AttributedCharacterIterator.Attribute, Object>`	`getAttributes()`	Возвращает карту атрибутов, определённых для текущего символа.
`int`	`getRunLimit()`	Возвращает индекс первого символа, следующего за диапазоном относительно всех атрибутов, содержащих текущий символ.
`int`	`getRunLimit(AttributedCharacterIterator.Attribute attribute)`	Возвращает индекс первого символа, следующего за диапазоном относительно указанного `attribute`, содержащего текущий символ.
`int`	`getRunLimit(Set<? extends AttributedCharacterIterator.Attribute> attributes)`	Возвращает индекс первого символа, следующего за диапазоном относительно указанного `attributes`, содержащего текущий символ.
`int`	`getRunStart()`	Возвращает индекс первого символа диапазона относительно всех атрибутов, содержащих текущий символ.
`int`	`getRunStart(AttributedCharacterIterator.Attribute attribute)`	Возвращает индекс первого символа диапазона относительно указанного `attribute`, содержащего текущий символ.
`int`	`getRunStart(Set<? extends AttributedCharacterIterator.Attribute> attributes)`	Возвращает индекс первого символа диапазона относительно указанного `attributes`, содержащего текущий символ.

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

clone, current, first, getBeginIndex, getEndIndex, getIndex, last, next, previous, setIndex

Модификатор и тип	Метод	Описание
`Object`	`clone()`	Создаёт копию этого итератора
`char`	`current()`	Возвращает символ в текущей позиции (определяемой методом getIndex()).
`char`	`first()`	Устанавливает позицию в getBeginIndex() и возвращает символ в этой позиции.
`int`	`getBeginIndex()`	Возвращает начальный индекс текста.
`int`	`getEndIndex()`	Возвращает конечный индекс текста.
`int`	`getIndex()`	Возвращает текущий индекс.
`char`	`last()`	Устанавливает позицию в getEndIndex()-1 (getEndIndex(), если текст пуст) и возвращает символ в этой позиции.
`char`	`next()`	Увеличивает индекс итератора на единицу и возвращает символ по новому индексу.
`char`	`previous()`	Уменьшает индекс итератора на единицу и возвращает символ по новому индексу.
`char`	`setIndex(int position)`	Устанавливает позицию в указанную позицию текста и возвращает соответствующий символ.

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

getRunStart

int getRunStart()

Возвращает индекс первого символа диапазона относительно всех атрибутов, содержащих текущий символ.

Любые смежные сегменты текста с одинаковыми атрибутами (одинаковым набором пар атрибут/значение) считаются отдельными диапазонами, если атрибуты были заданы для этих сегментов текста отдельно.

Возвращает:: индекс первого символа диапазона

getRunStart

int getRunStart(AttributedCharacterIterator.Attribute attribute)

Возвращает индекс первого символа диапазона относительно указанного attribute, содержащего текущий символ.

Параметры:: attribute — требуемый атрибут.
Возвращает:: индекс первого символа диапазона

getRunStart

int getRunStart(Set<? extends AttributedCharacterIterator.Attribute> attributes)

Возвращает индекс первого символа диапазона относительно указанного attributes, содержащего текущий символ.

Параметры:: attributes — набор требуемых атрибутов.
Возвращает:: индекс первого символа диапазона

getRunLimit

int getRunLimit()

Возвращает индекс первого символа, следующего за диапазоном относительно всех атрибутов, содержащих текущий символ.

Возвращает:: индекс первого символа, следующего за диапазоном

getRunLimit

int getRunLimit(AttributedCharacterIterator.Attribute attribute)

Возвращает индекс первого символа, следующего за диапазоном относительно указанного attribute, содержащего текущий символ.

Параметры:: attribute — требуемый атрибут
Возвращает:: индекс первого символа, следующего за диапазоном

getRunLimit

int getRunLimit(Set<? extends AttributedCharacterIterator.Attribute> attributes)

Возвращает индекс первого символа, следующего за диапазоном относительно указанного attributes, содержащего текущий символ.

Параметры:: attributes — набор требуемых атрибутов
Возвращает:: индекс первого символа, следующего за диапазоном

getAttributes

Map<AttributedCharacterIterator.Attribute, Object> getAttributes()

Возвращает карту атрибутов, определённых для текущего символа.

Возвращает:: карту атрибутов, определённых для текущего символа

getAttribute

Object getAttribute(AttributedCharacterIterator.Attribute attribute)

Возвращает значение указанного attribute для текущего символа. Возвращает null, если attribute не определён.

Параметры:: attribute — требуемый атрибут
Возвращает:: значение указанного attribute или null

getAllAttributeKeys

Set<AttributedCharacterIterator.Attribute> getAllAttributeKeys()

Возвращает ключи всех атрибутов, определённых в диапазоне текста итератора. Если атрибуты не определены, набор пуст.

Возвращает:: ключи всех атрибутов

© 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.