Класс 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:

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

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().

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

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

© 1993, 2023, 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/21/docs/api/java.xml/javax/xml/validation/TypeInfoProvider.html