Атрибуты интерфейса

Все известные подинтерфейсы:: Attributes2

Все известные реализующие классы:: Attributes2Impl, AttributesImpl

public interface Attributes

Интерфейс для списка атрибутов XML.

Этот интерфейс предоставляет доступ к списку атрибутов тремя различными способами:

по индексу атрибута;
по имени с пространством имен; или
по квалифицированному имени (с префиксом).

В список не входят атрибуты, объявленные как #IMPLIED, но не указанные в начальном теге. В него также не входят атрибуты, используемые для объявлений пространств имен (xmlns*), если только функция http://xml.org/sax/features/namespace-prefixes не установлена в значение true (по умолчанию она имеет значение false). Поскольку SAX2 соответствует исходной рекомендации «Пространства имен в XML», он обычно не назначает атрибутам объявлений пространств имен URI пространства имен.

Некоторые парсеры SAX2 могут поддерживать использование необязательного флага функции (http://xml.org/sax/features/xmlns-uris), чтобы запросить назначение этим атрибутам URI в соответствии с более поздней, обратно несовместимой редакцией этой рекомендации. («Локальным именем» атрибута будет префикс или «xmlns» при определении пространства имен элемента по умолчанию.) Для обеспечения переносимости код обработчика должен всегда разрешать этот конфликт, а не требовать использования парсеров, которые могут изменить значение этого флага функции.

Если функция namespace-prefixes (см. выше) имеет значение false, доступ по квалифицированному имени может быть недоступен; если функция http://xml.org/sax/features/namespaces имеет значение false, доступ по именам с пространствами имен может быть недоступен.

Этот интерфейс заменяет устаревший интерфейс SAX1 AttributeList, который не поддерживает пространства имен. Помимо поддержки пространств имен, он добавляет методы getIndex (см. ниже).

Порядок атрибутов в списке не определен и может различаться в разных реализациях.

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

1.4, SAX 2.0

См. также:

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

Модификатор и тип	Метод	Описание
`int`	`getIndex(String qName)`	Поиск индекса атрибута по квалифицированному имени XML (с префиксом).
`int`	`getIndex(String uri, String localName)`	Поиск индекса атрибута по имени с пространством имен.
`int`	`getLength()`	Возвращает количество атрибутов в списке.
`String`	`getLocalName(int index)`	Поиск локального имени атрибута по индексу.
`String`	`getQName(int index)`	Поиск квалифицированного имени XML атрибута (с префиксом) по индексу.
`String`	`getType(int index)`	Поиск типа атрибута по индексу.
`String`	`getType(String qName)`	Поиск типа атрибута по квалифицированному имени XML (с префиксом).
`String`	`getType(String uri, String localName)`	Поиск типа атрибута по имени с пространством имен.
`String`	`getURI(int index)`	Поиск URI пространства имен атрибута по индексу.
`String`	`getValue(int index)`	Поиск значения атрибута по индексу.
`String`	`getValue(String qName)`	Поиск значения атрибута по квалифицированному имени XML (с префиксом).
`String`	`getValue(String uri, String localName)`	Поиск значения атрибута по имени с пространством имен.

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

getLength

int getLength()

Возвращает количество атрибутов в списке.

Узнав количество атрибутов, можно перебрать список.

Возвращает:

Количество атрибутов в списке.

См. также:

getURI

String getURI(int index)

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

Параметры:

index — индекс атрибута (нумерация начинается с нуля).

Возвращает:

URI пространства имен, пустую строку, если URI отсутствует, или null, если индекс выходит за допустимые пределы.

См. также:

getLocalName

String getLocalName(int index)

Поиск локального имени атрибута по индексу.

Параметры:

index — индекс атрибута (нумерация начинается с нуля).

Возвращает:

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

См. также:

getQName

String getQName(int index)

Поиск квалифицированного имени XML атрибута (с префиксом) по индексу.

Параметры:

index — индекс атрибута (нумерация начинается с нуля).

Возвращает:

Квалифицированное имя XML, пустую строку, если имя отсутствует, или null, если индекс выходит за допустимые пределы.

См. также:

getType

String getType(int index)

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

Тип атрибута — одна из следующих строк: "CDATA", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES" или "NOTATION" (всегда в верхнем регистре).

Если парсер не прочитал объявление атрибута или не сообщает типы атрибутов, он должен возвращать значение "CDATA", как указано в рекомендации XML 1.0 (пункт 3.3.3, «Нормализация значения атрибута»).

Для перечислимого атрибута, который не является нотацией, парсер сообщает тип "NMTOKEN".

Параметры:

index — индекс атрибута (нумерация начинается с нуля).

Возвращает:

Тип атрибута в виде строки или null, если индекс выходит за допустимые пределы.

См. также:

getValue

String getValue(int index)

Поиск значения атрибута по индексу.

Если значение атрибута представляет собой список токенов (IDREFS, ENTITIES или NMTOKENS), токены объединяются в одну строку и разделяются одиночными пробелами.

Параметры:

index — индекс атрибута (нумерация начинается с нуля).

Возвращает:

Значение атрибута в виде строки или null, если индекс выходит за допустимые пределы.

См. также:

getIndex

int getIndex(String uri, String localName)

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

Параметры:: uri — URI пространства имен или пустая строка, если у имени нет URI пространства имен.; localName — локальное имя атрибута.
Возвращает:: Индекс атрибута или -1, если атрибут отсутствует в списке.

getIndex

int getIndex(String qName)

Поиск индекса атрибута по квалифицированному имени XML (с префиксом).

Параметры:: qName — квалифицированное имя (с префиксом).
Возвращает:: Индекс атрибута или -1, если атрибут отсутствует в списке.

getType

String getType(String uri, String localName)

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

Описание возможных типов см. в разделе getType(int).

Параметры:: uri — URI пространства имен или пустая строка, если у имени нет URI пространства имен.; localName — локальное имя атрибута.
Возвращает:: Тип атрибута в виде строки или null, если атрибут отсутствует в списке либо обработка пространств имен не выполняется.

getType

String getType(String qName)

Поиск типа атрибута по квалифицированному имени XML (с префиксом).

Описание возможных типов см. в разделе getType(int).

Параметры:: qName — квалифицированное имя XML.
Возвращает:: Тип атрибута в виде строки или null, если атрибут отсутствует в списке либо квалифицированные имена недоступны.

getValue

String getValue(String uri, String localName)

Поиск значения атрибута по имени с пространством имен.

Описание возможных значений см. в разделе getValue(int).

Параметры:: uri — URI пространства имен или пустая строка, если у имени нет URI пространства имен.; localName — локальное имя атрибута.
Возвращает:: Значение атрибута в виде строки или null, если атрибут отсутствует в списке.

getValue

String getValue(String qName)

Поиск значения атрибута по квалифицированному имени XML (с префиксом).

Описание возможных значений см. в разделе getValue(int).

Параметры:: qName — квалифицированное имя XML.
Возвращает:: Значение атрибута в виде строки или null, если атрибут отсутствует в списке либо квалифицированные имена недоступны.

© 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.
https://docs.oracle.com/en/java/javase/25/docs/api/java.xml/org/xml/sax/Attributes.html