Интерфейс AttributedCharacterIterator

public interface AttributedCharacterIterator
extends CharacterIterator

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

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

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

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

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

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

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

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

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

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

Методы

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()

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

Возвращает:

ключи всех атрибутов