Spec-Zone.ru › OpenJDK 24

Класс TypeInfoProvider

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

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

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

Since:
1.5
See Also:
  • 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, если атрибут был добавлен валидатором.

Методы, унаследованные от класса java.lang.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, в случае, если элемент имеет тип объединения, TypeInfo, возвращённый вызовом getElementTypeInfo() из события startElement, будет типом объединения. TypeInfo, возвращённый вызовом из события endElement, будет фактическим типом члена, используемым для валидации элемента.

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

getAttributeTypeInfo

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

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

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

isIdAttribute

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

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

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

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

Parameters:
index - Индекс атрибута. Тот же индекс, что и для объекта Attributes, переданного в обратный вызов startElement.
Returns:
true, если тип указанного атрибута — ID.
Throws:
IndexOutOfBoundsException - Если индекс некорректен.
IllegalStateException - Если этот метод вызван из других методов ContentHandler.

isSpecified

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

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

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

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

Parameters:
index - Индекс атрибута. Тот же индекс, что и для объекта Attributes, переданного в обратный вызов startElement.
Returns:
true, если атрибут был до обработки валидатором. false, если атрибут был добавлен валидатором.
Throws:
IndexOutOfBoundsException - Если индекс некорректен.
IllegalStateException - Если этот метод вызван из других методов ContentHandler.

© 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/validation/TypeInfoProvider.html

Spec-Zone.ru

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