Интерфейс атрибутов
- Все известные подинтерфейсы:
- Attributes2
- Все известные реализующие классы:
- Attributes2Impl, AttributesImpl
public interface Attributes
Интерфейс для списка XML-атрибутов.
Этот модуль, как исходный код, так и документация, находится в общественном достоянии и не имеет ГАРАНТИЙ. См. http://www.saxproject.org для получения дополнительной информации.
Этот интерфейс позволяет получить доступ к списку атрибутов тремя способами:
- по индексу атрибута;
- по имени с указанием пространства имён; или
- по квалифицированному (с префиксом) имени.
Список не будет содержать атрибуты, которые были объявлены #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 (ниже).
Порядок атрибутов в списке не определён и может различаться в разных реализациях.
- С момента:
- 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)
Поиск квалифицированного (с префиксом) имени 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.