Spec-Zone.ru › OpenJDK 21

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

Все известные подинтерфейсы:
Attributes2
Все известные реализующие классы:
Attributes2Impl, AttributesImpl
public interface Attributes
Интерфейс для списка XML-атрибутов.

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

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

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

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

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

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

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

С:
1.4, SAX 2.0
См. также:
  • AttributesImpl
  • DeclHandler.attributeDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

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

Модификатор и тип Метод Описание
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(int)
  • getLocalName(int)
  • getQName(int)
  • getType(int)
  • getValue(int)

getURI

String getURI(int index)
Получение URI пространства имен атрибута по индексу.
Параметры:
index - Индекс атрибута (нумерация с нуля).
Возвращает:
URI пространства имен, или пустая строка, если он отсутствует, или null, если индекс находится вне диапазона.
См. также:
  • getLength()

getLocalName

String getLocalName(int index)
Получение локального имени атрибута по индексу.
Параметры:
index - Индекс атрибута (нумерация с нуля).
Возвращает:
Локальное имя, или пустая строка, если обработка пространства имен не выполняется, или null, если индекс находится вне диапазона.
См. также:
  • getLength()

getQName

String getQName(int index)
Получение полному имени (с префиксом) атрибута по индексу.
Параметры:
index - Индекс атрибута (нумерация с нуля).
Возвращает:
Полное имя атрибута, или пустая строка, если оно отсутствует, или null, если индекс находится вне диапазона.
См. также:
  • getLength()

getType

String getType(int index)
Получение типа атрибута по индексу.

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

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

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

Параметры:
index - Индекс атрибута (нумерация с нуля).
Возвращает:
Тип атрибута в виде строки, или null, если индекс находится вне диапазона.
См. также:
  • getLength()

getValue

String getValue(int index)
Получение значения атрибута по индексу.

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

Параметры:
index - Индекс атрибута (нумерация с нуля).
Возвращает:
Значение атрибута в виде строки, или null, если индекс находится вне диапазона.
См. также:
  • getLength()

getIndex

int getIndex(String uri, String localName)
Поиск индекса атрибута по имени пространства имен.
Параметры:
uri - URI пространства имен, или пустая строка, если имя не имеет URI пространства имен.
localName - Локальное имя атрибута.
Возвращает:
Индекс атрибута, или -1, если он не найден в списке.

getIndex

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

getType

String getType(String uri, String localName)
Получение типа атрибута по имени пространства имен.

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

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

getType

String getType(String qName)
Получение типа атрибута по полному имени (с префиксом).

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

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

getValue

String getValue(String uri, String localName)
Получение значения атрибута по имени пространства имен.

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

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

getValue

String getValue(String qName)
Получение значения атрибута по полному имени (с префиксом).

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

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

© 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.xml/org/xml/sax/Attributes.html

Spec-Zone.ru

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