Spec-Zone.ru › OpenJDK 24

Класс QName

java.lang.Object
javax.xml.namespace.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 пространства имён, локальную часть и префикс.

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

Модификатор и тип Метод Описание
final boolean equals(Object objectToTest)
Проверка равенства этого QName с другим Object.
String getLocalPart()
Получение локальной части этого QName.
String getNamespaceURI()
Получение URI пространства имён этого QName.
String getPrefix()
Получение префикса этого QName.
final int hashCode()
Генерация хэш-кода для этого QName.
String toString()
String представление этого 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. Это значение обозначает отсутствие явно определённого пространства имён, как определено в спецификации Namespaces in XML. Это действие сохраняет совместимое поведение с QName 1.0. Явное указание значения XMLConstants.NULL_NS_URI предпочтительнее.

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

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

URI пространства имён не проверяется как ссылка URI reference. Локальная часть не проверяется как NCName, как указано в Namespaces in 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. Это значение обозначает отсутствие явно определённого пространства имён, как определено в спецификации Namespaces in XML. Это действие сохраняет совместимое поведение с QName 1.0. Явное указание значения XMLConstants.NULL_NS_URI предпочтительнее.

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

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

URI пространства имён не проверяется как ссылка URI reference. Локальная часть и префикс не проверяются как NCName, как указано в Namespaces in 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, как указано в Namespaces in 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.

Parameters:
qNameAsString - String представление QName
Returns:
QName, соответствующий заданному String
Throws:
IllegalArgumentException - Когда qNameAsString является null или имеет неправильный формат
See Also:
  • QName.toString()

© 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://download.java.net/java/early_access/jdk24/docs/api/java.xml/javax/xml/namespace/QName.html

Spec-Zone.ru

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