Spec-Zone.ru › OpenJDK 27

Класс QName

java.lang.Object
javax.xml.namespace.QName
Все реализуемые интерфейсы:
Serializable
public class QName extends Object implements Serializable

QName представляет квалифицированное имя, определённое в спецификациях XML: XML Schema, часть 2: спецификация типов данных, Пространства имён в 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, часть 2: типы данных
  • Пространства имён в 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()
Возвращает строковое представление этого QName.
static QName valueOf(String qNameAsString)
Возвращает QName по его строковому представлению.

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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Модификатор и тип Метод Описание
protected Object clone()
Создаёт и возвращает копию этого объекта.
protected void finalize()
Устарело, будет удалено: этот элемент API может быть удалён в будущей версии.
Финализация объявлена устаревшей и может быть удалена в одном из следующих выпусков.
final Class<?> getClass()
Возвращает класс времени выполнения этого Object.
final void notify()
Пробуждает один поток, ожидающий на мониторе этого объекта.
final void notifyAll()
Пробуждает все потоки, ожидающие на мониторе этого объекта.
final void wait()
Заставляет текущий поток ожидать пробуждения, обычно в результате уведомления или прерывания.
final void wait(long timeoutMillis)
Заставляет текущий поток ожидать пробуждения, обычно в результате уведомления или прерывания, либо до истечения заданного промежутка реального времени.
final void wait(long timeoutMillis, int nanos)
Заставляет текущий поток ожидать пробуждения, обычно в результате уведомления или прерывания, либо до истечения заданного промежутка реального времени.

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

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)

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

hashCode

public final int hashCode()

Вычисляет хеш-код этого QName.

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

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

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

toString

public String toString()
Возвращает строковое представление этого QName. Формат:
    {NamespaceURI}LocalPart
Если NamespaceURI равно null, возвращается только LocalPart.
Переопределяет:
toString в классе Object
Примечание API:
Prefix не возвращается в строковом представлении.
Возвращает:
строковое представление этого QName

valueOf

public static QName valueOf(String qNameAsString)
Возвращает QName по его строковому представлению. Строковое представление должно иметь формат, возвращаемый методом toString():
    {NamespaceURI}LocalPart
Поскольку Prefix не представлено в строковой форме, ему будет присвоено значение XMLConstants.DEFAULT_NS_PREFIX.
Примечание API:
Этот метод не выполняет полную проверку результирующего QName. NamespaceURI не проверяется на соответствие требованиям к ссылке URI. LocalPart не проверяется на соответствие требованиям к NCName, определённым в спецификации «Пространства имён в XML».
Параметры:
qNameAsString — строковое представление QName
Возвращает:
QName по его строковому представлению
Выбрасывает:
IllegalArgumentException — если qNameAsString равно null или имеет неверный формат
См. также:
  • QName.toString()

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по API и документацию для разработчиков см. в разделе Документация Java SE, содержащем более подробные описания для разработчиков, концептуальные обзоры, определения терминов, обходные решения и работающие примеры кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или её аффилированных лиц в США и других странах.
Авторское право © 1993, 2026, Oracle и/или её аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 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.

Spec-Zone.ru

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