File	Doc	Category	Size	Date	Package
ValidatorHandler.java	API Doc	Java SE 6 API	19208	Tue Jun 10 00:27:14 BST 2008	javax.xml.validation

ValidatorHandler

• java.lang.Object

Fields Summary

Constructors Summary
protected ValidatorHandler() Constructor for derived classes. The constructor does nothing. Derived classes must create {@link ValidatorHandler} objects that have null {@link ErrorHandler} and null {@link LSResourceResolver}.

Methods Summary
public abstract org.xml.sax.ContentHandler	getContentHandler() Gets the {@link ContentHandler} which receives the augmented validation result. return This method returns the object that was last set through the {@link #getContentHandler()} method, or null if that method has never been called since this {@link ValidatorHandler} has created. see #setContentHandler(ContentHandler)
public abstract org.xml.sax.ErrorHandler	getErrorHandler() Gets the current {@link ErrorHandler} set to this {@link ValidatorHandler}. return 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 ValidatorHandler} has created. see #setErrorHandler(ErrorHandler)
public boolean	getFeature(java.lang.String name) Look up the value of a feature flag. The feature name is any fully-qualified URI. It is possible for a {@link 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. param name The feature name, which is a non-null fully-qualified URI. return The current value of the feature (true or false). throws SAXNotRecognizedException If the feature value can't be assigned or retrieved. throws SAXNotSupportedException When the {@link ValidatorHandler} recognizes the feature name but cannot determine its value at this time. throws NullPointerException When name is null. see #setFeature(String, boolean) if (name == null) { throw new NullPointerException(); } throw new SAXNotRecognizedException(name);
public java.lang.Object	getProperty(java.lang.String name) Look up the value of a property. The property name is any fully-qualified URI. It is possible for a {@link 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. {@link ValidatorHandler}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. param name The property name, which is a non-null fully-qualified URI. return The current value of the property. throws SAXNotRecognizedException If the property value can't be assigned or retrieved. throws SAXNotSupportedException When the XMLReader recognizes the property name but cannot determine its value at this time. throws NullPointerException When name is null. see #setProperty(String, Object) if (name == null) { throw new NullPointerException(); } throw new SAXNotRecognizedException(name);
public abstract org.w3c.dom.ls.LSResourceResolver	getResourceResolver() Gets the current {@link LSResourceResolver} set to this {@link ValidatorHandler}. return 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 ValidatorHandler} has created. see #setErrorHandler(ErrorHandler)
public abstract javax.xml.validation.TypeInfoProvider	getTypeInfoProvider() Obtains the {@link TypeInfoProvider} implementation of this {@link ValidatorHandler}. The obtained {@link 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 null if the validator / schema language does not support the notion of {@link org.w3c.dom.TypeInfo}. Otherwise a non-null valid {@link TypeInfoProvider}.
public abstract void	setContentHandler(org.xml.sax.ContentHandler receiver) Sets the {@link ContentHandler} which receives the augmented validation result. When a {@link ContentHandler} is specified, a {@link ValidatorHandler} will work as a filter and basically copy the incoming events to the specified {@link ContentHandler}. In doing so, a {@link ValidatorHandler} may modify the events, for example by adding defaulted attributes. A {@link ValidatorHandler} may buffer events to certain extent, but to allow {@link ValidatorHandler} to be used by a parser, the following requirement has to be met. When {@link ContentHandler#startElement(String, String, String, Attributes)}, {@link ContentHandler#endElement(String, String, String)}, {@link ContentHandler#startDocument()}, or {@link ContentHandler#endDocument()} are invoked on a {@link ValidatorHandler}, the same method on the user-specified {@link ContentHandler} must be invoked for the same event before the callback returns. {@link ValidatorHandler} may not introduce new elements that were not present in the input. {@link ValidatorHandler} may not remove attributes that were present in the input. When a callback method on the specified {@link ContentHandler} throws an exception, the same exception object must be thrown from the {@link ValidatorHandler}. The {@link ErrorHandler} should not be notified of such an exception. This method can be called even during a middle of a validation. param receiver A {@link ContentHandler} or a null value.
public abstract void	setErrorHandler(org.xml.sax.ErrorHandler errorHandler) Sets the {@link ErrorHandler} to receive errors encountered during the validation. 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 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 {@link ErrorHandler} If any {@link Throwable} is thrown from an {@link ErrorHandler}, the same {@link Throwable} object will be thrown toward the root of the call stack. {@link ValidatorHandler} is not allowed to throw {@link org.xml.sax.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 org.xml.sax.SAXException} { throw e; } public void error( {@link org.xml.sax.SAXParseException} e ) throws {@link org.xml.sax.SAXException} { throw e; } public void warning( {@link org.xml.sax.SAXParseException} e ) throws {@link org.xml.sax.SAXException} { // noop } } When a new {@link ValidatorHandler} object is created, initially this field is set to null. param errorHandler A new error handler to be set. This parameter can be null.
public void	setFeature(java.lang.String name, boolean value) Set a feature for this ValidatorHandler. Feature can be used to control the way a {@link ValidatorHandler} parses schemas. The feature name is any fully-qualified URI. It is possible for a {@link SchemaFactory} 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. All implementations are required to support the {@link javax.xml.XMLConstants#FEATURE_SECURE_PROCESSING} feature. When the feature is: true: the implementation will limit XML processing to conform to implementation limits. Examples include enity expansion limits and XML Schema constructs that would consume large amounts of resources. If XML processing is limited for security reasons, it will be reported via a call to the registered {@link ErrorHandler#fatalError(SAXParseException exception)}. See {@link #setErrorHandler(ErrorHandler errorHandler)}. false: the implementation will processing XML according to the XML specifications without regard to possible implementation limits. param name The feature name, which is a non-null fully-qualified URI. param value The requested value of the feature (true or false). throws SAXNotRecognizedException If the feature value can't be assigned or retrieved. throws SAXNotSupportedException When the {@link ValidatorHandler} recognizes the feature name but cannot set the requested value. throws NullPointerException When name is null. see #getFeature(String) if (name == null) { throw new NullPointerException(); } throw new SAXNotRecognizedException(name);
public void	setProperty(java.lang.String name, java.lang.Object object) Set the value of a property. The property name is any fully-qualified URI. It is possible for a {@link 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. {@link ValidatorHandler}s are not required to recognize setting any specific property names. param name The property name, which is a non-null fully-qualified URI. param object The requested value for the property. throws SAXNotRecognizedException If the property value can't be assigned or retrieved. throws SAXNotSupportedException When the {@link ValidatorHandler} recognizes the property name but cannot set the requested value. throws NullPointerException When name is null. if (name == null) { throw new NullPointerException(); } throw new SAXNotRecognizedException(name);
public abstract void	setResourceResolver(org.w3c.dom.ls.LSResourceResolver resourceResolver) Sets the {@link LSResourceResolver} to customize resource resolution while in a validation episode. {@link ValidatorHandler} 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 ValidatorHandler} will abort the parsing and the caller of the validate method will receive the same {@link RuntimeException}. When a new {@link ValidatorHandler} object is created, initially this field is set to null. param resourceResolver A new resource resolver to be set. This parameter can be null.