Most visited

Recently visited

Results for

Added in API level 8

Summary: Protected Ctors | Methods | Inherited Methods | [Expand All]

TypeInfoProvider

public abstract class TypeInfoProvider
extends Object

java.lang.Object
↳	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 getTypeInfoProvider() method.

See also:

TypeInfo

Summary

Protected constructors
`TypeInfoProvider()` Constructor for the derived class.

Public methods
`abstract TypeInfo`	`getAttributeTypeInfo(int index)` 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(int index)` Returns `true` if the specified attribute is determined to be ID.
`abstract boolean`	`isSpecified(int index)` Returns `false` if the attribute was added by the validator.

Inherited methods

From class


  
    java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Protected constructors

TypeInfoProvider

Added in API level 8

TypeInfoProvider ()

Constructor for the derived class.

The constructor does nothing.

Public methods

getAttributeTypeInfo

Added in API level 8

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 ContentHandler that the application sets to the ValidatorHandler.

Parameters
`index`	`int`: The index of the attribute. The same index for the `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.

Throws
`IndexOutOfBoundsException`	If the index is invalid.
`IllegalStateException`	If this method is called from other `ContentHandler` methods.

getElementTypeInfo

Added in API level 8

TypeInfo getElementTypeInfo ()

Returns the immutable TypeInfo object for the current element.

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

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

Throws
`IllegalStateException`	If this method is called from other `ContentHandler` methods.

isIdAttribute

Added in API level 8

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 DocumentBuilder uses this information to properly implement isId().

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

Parameters
`index`	`int`: The index of the attribute. The same index for the `Attributes` object passed to the `startElement` callback.

Returns
`boolean`	true if the type of the specified attribute is ID.

Throws
`IndexOutOfBoundsException`	If the index is invalid.
`IllegalStateException`	If this method is called from other `ContentHandler` methods.

isSpecified

Added in API level 8

boolean isSpecified (int index)

Returns false if the attribute was added by the validator.

This method provides information necessary for a DocumentBuilder to determine what the DOM tree should return from the getSpecified() method.

The method may only be called by the startElement event of the 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 `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.

Throws
`IndexOutOfBoundsException`	If the index is invalid.
`IllegalStateException`	If this method is called from other `ContentHandler` methods.