Spec-Zone.ru › OpenJDK 25

Класс TypeInfoProvider

java.lang.Object
javax.xml.validation.TypeInfoProvider
public abstract class TypeInfoProvider extends Object
Этот класс предоставляет доступ к информации о типах, определяемой ValidatorHandler.

Некоторые языки схем, такие как W3C XML Schema, рекомендуют валидатору сообщать «тип», который он назначает каждому атрибуту или элементу. Приложениям, которым необходимо получить доступ к этой информации о типах, можно вызывать методы, определённые в этом «интерфейсе», чтобы получить такую информацию.

Реализацию этого «интерфейса» можно получить с помощью метода ValidatorHandler.getTypeInfoProvider().

Начиная с версии:
1.5
См. также:
  • TypeInfo

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

TypeInfoProvider()
Модификатор Конструктор Описание
protected
Конструктор производного класса.

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

Модификатор и тип Метод Описание
abstract TypeInfo getAttributeTypeInfo(int index)
Возвращает неизменяемый объект TypeInfo для указанного атрибута текущего элемента.
abstract TypeInfo getElementTypeInfo()
Возвращает неизменяемый объект TypeInfo для текущего элемента.
abstract boolean isIdAttribute(int index)
Возвращает true, если указанный атрибут определён как ID.
abstract boolean isSpecified(int index)
Возвращает false, если атрибут был добавлен валидатором.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

TypeInfoProvider

protected TypeInfoProvider()
Конструктор производного класса.

Конструктор ничего не делает.

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

getElementTypeInfo

public abstract TypeInfo getElementTypeInfo()

Возвращает неизменяемый объект TypeInfo для текущего элемента.

Этот метод можно вызывать только во время события startElement или endElement объекта ContentHandler, который приложение задаёт для ValidatorHandler.

При выполнении проверки по W3C XML Schema, если элемент имеет объединённый тип, вызов getElementTypeInfo() во время события startElement вернёт TypeInfo, соответствующий объединённому типу. Вызов во время события endElement вернёт TypeInfo, соответствующий фактическому типу-члену, использованному для проверки элемента.

Возвращает:
Неизменяемый объект TypeInfo, представляющий тип текущего элемента. Обратите внимание, что вызывающий код может хранить ссылки на полученный объект TypeInfo дольше, чем существует область действия обратного вызова. В противном случае этот метод возвращает null, если валидатор по какой-либо причине не может определить тип текущего элемента (например, если валидатор восстанавливается после предыдущей ошибки).
Вызывает исключение:
IllegalStateException — если этот метод вызван из других методов ContentHandler.

getAttributeTypeInfo

public abstract TypeInfo getAttributeTypeInfo(int index)
Возвращает неизменяемый объект TypeInfo для указанного атрибута текущего элемента.

Этот метод можно вызывать только во время события startElement объекта ContentHandler, который приложение задаёт для ValidatorHandler.

Параметры:
index — индекс атрибута. Тот же индекс в объекте Attributes, переданном в обратный вызов startElement.
Возвращает:
Неизменяемый объект TypeInfo, представляющий тип указанного атрибута. Обратите внимание, что вызывающий код может хранить ссылки на полученный объект TypeInfo дольше, чем существует область действия обратного вызова. В противном случае этот метод возвращает null, если валидатор не может определить тип.
Вызывает исключение:
IndexOutOfBoundsException — если индекс недопустим.
IllegalStateException — если этот метод вызван из других методов ContentHandler.

isIdAttribute

public abstract boolean isIdAttribute(int index)
Возвращает true, если указанный атрибут определён как ID.

Способ определения атрибута как ID зависит от языка схем. В случае W3C XML Schema это означает, что фактический тип атрибута — встроенный тип ID или производный от него тип.

DocumentBuilder использует эту информацию для корректной реализации метода Attr.isId().

Этот метод можно вызывать только во время события startElement объекта ContentHandler, который приложение задаёт для ValidatorHandler.

Параметры:
index — индекс атрибута. Тот же индекс в объекте Attributes, переданном в обратный вызов startElement.
Возвращает:
true, если тип указанного атрибута — ID.
Вызывает исключение:
IndexOutOfBoundsException — если индекс недопустим.
IllegalStateException — если этот метод вызван из других методов ContentHandler.

isSpecified

public abstract boolean isSpecified(int index)
Возвращает false, если атрибут был добавлен валидатором.

Этот метод предоставляет информацию, необходимую DocumentBuilder для определения того, что дерево DOM должно возвращать из метода Attr.getSpecified().

Этот метод можно вызывать только во время события startElement объекта ContentHandler, который приложение задаёт для ValidatorHandler.

Общее руководство для валидаторов: возвращать true, если атрибут изначально присутствовал в конвейере, и false, если он был добавлен валидатором.

Параметры:
index — индекс атрибута. Тот же индекс в объекте Attributes, переданном в обратный вызов startElement.
Возвращает:
true, если атрибут присутствовал до обработки входных данных валидатором. false, если атрибут был добавлен валидатором.
Вызывает исключение:
IndexOutOfBoundsException — если индекс недопустим.
IllegalStateException — если этот метод вызван из других методов ContentHandler.

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по API и документацию для разработчиков см. в разделе Документация Java SE, содержащем более подробные описания для разработчиков, обзоры основных концепций, определения терминов, обходные решения и примеры работающего кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или её аффилированных лиц в США и других странах.
Авторские права © 1993, 2025, 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.
https://docs.oracle.com/en/java/javase/25/docs/api/java.xml/javax/xml/validation/TypeInfoProvider.html

Spec-Zone.ru

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