javax.xml.validation
class Validator

java.lang.Object javax.xml.validation.Validator

Most common way to construct:

Schema schema = …;

Validator validator = schema.newValidator();

Based on 223 examples

public abstract class Validator
extends Object

A processor that checks an XML document against {@link Schema}.

A validator object is not thread-safe and not reentrant. In other words, it is the application's responsibility to make sure that one {@link Validator} object is not used from more than one thread at any given time, and while the validate method is invoked, applications may not recursively call the validate method.

Validator

protected Validator()

Constructor for derived classes.

The constructor does nothing.

Derived classes must create {@link Validator} objects that have null {@link ErrorHandler} and null {@link LSResourceResolver}.

getErrorHandler

public abstract ErrorHandler getErrorHandler()

Gets the current {@link ErrorHandler} set to this {@link Validator}.

Returns:

This method returns the object that was last set through the {@link #setErrorHandler(ErrorHandler)} method, or null if that method has never been called since this {@link Validator} has created.

getFeature

public boolean getFeature(String name)
                   throws SAXNotRecognizedException,
                          SAXNotSupportedException

Look up the value of a feature flag.

The feature name is any fully-qualified URI. It is possible for a {@link Validator} 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 - The feature name, which is a non-null fully-qualified URI.

Returns:

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

Throws:

SAXNotRecognizedException - If the feature value can't be assigned or retrieved.

SAXNotSupportedException - When the {@link Validator} recognizes the feature name but cannot determine its value at this time.

getProperty

public Object getProperty(String name)
                   throws SAXNotRecognizedException,
                          SAXNotSupportedException

Look up the value of a property.

The property name is any fully-qualified URI. It is possible for a {@link Validator} 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.

{@link Validator}s 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 - The property name, which is a non-null fully-qualified URI.

Returns:

The current value of the property.

Throws:

SAXNotRecognizedException - If the property value can't be assigned or retrieved.

SAXNotSupportedException - When the XMLReader recognizes the property name but cannot determine its value at this time.

getResourceResolver

public abstract LSResourceResolver getResourceResolver()

Gets the current {@link LSResourceResolver} set to this {@link Validator}.

Returns:

This method returns the object that was last set through the {@link #setResourceResolver(LSResourceResolver)} method, or null if that method has never been called since this {@link Validator} has created.

reset

public abstract void reset()

Reset this Validator to its original configuration.

Validator is reset to the same state as when it was created with {@link Schema#newValidator()}. reset() is designed to allow the reuse of existing Validators thus saving resources associated with the creation of new Validators.

The reset Validator is not guaranteed to have the same {@link LSResourceResolver} or {@link ErrorHandler} Objects, e.g. {@link Object#equals(Object obj)}. It is guaranteed to have a functionally equal LSResourceResolver and ErrorHandler.

setErrorHandler

public abstract void setErrorHandler(ErrorHandler errorHandler)

Sets the {@link ErrorHandler} to receive errors encountered during the validate method invocation.

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

The error handler can abort further validation immediately by throwing {@link 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 {@link ErrorHandler}

If any {@link Throwable} is thrown from an {@link ErrorHandler}, the caller of the validate method will be thrown the same {@link Throwable} object.

{@link Validator} is not allowed to throw {@link SAXException} without first reporting it to {@link ErrorHandler}.

When the {@link ErrorHandler} is null, the implementation will behave as if the following {@link ErrorHandler} is set:

 class DraconianErrorHandler implements {@link ErrorHandler} {
     public void fatalError( {@link org.xml.sax.SAXParseException} e ) throws {@link SAXException} {
         throw e;
     }
     public void error( {@link org.xml.sax.SAXParseException} e ) throws {@link SAXException} {
         throw e;
     }
     public void warning( {@link org.xml.sax.SAXParseException} e ) throws {@link SAXException} {
         // noop
     }
 }
 

When a new {@link Validator} object is created, initially this field is set to null.

Parameters:

errorHandler - A new error handler to be set. This parameter can be null.

setFeature

public void setFeature(String name,
                       boolean value)
                throws SAXNotRecognizedException,
                       SAXNotSupportedException

Set the value of a feature flag.

Feature can be used to control the way a {@link Validator} parses schemas, although {@link Validator}s are not required to recognize any specific feature names.

The feature name is any fully-qualified URI. It is possible for a {@link Validator} 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 - The feature name, which is a non-null fully-qualified URI.

value - The requested value of the feature (true or false).

Throws:

SAXNotRecognizedException - If the feature value can't be assigned or retrieved.

SAXNotSupportedException - When the {@link Validator} recognizes the feature name but cannot set the requested value.

setProperty

public void setProperty(String name,
                        Object object)
                 throws SAXNotRecognizedException,
                        SAXNotSupportedException

Set the value of a property.

The property name is any fully-qualified URI. It is possible for a {@link Validator} 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.

{@link Validator}s are not required to recognize setting any specific property names.

Parameters:

name - The property name, which is a non-null fully-qualified URI.

object - The requested value for the property.

Throws:

SAXNotRecognizedException - If the property value can't be assigned or retrieved.

SAXNotSupportedException - When the {@link Validator} recognizes the property name but cannot set the requested value.

setResourceResolver

public abstract void setResourceResolver(LSResourceResolver resourceResolver)

Sets the {@link LSResourceResolver} to customize resource resolution while in a validation episode.

{@link Validator} uses a {@link 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 {@link LSResourceResolver} is null, the implementation will behave as if the following {@link LSResourceResolver} is set:

 class DumbLSResourceResolver implements {@link LSResourceResolver} {
     public {@link org.w3c.dom.ls.LSInput} resolveResource(
         String publicId, String systemId, String baseURI) {
         
         return null; // always return null
     }
 }
 

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

When a new {@link Validator} object is created, initially this field is set to null.

Parameters:

resourceResolver - A new resource resolver to be set. This parameter can be null.

validate

public void validate(Source source)
              throws SAXException,
                     IOException

Validates the specified input.

This is just a convenience method for {@link #validate(Source source, Result result)} with result of null.

Parameters:

source - XML to be validated. Must be an XML document or XML element and must not be null. For backwards compatibility, the results of attempting to validate anything other than a document or element are implementation-dependent. Implementations must either recognize and process the input or throw an IllegalArgumentException.

Throws:

SAXException - If the {@link ErrorHandler} throws a {@link SAXException} or if a fatal error is found and the {@link ErrorHandler} returns normally.

IOException - If the validator is processing a {@link javax.xml.transform.sax.SAXSource} and the underlying {@link org.xml.sax.XMLReader} throws an {@link IOException}.

validate

public abstract void validate(Source source,
                              Result result)
                       throws SAXException,
                              IOException

Validates the specified input and send the augmented validation result to the specified output.

This method places the following restrictions on the types of the {@link Source}/{@link Result} accepted.

Source / Result Accepted
	{@link javax.xml.transform.stream.StreamSource}	{@link javax.xml.transform.sax.SAXSource}	{@link javax.xml.transform.dom.DOMSource}	{@link javax.xml.transform.stax.StAXSource}
null	OK	OK	OK	OK
{@link javax.xml.transform.stream.StreamResult}	OK	IllegalArgumentException	IllegalArgumentException	IllegalArgumentException
{@link javax.xml.transform.sax.SAXResult}	IllegalArgumentException	OK	IllegalArgumentException	IllegalArgumentException
{@link javax.xml.transform.dom.DOMResult}	IllegalArgumentException	IllegalArgumentException	OK	IllegalArgumentException
{@link javax.xml.transform.stax.StAXResult}	IllegalArgumentException	IllegalArgumentException	IllegalArgumentException	OK

To validate one Source into another kind of Result, use the identity transformer (see {@link javax.xml.transform.TransformerFactory#newTransformer()}).

Errors found during the validation is sent to the specified {@link ErrorHandler}.

If a document is valid, or if a document contains some errors but none of them were fatal and the ErrorHandler didn't throw any exception, then the method returns normally.

Parameters:

source - XML to be validated. Must be an XML document or XML element and must not be null. For backwards compatibility, the results of attempting to validate anything other than a document or element are implementation-dependent. Implementations must either recognize and process the input or throw an IllegalArgumentException.

result - The Result object that receives (possibly augmented) XML. This parameter can be null if the caller is not interested in it. Note that when a DOMResult is used, a validator might just pass the same DOM node from DOMSource to DOMResult (in which case source.getNode()==result.getNode()), it might copy the entire DOM tree, or it might alter the node given by the source.

Throws:

SAXException - If the ErrorHandler throws a SAXException or if a fatal error is found and the ErrorHandler returns normally.

IOException - If the validator is processing a SAXSource and the underlying {@link org.xml.sax.XMLReader} throws an IOException.