OpenJDK 27 · javax.xml.validation.TypeInfoProvider · APIdia, the JavaDoc alternative

Access	Constructor and Description
protected	TypeInfoProvider() Constructor for the derived class.

Method Summary

Modifier and Type	Method and Description
public abstract TypeInfo	Returns: 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. getAttributeTypeInfo(int The index of the attribute. The same index for the `org.xml.sax.Attributes` object passed to the `startElement` callback. index) Returns the immutable `TypeInfo` object for the specified attribute of the current element.
public abstract TypeInfo	Returns: 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.) getElementTypeInfo() Returns the immutable `TypeInfo` object for the current element.
public abstract boolean	Returns: true if the type of the specified attribute is ID. isIdAttribute(int The index of the attribute. The same index for the `org.xml.sax.Attributes` object passed to the `startElement` callback. index) 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.
public abstract boolean	Returns: `true` if the attribute was present before the validator processes input. `false` if the attribute was added by the validator. isSpecified(int The index of the attribute. The same index for the `org.xml.sax.Attributes` object passed to the `startElement` callback. index) Returns `false` if the attribute was added by the validator.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

TypeInfoProvider	back to summary
protected TypeInfoProvider() Constructor for the derived class. The constructor does nothing.

Method Detail

getAttributeTypeInfo back to summary

getAttributeTypeInfo	back to summary
public abstract TypeInfo getAttributeTypeInfo(int index) 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. Returns: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 IndexOutOfBoundsException: If the index is invalid. IllegalStateException: If this method is called from other `org.xml.sax.ContentHandler` methods.

public abstract TypeInfo getAttributeTypeInfo(int index)

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.

Returns: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

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

getElementTypeInfo back to summary

getElementTypeInfo	back to summary
public abstract TypeInfo getElementTypeInfo() Returns the immutable `TypeInfo` object for the current element. The method may only be called by the startElement event or the endElement event of the `org.xml.sax.ContentHandler` that the application sets to the `ValidatorHandler`. When W3C XML Schema validation is being performed, in the case where an element has a union type, the `TypeInfo` returned by a call to `getElementTypeInfo()` from the startElement event will be the union type. The `TypeInfo` returned by a call from the endElement event will be the actual member type used to validate the element. Returns: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 IllegalStateException: If this method is called from other `org.xml.sax.ContentHandler` methods.

public abstract TypeInfo getElementTypeInfo()

Returns the immutable TypeInfo object for the current element.

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

When W3C XML Schema validation is being performed, in the case where an element has a union type, the TypeInfo returned by a call to getElementTypeInfo() from the startElement event will be the union type. The TypeInfo returned by a call from the endElement event will be the actual member type used to validate the element.

Returns: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

IllegalStateException:: If this method is called from other org.xml.sax.ContentHandler methods.

isIdAttribute back to summary

isIdAttribute	back to summary
public abstract boolean isIdAttribute(int index) 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. Returns:boolean true if the type of the specified attribute is ID. Exceptions IndexOutOfBoundsException: If the index is invalid. IllegalStateException: If this method is called from other `org.xml.sax.ContentHandler` methods.

public abstract boolean isIdAttribute(int index)

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.

Returns:boolean

true if the type of the specified attribute is ID.

Exceptions

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

isSpecified back to summary

isSpecified	back to summary
public abstract boolean isSpecified(int index) 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. Returns:boolean `true` if the attribute was present before the validator processes input. `false` if the attribute was added by the validator. Exceptions IndexOutOfBoundsException: If the index is invalid. IllegalStateException: If this method is called from other `org.xml.sax.ContentHandler` methods.

public abstract boolean isSpecified(int index)

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.

Returns:boolean

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

Exceptions

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

public abstract Class TypeInfoProvider

Constructor Summary

Method Summary

Constructor Detail

Method Detail