Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
javax.xml.validation.Validator
public abstract class Validator
extends java.lang.Object
Schema
.
A validator is a thread-unsafe and non-reentrant object.
In other words, it is the application's responsibility to make
sure that one 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.
Note that while the validate(Source)
and validate(Source,Result)
methods take a Source
instance, the Source
instance must be a SAXSource
or DOMSource
.
Constructor Summary | |
|
Method Summary | |
abstract ErrorHandler |
|
boolean |
|
Object |
|
abstract LSResourceResolver |
|
abstract void |
|
abstract void |
|
void |
|
void |
|
abstract void |
|
void | |
abstract void |
protected Validator()
Constructor for derived classes. The constructor does nothing. Derived classes must createValidator
objects that have nullErrorHandler
and nullLSResourceResolver
.
public abstract ErrorHandler getErrorHandler()
Gets the currentErrorHandler
set to thisValidator
.
- Returns:
- This method returns the object that was last set through the
setErrorHandler(ErrorHandler)
method, or null if that method has never been called since thisValidator
has created.
- See Also:
setErrorHandler(ErrorHandler)
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 aValidator
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 theValidator
recognizes the feature name but cannot determine its value at this time.
- See Also:
setFeature(String,boolean)
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 aValidator
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.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.
- See Also:
setProperty(String,Object)
public abstract LSResourceResolver getResourceResolver()
Gets the currentLSResourceResolver
set to thisValidator
.
- Returns:
- This method returns the object that was last set through the
setResourceResolver(LSResourceResolver)
method, or null if that method has never been called since thisValidator
has created.
- See Also:
setErrorHandler(ErrorHandler)
public abstract void reset()
Reset thisValidator
to its original configuration.Validator
is reset to the same state as when it was created withSchema.newValidator()
.reset()
is designed to allow the reuse of existingValidator
s thus saving resources associated with the creation of newValidator
s. The resetValidator
is not guaranteed to have the sameLSResourceResolver
orErrorHandler
Object
s, e.g.Object.equals(Object obj)
. It is guaranteed to have a functionally equalLSResourceResolver
andErrorHandler
.
public abstract void setErrorHandler(ErrorHandler errorHandler)
Sets theErrorHandler
to receive errors encountered during thevalidate
method invocation. Error handler can be used to customize the error handling process during a validation. When anErrorHandler
is set, errors found during the validation will be first sent to theErrorHandler
. The error handler can abort further validation immediately by throwingSAXException
from the handler. Or for example it can print an error to the screen and try to continue the validation by returning normally from theErrorHandler
If anyThrowable
is thrown from anErrorHandler
, the caller of thevalidate
method will be thrown the sameThrowable
object.Validator
is not allowed to throwSAXException
without first reporting it toErrorHandler
. When theErrorHandler
is null, the implementation will behave as if the followingErrorHandler
is set:class DraconianErrorHandler implementsWhen a newErrorHandler
{ public void fatalError(SAXParseException
e ) throwsSAXException
{ throw e; } public void error(SAXParseException
e ) throwsSAXException
{ throw e; } public void warning(SAXParseException
e ) throwsSAXException
{ // noop } }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.
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 aValidator
parses schemas, althoughValidator
s are not required to recognize any specific property names. The feature name is any fully-qualified URI. It is possible for aValidator
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 theValidator
recognizes the feature name but cannot set the requested value.
- See Also:
getFeature(String)
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 aValidator
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.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 theValidator
recognizes the property name but cannot set the requested value.
public abstract void setResourceResolver(LSResourceResolver resourceResolver)
Sets theLSResourceResolver
to customize resource resolution while in a validation episode.Validator
uses aLSResourceResolver
when it needs to locate external resources while a validation, although exactly what constitutes "locating external resources" is up to each schema language. When theLSResourceResolver
is null, the implementation will behave as if the followingLSResourceResolver
is set:class DumbLSResourceResolver implementsIf aLSResourceResolver
{ publicLSInput
resolveResource( String publicId, String systemId, String baseURI) { return null; // always return null } }LSResourceResolver
throws aRuntimeException
(or instances of its derived classes), then theValidator
will abort the parsing and the caller of thevalidate
method will receive the sameRuntimeException
. When a newValidator
object is created, initially this field is set to null.
- Parameters:
resourceResolver
- A new resource resolver to be set. This parameter can be null.
public void validate(Source source) throws SAXException, IOException
Validates the specified input. This is just a convenience method of:validate(source,null);
- See Also:
setErrorHandler(ErrorHandler)
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 theSource
/Result
accepted.
Source
/Result
accepted:Note that
SAXSource
DOMSource
null OK OK SAXResult
OK Err DOMResult
Err OK StreamSource
instances are not allowed. To process aStreamSource
, or to validate oneSource
into another kind ofResult
, use the identity transformer (seeTransformerFactory.newTransformer()
). Errors found during the validation is sent to the specifiedErrorHandler
. If a document is valid, or if a document contains some errors but none of them were fatal and theErrorHandler
didn't throw any exception, then the method returns normally.
- Parameters:
source
- XML to be validated. Must not be null.result
- TheResult
object that receives (possibly augmented) XML. This parameter can be null if the caller is not interested in it. Note that when aDOMResult
is used, a validator might just pass the same DOM node fromDOMSource
toDOMResult
(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 theErrorHandler
throws aSAXException
or if a fatal error is found and theErrorHandler
returns normally.
- See Also:
validate(Source)