Spec-Zone.ru › OpenJDK 21

Интерфейс AttributedCharacterIterator

Все суперинтерфейсы:
CharacterIterator, Cloneable
public interface AttributedCharacterIterator extends CharacterIterator
An AttributedCharacterIterator позволяет итерироваться по тексту и связанной информации об атрибутах.

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

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

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

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

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

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

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

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

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

С:
1.2
См. также:
  • AttributedCharacterIterator.Attribute
  • TextAttribute
  • AttributedString
  • Annotation

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

Модификатор и тип Интерфейс Описание
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, 2023, 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/21/docs/api/java.base/java/text/AttributedCharacterIterator.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API