Класс AttributedString

java.lang.Object

java.text.AttributedString

public class AttributedString extends Object

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

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

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

Начиная с:

1.2

См. также:

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

Конструктор	Описание
`AttributedString(String text)`	Создает экземпляр AttributedString с указанным текстом.
`AttributedString(String text, Map<? extends AttributedCharacterIterator.Attribute, ?> attributes)`	Создает экземпляр AttributedString с указанным текстом и атрибутами.
`AttributedString(AttributedCharacterIterator text)`	Создает экземпляр AttributedString с указанным текстом с атрибутами, представленным объектом AttributedCharacterIterator.
`AttributedString(AttributedCharacterIterator text, int beginIndex, int endIndex)`	Создает экземпляр AttributedString с поддиапазоном указанного текста с атрибутами, представленным объектом AttributedCharacterIterator.
`AttributedString(AttributedCharacterIterator text, int beginIndex, int endIndex, AttributedCharacterIterator.Attribute[] attributes)`	Создает экземпляр AttributedString с поддиапазоном указанного текста с атрибутами, представленным объектом AttributedCharacterIterator.

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

Модификатор и тип	Метод	Описание
`void`	`addAttribute(AttributedCharacterIterator.Attribute attribute, Object value)`	Добавляет атрибут ко всей строке.
`void`	`addAttribute(AttributedCharacterIterator.Attribute attribute, Object value, int beginIndex, int endIndex)`	Добавляет атрибут к поддиапазону строки.
`void`	`addAttributes(Map<? extends AttributedCharacterIterator.Attribute, ?> attributes, int beginIndex, int endIndex)`	Добавляет набор атрибутов к поддиапазону строки.
`AttributedCharacterIterator`	`getIterator()`	Создает экземпляр AttributedCharacterIterator, обеспечивающий доступ ко всему содержимому этой строки.
`AttributedCharacterIterator`	`getIterator(AttributedCharacterIterator.Attribute[] attributes)`	Создает экземпляр AttributedCharacterIterator, обеспечивающий доступ к выбранному содержимому этой строки.
`AttributedCharacterIterator`	`getIterator(AttributedCharacterIterator.Attribute[] attributes, int beginIndex, int endIndex)`	Создает экземпляр AttributedCharacterIterator, обеспечивающий доступ к выбранному содержимому этой строки.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создает и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, равен ли этот объект какому-либо другому объекту.
`protected void`	`finalize()`	Устарело, подлежит удалению: этот элемент API подлежит удалению в будущей версии. Финализация объявлена устаревшей и подлежит удалению в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Переводит текущий поток в состояние ожидания до его пробуждения, обычно посредством уведомления или прерывания.
`final void`	`wait(long timeoutMillis)`	Переводит текущий поток в состояние ожидания до его пробуждения, обычно посредством уведомления или прерывания, либо до истечения заданного времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Переводит текущий поток в состояние ожидания до его пробуждения, обычно посредством уведомления или прерывания, либо до истечения заданного времени.

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

AttributedString

public AttributedString(String text)

Создает экземпляр AttributedString с указанным текстом.

Параметры:: text — текст для этой строки с атрибутами.
Исключения:: NullPointerException — если text имеет значение null.

AttributedString

public AttributedString(String text, Map<? extends AttributedCharacterIterator.Attribute, ?> attributes)

Создает экземпляр AttributedString с указанным текстом и атрибутами.

Параметры:: text — текст для этой строки с атрибутами.; attributes — атрибуты, применяемые ко всей строке.
Исключения:: NullPointerException — если text или attributes имеет значение null.; IllegalArgumentException — если длина текста равна 0, а параметр attributes не является пустой Map (атрибуты нельзя применить к диапазону длиной 0).

AttributedString

public AttributedString(AttributedCharacterIterator text)

Создает экземпляр AttributedString с указанным текстом с атрибутами, представленным объектом AttributedCharacterIterator.

Параметры:: text — текст для этой строки с атрибутами.
Исключения:: NullPointerException — если text имеет значение null.

AttributedString

public AttributedString(AttributedCharacterIterator text, int beginIndex, int endIndex)

Создает экземпляр AttributedString с поддиапазоном указанного текста с атрибутами, представленным объектом AttributedCharacterIterator. Если указанный диапазон задает пустой текст, все атрибуты будут отброшены. Обратите внимание, что любые атрибуты, заключенные в объект Annotation, отбрасываются для поддиапазона исходного диапазона атрибутов.

Параметры:

text — текст для этой строки с атрибутами.

beginIndex — индекс первого символа диапазона.

endIndex — индекс символа, следующего за последним символом диапазона.

Исключения:

NullPointerException — если text имеет значение null.

IllegalArgumentException — если поддиапазон, заданный beginIndex и endIndex, выходит за пределы диапазона текста.

См. также:

AttributedString

public AttributedString(AttributedCharacterIterator text, int beginIndex, int endIndex, AttributedCharacterIterator.Attribute[] attributes)

Создает экземпляр AttributedString с поддиапазоном указанного текста с атрибутами, представленным объектом AttributedCharacterIterator. В экземпляр будут включены только атрибуты, соответствующие указанным атрибутам. Если указанный диапазон задает пустой текст, все атрибуты будут отброшены. Обратите внимание, что любые атрибуты, заключенные в объект Annotation, отбрасываются для поддиапазона исходного диапазона атрибутов.

Параметры:

text — текст для этой строки с атрибутами.

beginIndex — индекс первого символа диапазона.

endIndex — индекс символа, следующего за последним символом диапазона.

attributes — задает атрибуты, извлекаемые из текста. Если указано значение null, будут использоваться все доступные атрибуты.

Исключения:

NullPointerException — если text имеет значение null.

IllegalArgumentException — если поддиапазон, заданный beginIndex и endIndex, выходит за пределы диапазона текста.

См. также:

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

addAttribute

public void addAttribute(AttributedCharacterIterator.Attribute attribute, Object value)

Добавляет атрибут ко всей строке.

Параметры:: attribute — ключ атрибута; value — значение атрибута; может быть null
Исключения:: NullPointerException — если attribute имеет значение null.; IllegalArgumentException — если длина AttributedString равна 0 (атрибуты нельзя применить к диапазону длиной 0).

addAttribute

public void addAttribute(AttributedCharacterIterator.Attribute attribute, Object value, int beginIndex, int endIndex)

Добавляет атрибут к поддиапазону строки.

Параметры:: attribute — ключ атрибута; value — значение атрибута. Может быть null.; beginIndex — индекс первого символа диапазона.; endIndex — индекс символа, следующего за последним символом диапазона.
Исключения:: NullPointerException — если attribute имеет значение null.; IllegalArgumentException — если beginIndex меньше 0, endIndex больше длины строки либо beginIndex и endIndex вместе не задают непустой поддиапазон строки.

addAttributes

public void addAttributes(Map<? extends AttributedCharacterIterator.Attribute, ?> attributes, int beginIndex, int endIndex)

Добавляет набор атрибутов к поддиапазону строки.

Параметры:: attributes — атрибуты, добавляемые к строке.; beginIndex — индекс первого символа диапазона.; endIndex — индекс символа, следующего за последним символом диапазона.
Исключения:: NullPointerException — если attributes имеет значение null.; IllegalArgumentException — если beginIndex меньше 0, endIndex больше длины строки либо beginIndex и endIndex вместе не задают непустой поддиапазон строки, а параметр attributes не является пустой Map.

getIterator

public AttributedCharacterIterator getIterator()

Создает экземпляр AttributedCharacterIterator, обеспечивающий доступ ко всему содержимому этой строки.

Возвращает:: итератор, обеспечивающий доступ к тексту и его атрибутам.

getIterator

public AttributedCharacterIterator getIterator(AttributedCharacterIterator.Attribute[] attributes)

Создает экземпляр AttributedCharacterIterator, обеспечивающий доступ к выбранному содержимому этой строки. Информация об атрибутах, не перечисленных в attributes, которая может потребоваться реализатору, не обязательно должна быть доступна через итератор. Если список равен null, должна быть доступна вся информация об атрибутах.

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

getIterator

public AttributedCharacterIterator getIterator(AttributedCharacterIterator.Attribute[] attributes, int beginIndex, int endIndex)

Параметры:: attributes — список атрибутов, которые интересуют клиента; beginIndex — индекс первого символа; endIndex — индекс символа, следующего за последним символом
Возвращает:: итератор, обеспечивающий доступ к тексту и его атрибутам
Исключения:: IllegalArgumentException — если beginIndex меньше 0, endIndex больше длины строки или beginIndex больше endIndex.

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