Интерфейс AttributedCharacterIterator

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

public interface AttributedCharacterIterator extends CharacterIterator

Интерфейс, позволяющий итерироваться по тексту и связанной информации об атрибутах.

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

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

Ряд (run) по отношению к атрибуту — это максимальный текстовый диапазон, для которого:

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

Ряд (run) по отношению к набору атрибутов — это максимальный текстовый диапазон, для которого это условие выполняется для каждого атрибута в наборе.

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

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

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

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

С:

1.2

См. также:

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

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

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

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

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` , содержащему текущий символ.

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

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

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

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, 2021, 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/17/docs/api/java.base/java/text/AttributedCharacterIterator.html