Spec-Zone.ru › OpenJDK 8

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

Конструкторы

Модификатор Конструктор и описание
protected TypeInfoProvider()

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

Методы

Модификатор и тип Метод и описание
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, будет фактическим типом члена, используемым для валидации элемента.

Возвращает:
Неизменяемый объект 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.

© 1993, 2020, 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