Added in API level 8

TypeInfoProvider

abstract class TypeInfoProvider

kotlin.Any
↳	javax.xml.validation.TypeInfoProvider

This class provides access to the type information determined by ValidatorHandler.

Some schema languages, such as W3C XML Schema, encourages a validator to report the "type" it assigns to each attribute/element. Those applications who wish to access this type information can invoke methods defined on this "interface" to access such type information.

Implementation of this "interface" can be obtained through the ValidatorHandler#getTypeInfoProvider() method.

Summary

Protected constructors
TypeInfoProvider() Constructor for the derived class.

Public methods
abstract TypeInfo!	getAttributeTypeInfo(index: Int) Returns the immutable TypeInfo object for the specified attribute of the current element.
abstract TypeInfo!	getElementTypeInfo() Returns the immutable TypeInfo object for the current element.
abstract Boolean	isIdAttribute(index: Int) Returns true if the specified attribute is determined to be ID.
abstract Boolean	isSpecified(index: Int) Returns false if the attribute was added by the validator.

Protected constructors

TypeInfoProvider

Added in API level 8

protected TypeInfoProvider()

Constructor for the derived class.

The constructor does nothing.

Public methods

getAttributeTypeInfo

Added in API level 8

abstract fun getAttributeTypeInfo(index: Int): TypeInfo!

Returns the immutable TypeInfo object for the specified attribute of the current element.

The method may only be called by the startElement event of the org.xml.sax.ContentHandler that the application sets to the ValidatorHandler.

Parameters
index	Int: The index of the attribute. The same index for the org.xml.sax.Attributes object passed to the startElement callback.

Return
TypeInfo!	An immutable TypeInfo object that represents the type of the specified attribute. Note that the caller can keep references to the obtained TypeInfo longer than the callback scope. Otherwise, this method returns null if the validator is unable to determine the type.

Exceptions
java.lang.IndexOutOfBoundsException	If the index is invalid.
java.lang.IllegalStateException	If this method is called from other org.xml.sax.ContentHandler methods.

getElementTypeInfo

Added in API level 8

abstract fun getElementTypeInfo(): TypeInfo!

Returns the immutable TypeInfo object for the current element.

The method may only be called by the startElement and endElement event of the org.xml.sax.ContentHandler that the application sets to the ValidatorHandler.

Return
TypeInfo!	An immutable TypeInfo object that represents the type of the current element. Note that the caller can keep references to the obtained TypeInfo longer than the callback scope. Otherwise, this method returns null if the validator is unable to determine the type of the current element for some reason (for example, if the validator is recovering from an earlier error.)

Exceptions
java.lang.IllegalStateException	If this method is called from other org.xml.sax.ContentHandler methods.

isIdAttribute

Added in API level 8

abstract fun isIdAttribute(index: Int): Boolean

Returns true if the specified attribute is determined to be ID.

Exactly how an attribute is "determined to be ID" is up to the schema language. In case of W3C XML Schema, this means that the actual type of the attribute is the built-in ID type or its derived type.

A javax.xml.parsers.DocumentBuilder uses this information to properly implement org.w3c.dom.Attr#isId().

The method may only be called by the startElement event of the org.xml.sax.ContentHandler that the application sets to the ValidatorHandler.

Parameters
index	Int: The index of the attribute. The same index for the org.xml.sax.Attributes object passed to the startElement callback.

Return
Boolean	true if the type of the specified attribute is ID.

Exceptions
java.lang.IndexOutOfBoundsException	If the index is invalid.
java.lang.IllegalStateException	If this method is called from other org.xml.sax.ContentHandler methods.

isSpecified

Added in API level 8

abstract fun isSpecified(index: Int): Boolean

Returns false if the attribute was added by the validator.

This method provides information necessary for a javax.xml.parsers.DocumentBuilder to determine what the DOM tree should return from the org.w3c.dom.Attr#getSpecified() method.

The method may only be called by the startElement event of the org.xml.sax.ContentHandler that the application sets to the ValidatorHandler.

A general guideline for validators is to return true if the attribute was originally present in the pipeline, and false if it was added by the validator.

Parameters
index	Int: The index of the attribute. The same index for the org.xml.sax.Attributes object passed to the startElement callback.

Return
Boolean	true if the attribute was present before the validator processes input. false if the attribute was added by the validator.

Exceptions
java.lang.IndexOutOfBoundsException	If the index is invalid.
java.lang.IllegalStateException	If this method is called from other org.xml.sax.ContentHandler methods.