Класс QName

Все реализуемые интерфейсы:
Serializable
public class QName
extends Object
implements Serializable

QName представляет собой полное имя, как определено в спецификациях XML: Спецификация XML Schema Part2: Типы данных, Пространства имён в XML.

Значение QName содержит URI пространства имён, локальную часть и префикс.

Префикс включается в QName для сохранения лексической информации при её наличии в XML input source. Префикс не используется в QName.equals(Object) или для вычисления QName.hashCode(). Равенство и хэш-код определяются только по URI пространства имён и локальной части.

Если не указано, URI пространства имён устанавливается в XMLConstants.NULL_NS_URI. Если не указано, префикс устанавливается в XMLConstants.DEFAULT_NS_PREFIX.

QName является неизменяемым.

С тех пор:
1.5
См. также:
Спецификация XML Schema Part2: Типы данных, Пространства имён в XML, Формат сериализации

Конструкторы

Конструктор Описание
QName​(String localPart)

QName конструктор, задающий локальную часть.
QName​(String namespaceURI, String localPart)

QName конструктор, задающий URI пространства имён и локальную часть.
QName​(String namespaceURI, String localPart, String prefix)

QName конструктор, задающий URI пространства имён, локальную часть и префикс.

Методы

Модификатор и тип Метод Описание
boolean equals​(Object objectToTest)

Проверка на равенство этого QName с другим Object.
String getLocalPart()

Получение локальной части этого QName.
String getNamespaceURI()

Получение URI пространства имён этого QName.
String getPrefix()

Получение префикса этого QName.
int hashCode()

Генерация хэш-кода для этого QName.
String toString()

Строковое представление этого QName.
static QName valueOf​(String qNameAsString)

QName, полученное из разбора отформатированного String.

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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Конструкторы

QName

public QName(String namespaceURI,
             String localPart)

QName конструктор, задающий URI пространства имён и локальную часть.

Если URI пространства имён null, он устанавливается в XMLConstants.NULL_NS_URI. Это значение обозначает отсутствие явно определённого пространства имён, как определено в спецификации Пространства имён в XML. Это действие сохраняет совместимое поведение с QName 1.0. Явное указание значения XMLConstants.NULL_NS_URI предпочтительнее.

Если локальная часть null, выбрасывается IllegalArgumentException. Локальная часть "" разрешена для сохранения совместимости с QName 1.0.

При использовании этого конструктора, префикс устанавливается в XMLConstants.DEFAULT_NS_PREFIX.

URI пространства имён не проверяется как ссылка URI. Локальная часть не проверяется как NCName, как указано в Пространства имён в XML.

Параметры:
namespaceURI - URI пространства имён QName
localPart - локальная часть QName
Исключения:
IllegalArgumentException - Когда localPart null
См. также:
QName(String namespaceURI, String localPart, String prefix)

QName

public QName(String namespaceURI,
             String localPart,
             String prefix)

QName конструктор, задающий URI пространства имён, локальную часть и префикс.

Если URI пространства имён null, он устанавливается в XMLConstants.NULL_NS_URI. Это значение обозначает отсутствие явно определённого пространства имён, как определено в спецификации Пространства имён в XML. Это действие сохраняет совместимое поведение с QName 1.0. Явное указание значения XMLConstants.NULL_NS_URI предпочтительнее.

Если локальная часть null, выбрасывается IllegalArgumentException. Локальная часть "" разрешена для сохранения совместимости с QName 1.0.

Если префикс null, выбрасывается IllegalArgumentException. Используйте XMLConstants.DEFAULT_NS_PREFIX для явного указания отсутствия префикса или его нерелевантности.

URI пространства имён не проверяется как ссылка URI. Локальная часть и префикс не проверяются как NCName, как указано в Пространства имён в XML.

Параметры:
namespaceURI - URI пространства имён QName
localPart - локальная часть QName
prefix - префикс QName
Исключения:
IllegalArgumentException - Когда localPart или prefix null

QName

public QName(String localPart)

QName конструктор, задающий локальную часть.

Если локальная часть null, выбрасывается IllegalArgumentException. Локальная часть "" разрешена для сохранения совместимости с QName 1.0.

При использовании этого конструктора, URI пространства имён устанавливается в XMLConstants.NULL_NS_URI, а префикс в XMLConstants.DEFAULT_NS_PREFIX.

В контексте XML все имена элементов и атрибутов существуют в контексте пространства имён. Явное указание этого при создании QName помогает предотвратить трудно диагностируемые ошибки валидации XML. Конструкторы QName(String namespaceURI, String localPart) и QName(String namespaceURI, String localPart, String prefix) предпочтительнее.

Локальная часть не проверяется как NCName, как указано в Пространства имён в XML.

Параметры:
localPart - локальная часть QName
Исключения:
IllegalArgumentException - Когда localPart null
См. также:
QName(String namespaceURI, String localPart), QName(String namespaceURI, String localPart, String prefix)

Методы

getNamespaceURI

public String getNamespaceURI()

Получить URI пространства имён этого QName.

Возвращает:
URI пространства имён этого QName

getLocalPart

public String getLocalPart()

Получить локальную часть этого QName.

Возвращает:
локальную часть этого QName

getPrefix

public String getPrefix()

Получить префикс этого QName.

Присвоенный префикс QName может НЕ быть допустимым в другом контексте. Например, QName может получить префикс в контексте разбора документа, но этот префикс может быть недопустим в контексте другого документа.

Возвращает:
префикс этого QName

equals

public final boolean equals(Object objectToTest)

Проверить это QName на равенство с другим Object.

Если Object для проверки не является QName или является null, то этот метод возвращает false.

Два QName считаются равными тогда и только тогда, когда URI пространства имён и локальная часть равны. Этот метод использует String.equals() для проверки равенства URI пространства имён и локальной части. Префикс НЕ используется для определения равенства.

Этот метод удовлетворяет общему контракту Object.equals(Object)

Overrides:
equals в классе Object
Параметры:
objectToTest - Object для проверки на равенство с этим QName
Возвращает:
true если заданный Object равен этому QName, иначе false
См. также:
Object.hashCode(), HashMap

hashCode

public final int hashCode()

Сгенерировать код хэша для этого QName.

Код хэша рассчитывается с использованием как URI пространства имён, так и локальной части QName. Префикс НЕ используется для расчёта кода хэша.

Этот метод удовлетворяет общему контракту Object.hashCode().

Overrides:
hashCode в классе Object
Возвращает:
код хэша для этого QName Object
См. также:
Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

toString

public String toString()

String представление этого QName.

Общепринятый способ представления QName как String был определён Джеймсом Кларком. Хотя это и не стандартное спецификация, она широко используется, например, Transformer.setParameter(String name, Object value). В данной реализации QName представляется как: "{" + URI пространства имён + "}" + локальная часть. Если URI пространства имён .equals(XMLConstants.NULL_NS_URI), возвращается только локальная часть. Данный метод подходит для отладки или ведения журнала для чтения человеком.

Обратите внимание, что значение префикса НЕ возвращается как часть представления String.

Этот метод удовлетворяет общему контракту Object.toString().

Overrides:
toString в классе Object
Возвращает:
String представление этого QName

valueOf

public static QName valueOf(String qNameAsString)

QName полученный из разбора отформатированного String.

Если String null или не соответствует формату QName.toString(), выбрасывается IllegalArgumentException.

String ДОЛЖЕН быть в форме, возвращаемой QName.toString().

Общепринятый способ представления QName как String был определён Джеймсом Кларком. Хотя это и не стандартная спецификация, она широко используется, например, Transformer.setParameter(String name, Object value). В данной реализации анализируется String в формате: "{" + URI пространства имён + "}" + локальная часть. Если URI пространства имён .equals(XMLConstants.NULL_NS_URI), должен быть предоставлен только локальная часть.

Значение префикса НЕЛЬЗЯ представить в String и будет установлено в XMLConstants.DEFAULT_NS_PREFIX.

Этот метод не выполняет полную валидацию полученного QName.

URI пространства имён не валидируется как ссылка URI. Локальная часть не валидируется как NCName, как указано в Пространства имён в XML.

Параметры:
qNameAsString - String представление QName
Возвращает:
QName соответствующее заданному String
Выбрасывает:
IllegalArgumentException - Когда qNameAsString null или имеет неправильный формат
См. также:
QName.toString()

© 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/javax/xml/namespace/QName.html

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