Added in API level 8

ValidatorHandler

abstract class ValidatorHandler : ContentHandler

kotlin.Any
↳	javax.xml.validation.ValidatorHandler

Streaming validator that works on SAX stream.

A ValidatorHandler object is a thread-unsafe, non-reentrant object. In other words, it is the application's responsibility to make sure that one ValidatorHandler object is not used from more than one thread at any given time.

ValidatorHandler checks if the SAX events follow the set of constraints described in the associated Schema, and additionally it may modify the SAX events (for example by adding default values, etc.)

ValidatorHandler extends from ContentHandler, but it refines the underlying ContentHandler in the following way:

startElement/endElement events must receive non-null String for uri, localName, and qname, even though SAX allows some of them to be null. Similarly, the user-specified ContentHandler will receive non-null Strings for all three parameters.
Applications must ensure that ValidatorHandler's ContentHandler.startPrefixMapping(String,String) and ContentHandler.endPrefixMapping(String) are invoked properly. Similarly, the user-specified ContentHandler will receive startPrefixMapping/endPrefixMapping events. If the ValidatorHandler introduces additional namespace bindings, the user-specified ContentHandler will receive additional startPrefixMapping/endPrefixMapping events.
org.xml.sax.Attributes for the org.xml.sax.ContentHandler#startElement(java.lang.String,java.lang.String,java.lang.String,Attributes) method may or may not include xmlns* attributes.

A ValidatorHandler is automatically reset every time the startDocument method is invoked.

Recognized Properties and Features

This spec defines the following feature that must be recognized by all ValidatorHandler implementations.

`http://xml.org/sax/features/namespace-prefixes`

This feature controls how a ValidatorHandler introduces namespace bindings that were not present in the original SAX event stream. When this feature is set to true, it must make sure that the user's ContentHandler will see the corresponding xmlns* attribute in the org.xml.sax.Attributes object of the org.xml.sax.ContentHandler#startElement(java.lang.String,java.lang.String,java.lang.String,Attributes) callback. Otherwise, xmlns* attributes must not be added to org.xml.sax.Attributes that's passed to the user-specified ContentHandler.

(Note that regardless of this switch, namespace bindings are always notified to applications through ContentHandler.startPrefixMapping(String,String) and ContentHandler.endPrefixMapping(String) methods of the ContentHandler specified by the user.)

Note that this feature does NOT affect the way a ValidatorHandler receives SAX events. It merely changes the way it augments SAX events.

This feature is set to false by default.

Summary

Protected constructors
`ValidatorHandler()` Constructor for derived classes.

Public methods
abstract ContentHandler!	`getContentHandler()` Gets the `ContentHandler` which receives the augmented validation result.
abstract ErrorHandler!	`getErrorHandler()` Gets the current `ErrorHandler` set to this `ValidatorHandler`.
open Boolean	`getFeature(name: String!)` Look up the value of a feature flag.
open Any!	`getProperty(name: String!)` Look up the value of a property.
abstract LSResourceResolver!	`getResourceResolver()` Gets the current `LSResourceResolver` set to this `ValidatorHandler`.
abstract TypeInfoProvider!	`getTypeInfoProvider()` Obtains the `TypeInfoProvider` implementation of this `ValidatorHandler`.
abstract Unit	`setContentHandler(receiver: ContentHandler!)` Sets the `ContentHandler` which receives the augmented validation result.
abstract Unit	`setErrorHandler(errorHandler: ErrorHandler!)` Sets the `ErrorHandler` to receive errors encountered during the validation.
open Unit	`setFeature(name: String!, value: Boolean)` Set the value of a feature flag.
open Unit	`setProperty(name: String!, object: Any!)` Set the value of a property.
abstract Unit	`setResourceResolver(resourceResolver: LSResourceResolver!)` Sets the `LSResourceResolver` to customize resource resolution while in a validation episode.

Inherited functions

From class ContentHandler

`Unit`	`characters(ch: CharArray!, start: Int, length: Int)` Receive notification of character data. The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity so that the Locator provides useful information. The application must not attempt to read from the array outside of the specified range. Individual characters may consist of more than one Java `char` value. There are two important cases where this happens, because characters can't be represented in just sixteen bits. In one case, characters are represented in a Surrogate Pair, using two special Unicode values. Such characters are in the so-called "Astral Planes", with a code point above U+FFFF. A second case involves composite characters, such as a base character combining with one or more accent characters. Your code should not assume that algorithms using `char`-at-a-time idioms will be working in character units; in some cases they will split characters. This is relevant wherever XML permits arbitrary characters, such as attribute values, processing instruction data, and comments as well as in data reported from this method. It's also generally relevant whenever Java code manipulates internationalized text; the issue isn't unique to XML. Note that some parsers will report whitespace in element content using the `ignorableWhitespace` method rather than this one (validating parsers must do so).
`Unit`	`endDocument()` Receive notification of the end of a document. There is an apparent contradiction between the documentation for this method and the documentation for `org.xml.sax.ErrorHandler#fatalError`. Until this ambiguity is resolved in a future major release, clients should make no assumptions about whether endDocument() will or will not be invoked when the parser has reported a fatalError() or thrown an exception. The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.
`Unit`	`endElement(uri: String!, localName: String!, qName: String!)` Receive notification of the end of an element. The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding `startElement` event for every endElement event (even when the element is empty). For information on the names, see startElement.
`Unit`	`endPrefixMapping(prefix: String!)` End the scope of a prefix-URI mapping. See `startPrefixMapping` for details. These events will always occur immediately after the corresponding `endElement` event, but the order of `endPrefixMapping` events is not otherwise guaranteed.
`Unit`	`ignorableWhitespace(ch: CharArray!, start: Int, length: Int)` Receive notification of ignorable whitespace in element content. Validating Parsers must use this method to report each chunk of whitespace in element content (see the W3C XML 1.0 recommendation, section 2.10): non-validating parsers may also use this method if they are capable of parsing and using content models. SAX parsers may return all contiguous whitespace in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information. The application must not attempt to read from the array outside of the specified range.
`Unit`	`processingInstruction(target: String!, data: String!)` Receive notification of a processing instruction. The Parser will invoke this method once for each processing instruction found: note that processing instructions may occur before or after the main document element. A SAX parser must never report an XML declaration (XML 1.0, section 2.8) or a text declaration (XML 1.0, section 4.3.1) using this method. Like `characters()`, processing instruction data may have characters that need more than one `char` value.
`Unit`	`setDocumentLocator(locator: Locator!)` Receive an object for locating the origin of SAX document events. SAX parsers are strongly encouraged (though not absolutely required) to supply a locator: if it does so, it must supply the locator to the application by invoking this method before invoking any of the other methods in the ContentHandler interface. The locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error. Typically, the application will use this information for reporting its own errors (such as character content that does not match an application's business rules). The information returned by the locator is probably not sufficient for use with a search engine. Note that the locator will return correct information only during the invocation SAX event callbacks after `startDocument` returns and before `endDocument` is called. The application should not attempt to use it at any other time.
`Unit`	`skippedEntity(name: String!)` Receive notification of a skipped entity. This is not called for entity references within markup constructs such as element start tags or markup declarations. (The XML recommendation requires reporting skipped external entities. SAX also reports internal entity expansion/non-expansion, except within markup constructs.) The Parser will invoke this method each time the entity is skipped. Non-validating processors may skip entities if they have not seen the declarations (because, for example, the entity was declared in an external DTD subset). All processors may skip external entities, depending on the values of the `http://xml.org/sax/features/external-general-entities` and the `http://xml.org/sax/features/external-parameter-entities` properties.
`Unit`	`startDocument()` Receive notification of the beginning of a document. The SAX parser will invoke this method only once, before any other event callbacks (except for `setDocumentLocator`).
`Unit`	`startElement(uri: String!, localName: String!, qName: String!, atts: Attributes!)` Receive notification of the beginning of an element. The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding `endElement` event for every startElement event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding endElement event. This event allows up to three name components for each element: the Namespace URI; the local name; and the qualified (prefixed) name. Any or all of these may be provided, depending on the values of the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes properties: the Namespace URI and local name are required when the namespaces property is true (the default), and are optional when the namespaces property is false (if one is specified, both must be); the qualified name is required when the namespace-prefixes property is true, and is optional when the namespace-prefixes property is false (the default). Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted. The attribute list will contain attributes used for Namespace declarations (xmlns* attributes) only if the `http://xml.org/sax/features/namespace-prefixes` property is true (it is false by default, and support for a true value is optional). Like `characters()`, attribute values may have characters that need more than one `char` value.
`Unit`	`startPrefixMapping(prefix: String!, uri: String!)` Begin the scope of a prefix-URI Namespace mapping. The information from this event is not necessary for normal Namespace processing: the SAX XML reader will automatically replace prefixes for element and attribute names when the `http://xml.org/sax/features/namespaces` feature is true (the default). There are cases, however, when applications need to use prefixes in character data or in attribute values, where they cannot safely be expanded automatically; the start/endPrefixMapping event supplies the information to the application to expand prefixes in those contexts itself, if necessary. Note that start/endPrefixMapping events are not guaranteed to be properly nested relative to each other: all startPrefixMapping events will occur immediately before the corresponding `startElement` event, and all `endPrefixMapping` events will occur immediately after the corresponding `endElement` event, but their order is not otherwise guaranteed. There should never be start/endPrefixMapping events for the "xml" prefix, since it is predeclared and immutable.

Protected constructors

ValidatorHandler

Added in API level 8

protected ValidatorHandler()

Constructor for derived classes.

The constructor does nothing.

Derived classes must create ValidatorHandler objects that have null ErrorHandler and null LSResourceResolver.

Public methods

getContentHandler

Added in API level 8

abstract fun getContentHandler(): ContentHandler!

Gets the ContentHandler which receives the augmented validation result.

Return
`ContentHandler!`	This method returns the object that was last set through the `getContentHandler()` method, or null if that method has never been called since this `ValidatorHandler` has created.

See Also

#setContentHandler(ContentHandler)

getErrorHandler

Added in API level 8

abstract fun getErrorHandler(): ErrorHandler!

Gets the current ErrorHandler set to this ValidatorHandler.

Return
`ErrorHandler!`	This method returns the object that was last set through the `setErrorHandler(org.xml.sax.ErrorHandler)` method, or null if that method has never been called since this `ValidatorHandler` has created.

See Also

#setErrorHandler(ErrorHandler)

getFeature

Added in API level 8

open fun getFeature(name: String!): Boolean

Look up the value of a feature flag.

The feature name is any fully-qualified URI. It is possible for a ValidatorHandler to recognize a feature name but temporarily be unable to return its value. Some feature values may be available only in specific contexts, such as before, during, or after a validation.

Implementors are free (and encouraged) to invent their own features, using names built on their own URIs.

Parameters
`name`	String!: The feature name, which is a non-null fully-qualified URI.

Return
`Boolean`	The current value of the feature (true or false).

Exceptions
`java.lang.NullPointerException`	When the name parameter is null.
`org.xml.sax.SAXNotRecognizedException`	If the feature value can't be assigned or retrieved.
`org.xml.sax.SAXNotSupportedException`	When the `ValidatorHandler` recognizes the feature name but cannot determine its value at this time.

See Also

#setFeature(String, boolean)

getProperty

Added in API level 8

open fun getProperty(name: String!): Any!

Look up the value of a property.

The property name is any fully-qualified URI. It is possible for a ValidatorHandler to recognize a property name but temporarily be unable to return its value. Some property values may be available only in specific contexts, such as before, during, or after a validation.

ValidatorHandlers are not required to recognize any specific property names.

Implementors are free (and encouraged) to invent their own properties, using names built on their own URIs.

Parameters
`name`	String!: The property name, which is a non-null fully-qualified URI.

Return
`Any!`	The current value of the property.

Exceptions
`java.lang.NullPointerException`	When the name parameter is null.
`org.xml.sax.SAXNotRecognizedException`	If the property value can't be assigned or retrieved.
`org.xml.sax.SAXNotSupportedException`	When the XMLReader recognizes the property name but cannot determine its value at this time.

See Also

#setProperty(String, Object)

getResourceResolver

Added in API level 8

abstract fun getResourceResolver(): LSResourceResolver!

Gets the current LSResourceResolver set to this ValidatorHandler.

Return
`LSResourceResolver!`	This method returns the object that was last set through the `setResourceResolver(org.w3c.dom.ls.LSResourceResolver)` method, or null if that method has never been called since this `ValidatorHandler` has created.

See Also

#setErrorHandler(ErrorHandler)

getTypeInfoProvider

Added in API level 8

abstract fun getTypeInfoProvider(): TypeInfoProvider!

Obtains the TypeInfoProvider implementation of this ValidatorHandler.

The obtained TypeInfoProvider can be queried during a parse to access the type information determined by the validator.

Some schema languages do not define the notion of type, for those languages, this method may not be supported. However, to be compliant with this specification, implementations for W3C XML Schema 1.0 must support this operation.

Return
`TypeInfoProvider!`	null if the validator / schema language does not support the notion of `org.w3c.dom.TypeInfo`. Otherwise a non-null valid `TypeInfoProvider`.

setContentHandler

Added in API level 8

abstract fun setContentHandler(receiver: ContentHandler!): Unit

Sets the ContentHandler which receives the augmented validation result.

When a ContentHandler is specified, a ValidatorHandler will work as a filter and basically copy the incoming events to the specified ContentHandler.

In doing so, a ValidatorHandler may modify the events, for example by adding defaulted attributes.

A ValidatorHandler may buffer events to certain extent, but to allow ValidatorHandler to be used by a parser, the following requirement has to be met.

When org.xml.sax.ContentHandler#startElement(java.lang.String,java.lang.String,java.lang.String,Attributes), ContentHandler.endElement(String, String, String), ContentHandler.startDocument(), or ContentHandler.endDocument() are invoked on a ValidatorHandler, the same method on the user-specified ContentHandler must be invoked for the same event before the callback returns.
ValidatorHandler may not introduce new elements that were not present in the input.
ValidatorHandler may not remove attributes that were present in the input.

When a callback method on the specified ContentHandler throws an exception, the same exception object must be thrown from the ValidatorHandler. The ErrorHandler should not be notified of such an exception.

This method can be called even during a middle of a validation.

Parameters
`receiver`	ContentHandler!: A `ContentHandler` or a null value.

setErrorHandler

Added in API level 8

abstract fun setErrorHandler(errorHandler: ErrorHandler!): Unit

Sets the ErrorHandler to receive errors encountered during the validation.

Error handler can be used to customize the error handling process during a validation. When an ErrorHandler is set, errors found during the validation will be first sent to the ErrorHandler.

The error handler can abort further validation immediately by throwing org.xml.sax.SAXException from the handler. Or for example it can print an error to the screen and try to continue the validation by returning normally from the ErrorHandler

If any Throwable is thrown from an ErrorHandler, the same Throwable object will be thrown toward the root of the call stack.

ValidatorHandler is not allowed to throw org.xml.sax.SAXException without first reporting it to ErrorHandler.

When the ErrorHandler is null, the implementation will behave as if the following ErrorHandler is set:

class DraconianErrorHandler implements <code><a docref="org.xml.sax.ErrorHandler">ErrorHandler</a></code>{
      public void fatalError( <code><a docref="org.xml.sax.SAXParseException">org.xml.sax.SAXParseException</a></code>e ) throws <code><a docref="org.xml.sax.SAXException">org.xml.sax.SAXException</a></code>{
          throw e;
      }
      public void error( <code><a docref="org.xml.sax.SAXParseException">org.xml.sax.SAXParseException</a></code>e ) throws <code><a docref="org.xml.sax.SAXException">org.xml.sax.SAXException</a></code>{
          throw e;
      }
      public void warning( <code><a docref="org.xml.sax.SAXParseException">org.xml.sax.SAXParseException</a></code>e ) throws <code><a docref="org.xml.sax.SAXException">org.xml.sax.SAXException</a></code>{
          // noop
      }
  }

When a new ValidatorHandler object is created, initially this field is set to null.

Parameters
`errorHandler`	ErrorHandler!: A new error handler to be set. This parameter can be null.

setFeature

Added in API level 8

open fun setFeature(
    name: String!, 
    value: Boolean
): Unit

Set the value of a feature flag.

Feature can be used to control the way a ValidatorHandler parses schemas, although ValidatorHandlers are not required to recognize any specific property names.

The feature name is any fully-qualified URI. It is possible for a ValidatorHandler to expose a feature value but to be unable to change the current value. Some feature values may be immutable or mutable only in specific contexts, such as before, during, or after a validation.

Parameters
`name`	String!: The feature name, which is a non-null fully-qualified URI.
`value`	Boolean: The requested value of the feature (true or false).

Exceptions
`java.lang.NullPointerException`	When the name parameter is null.
`org.xml.sax.SAXNotRecognizedException`	If the feature value can't be assigned or retrieved.
`org.xml.sax.SAXNotSupportedException`	When the `ValidatorHandler` recognizes the feature name but cannot set the requested value.

See Also

#getFeature(String)

setProperty

Added in API level 8

open fun setProperty(
    name: String!, 
    object: Any!
): Unit

Set the value of a property.

The property name is any fully-qualified URI. It is possible for a ValidatorHandler to recognize a property name but to be unable to change the current value. Some property values may be immutable or mutable only in specific contexts, such as before, during, or after a validation.

ValidatorHandlers are not required to recognize setting any specific property names.

Parameters
`name`	String!: The property name, which is a non-null fully-qualified URI.
`object`	Any!: The requested value for the property.

Exceptions
`java.lang.NullPointerException`	When the name parameter is null.
`org.xml.sax.SAXNotRecognizedException`	If the property value can't be assigned or retrieved.
`org.xml.sax.SAXNotSupportedException`	When the `ValidatorHandler` recognizes the property name but cannot set the requested value.

setResourceResolver

Added in API level 8

abstract fun setResourceResolver(resourceResolver: LSResourceResolver!): Unit

Sets the LSResourceResolver to customize resource resolution while in a validation episode.

ValidatorHandler uses a LSResourceResolver when it needs to locate external resources while a validation, although exactly what constitutes "locating external resources" is up to each schema language.

When the LSResourceResolver is null, the implementation will behave as if the following LSResourceResolver is set:

class DumbLSResourceResolver implements <code><a docref="org.w3c.dom.ls.LSResourceResolver">LSResourceResolver</a></code>{
      public <code><a docref="org.w3c.dom.ls.LSInput">org.w3c.dom.ls.LSInput</a></code>resolveResource(
          String publicId, String systemId, String baseURI) {
 
          return null; // always return null
      }
  }

If a LSResourceResolver throws a RuntimeException (or instances of its derived classes), then the ValidatorHandler will abort the parsing and the caller of the validate method will receive the same RuntimeException.

When a new ValidatorHandler object is created, initially this field is set to null.

Parameters
`resourceResolver`	LSResourceResolver!: A new resource resolver to be set. This parameter can be null.