Интерфейс атрибутов

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

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

Этот модуль, как исходный код, так и документация, находится в общественном достоянии и не имеет ГАРАНТИЙ. См. http://www.saxproject.org для получения дополнительной информации.

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

  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)

Методы

Модификатор и типМетодОписание
intgetIndex​(String qName)

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

intgetIndex​(String uri, String localName)

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

intgetLength()

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

StringgetLocalName​(int index)

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

StringgetQName​(int index)

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

StringgetType​(int index)

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

StringgetType​(String qName)

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

StringgetType​(String uri, String localName)

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

StringgetURI​(int index)

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

StringgetValue​(int index)

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

StringgetValue​(String qName)

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

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

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

Параметры:
index - Индекс атрибута (нумерация с нуля).
Возвращает:
Квалифицированное имя XML или пустую строку, если оно не доступно, или 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)

Поиск индекса атрибута по квалифицированному (префиксённому) имени 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, 2020, 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/11/docs/api/java.xml/org/xml/sax/Attributes.html

Spec-Zone .ru
спецификации, руководства, описания, API