Modifier and Type	Class and Description
public static class	XMLValidateTask.Attribute The class to create to set a feature of the parser.
public static class	XMLValidateTask.Property A Parser property.
protected class	XMLValidateTask.ValidatorErrorHandler ValidatorErrorHandler role : log SAX parse exceptions, remember if an error occurred

Modifier and Type	Field and Description
private Vector<XMLValidateTask.Attribute>	attributeList The vector to store all attributes (features) to be set on the parser.
protected Path	classpath
protected XMLValidateTask.ValidatorErrorHandler	errorHandler
protected boolean	failOnError
protected File	file file to be validated
private static final FileUtils	FILE_UTILS helper for path -> URI and URI -> path conversions.
protected Vector<FileSet>	filesets sets of file to be validated
protected static final String	INIT_FAILED_MSG
protected boolean	lenient
public static final String	MESSAGE_FILES_VALIDATED Message for successful validation
private final Vector<XMLValidateTask.Property>	propertyList List of properties.
protected String	readerClassName
private AntClassLoader	readerLoader
protected boolean	warn
private XMLCatalog	xmlCatalog
protected XMLReader	xmlReader the parser is viewed as a SAX2 XMLReader.

Access	Constructor and Description
public	XMLValidateTask()

Method Summary

Modifier and Type	Method and Description
public void	addConfiguredXMLCatalog(XMLCatalog XMLCatalog to use catalog) add an XMLCatalog as a nested element; optional.
public void	addFileset(FileSet the fileset to check set) specify a set of file to be checked
protected void	cleanup() Cleans up resources.
public XMLValidateTask.Attribute	Returns: attribute created createAttribute() Add an attribute nested element.
public Path	Returns: the classpath created createClasspath()
protected XMLReader	Returns: a new reader. createDefaultReader() Create a reader if the use of the class did not specify another one.
private Object	Returns: reader or parser createDefaultReaderOrParser() Returns a SAX-based XMLReader or a SAX-based Parser.
public DTDLocation	Returns: created DTD location createDTD() Create a DTD location record; optional.
public XMLValidateTask.Property	Returns: a property. createProperty() Creates a property.
protected XMLReader	Returns: the new XMLReader. createXmlReader() create the XML reader.
protected boolean	Returns: true if the file validates. doValidate(File the file to validate. afile) parse the file
public void	execute() Overrides org.apache.tools.ant.Task.execute. execute the task
protected EntityResolver	Returns: xmlCatalog reference getEntityResolver() accessor to the xmlCatalog used in the task
protected XMLReader	Returns: the XML reader or null. getXmlReader() get the XML reader.
public void	init() Overrides org.apache.tools.ant.Task.init. Called by the project to let the task initialize properly.
protected void	initValidator() init the parser : load the parser class, and set features if necessary It is only after this that the reader is valid
protected boolean	Returns: true when a SAX1 parser is in use isSax1Parser() test that returns true if we are using a SAX1 parser.
protected void	onSuccessfulValidation(int number of files processed. fileProcessed) handler called on successful file validation.
public void	setClassName(String should be an implementation of SAX2 `org.xml.sax.XMLReader` or SAX2 `org.xml.sax.Parser`. If className is an implementation of `org.xml.sax.Parser`, `setLenient(boolean)`, will be ignored. If not set, the default will be used. className) Specify the class name of the SAX parser to be used.
public void	setClasspath(Path the classpath to load the parser classpath) Specify the classpath to be searched to load the parser (optional)
public void	setClasspathRef(Reference reference to a classpath defined elsewhere r) Where to find the parser class; optional.
public void	setFailOnError(boolean if set to `false` do not fail on error fail) Specify how parser error are to be handled.
protected void	setFeature(String the name of the feature to set feature, boolean the value of the feature value) Set a feature on the parser.
public void	setFile(File the file to be checked file) specify the file to be checked; optional.
public void	setLenient(boolean if set to `false` only fail on malformed XML bool) Specify whether the parser should be validating.
protected void	setProperty(String a property name name, String a property value. value) Sets a property.
public void	setWarn(boolean if set to `false` do not send warnings bool) Specify how parser error are to be handled.

Field Detail

attributeList	back to summary
private Vector<XMLValidateTask.Attribute> attributeList The vector to store all attributes (features) to be set on the parser.

classpath	back to summary
protected Path classpath

errorHandler	back to summary
protected XMLValidateTask.ValidatorErrorHandler errorHandler

failOnError	back to summary
protected boolean failOnError

file	back to summary
protected File file file to be validated

FILE_UTILS	back to summary
private static final FileUtils FILE_UTILS helper for path -> URI and URI -> path conversions.

filesets	back to summary
protected Vector<FileSet> filesets sets of file to be validated

INIT_FAILED_MSG	back to summary
protected static final String INIT_FAILED_MSG

lenient	back to summary
protected boolean lenient

MESSAGE_FILES_VALIDATED	back to summary
public static final String MESSAGE_FILES_VALIDATED Message for successful validation

propertyList	back to summary
private final Vector<XMLValidateTask.Property> propertyList List of properties.

readerClassName	back to summary
protected String readerClassName

readerLoader	back to summary
private AntClassLoader readerLoader

warn	back to summary
protected boolean warn

xmlCatalog	back to summary
private XMLCatalog xmlCatalog

xmlReader	back to summary
protected XMLReader xmlReader the parser is viewed as a SAX2 XMLReader. If a SAX1 parser is specified, it's wrapped in an adapter that make it behave as a XMLReader. a more 'standard' way of doing this would be to use the JAXP1.1 SAXParser interface.

Constructor Detail

XMLValidateTask	back to summary
public XMLValidateTask()

Method Detail

addConfiguredXMLCatalog	back to summary
public void addConfiguredXMLCatalog(XMLCatalog catalog) add an XMLCatalog as a nested element; optional. Parameters catalog:XMLCatalog XMLCatalog to use

addConfiguredXMLCatalog

back to summary

public void addConfiguredXMLCatalog(XMLCatalog catalog)

add an XMLCatalog as a nested element; optional.

Parameters

catalog:XMLCatalog: XMLCatalog to use

addFileset	back to summary
public void addFileset(FileSet set) specify a set of file to be checked Parameters set:FileSet the fileset to check

addFileset

back to summary

public void addFileset(FileSet set)

specify a set of file to be checked

Parameters

set:FileSet: the fileset to check

cleanup	back to summary
protected void cleanup() Cleans up resources. Since Ant 1.8.0

cleanup

back to summary

protected void cleanup()

Cleans up resources.

Since: Ant 1.8.0

createAttribute	back to summary
public XMLValidateTask.Attribute createAttribute() Add an attribute nested element. This is used for setting arbitrary features of the SAX parser. Valid attributes include Returns:XMLValidateTask.Attribute attribute created Since ant1.6

createAttribute

back to summary

public XMLValidateTask.Attribute createAttribute()

Add an attribute nested element. This is used for setting arbitrary features of the SAX parser. Valid attributes include

Returns:XMLValidateTask.Attribute: attribute created
Since: ant1.6

createClasspath	back to summary
public Path createClasspath() Returns:Path the classpath created See Also `setClasspath`

createDefaultReader	back to summary
protected XMLReader createDefaultReader() Create a reader if the use of the class did not specify another one. If a BuildException is thrown, the caller may revert to an alternate reader. Returns:XMLReader a new reader. Exceptions BuildException: if something went wrong

createDefaultReader

back to summary

protected XMLReader createDefaultReader()

Create a reader if the use of the class did not specify another one. If a BuildException is thrown, the caller may revert to an alternate reader.

Returns:XMLReader

a new reader.

Exceptions

BuildException:: if something went wrong

createDefaultReaderOrParser	back to summary
private Object createDefaultReaderOrParser() Returns a SAX-based XMLReader or a SAX-based Parser. Returns:Object reader or parser

createDefaultReaderOrParser

back to summary

private Object createDefaultReaderOrParser()

Returns a SAX-based XMLReader or a SAX-based Parser.

Returns:Object: reader or parser

createDTD	back to summary
public DTDLocation createDTD() Create a DTD location record; optional. This stores the location of a DTD. The DTD is identified by its public Id. Returns:DTDLocation created DTD location

createDTD

back to summary

public DTDLocation createDTD()

Create a DTD location record; optional. This stores the location of a DTD. The DTD is identified by its public Id.

Returns:DTDLocation: created DTD location

createProperty	back to summary
public XMLValidateTask.Property createProperty() Creates a property. Returns:XMLValidateTask.Property a property. Since ant 1.6.2

createProperty

back to summary

public XMLValidateTask.Property createProperty()

Creates a property.

Returns:XMLValidateTask.Property: a property.
Since: ant 1.6.2

createXmlReader back to summary

createXmlReader	back to summary
protected XMLReader createXmlReader() create the XML reader. This is one by instantiating anything specified by `readerClassName`, falling back to a default reader if not. If the returned reader is an instance of `ParserAdapter` then we have created and wrapped a SAX1 parser. Returns:XMLReader the new XMLReader.

protected XMLReader createXmlReader()

create the XML reader. This is one by instantiating anything specified by readerClassName, falling back to a default reader if not. If the returned reader is an instance of ParserAdapter then we have created and wrapped a SAX1 parser.

Returns:XMLReader: the new XMLReader.

doValidate	back to summary
protected boolean doValidate(File afile) parse the file Parameters afile:File the file to validate. Returns:boolean true if the file validates.

doValidate

back to summary

protected boolean doValidate(File afile)

parse the file

Parameters

afile:File: the file to validate.

Returns:boolean

true if the file validates.

execute back to summary

execute	back to summary
public void execute() throws BuildException Overrides org.apache.tools.ant.Task.execute. execute the task Exceptions BuildException: if `failonerror` is true and an error happens

public void execute() throws BuildException

Overrides org.apache.tools.ant.Task.execute.

execute the task

Exceptions

BuildException:: if failonerror is true and an error happens

getEntityResolver	back to summary
protected EntityResolver getEntityResolver() accessor to the xmlCatalog used in the task Returns:EntityResolver xmlCatalog reference

getEntityResolver

back to summary

protected EntityResolver getEntityResolver()

accessor to the xmlCatalog used in the task

Returns:EntityResolver: xmlCatalog reference

getXmlReader back to summary

getXmlReader	back to summary
protected XMLReader getXmlReader() get the XML reader. Non-null only after `initValidator()`. If the reader is an instance of `ParserAdapter` then the parser is a SAX1 parser, and you cannot call `setFeature(String, boolean)` or `setProperty(String, String)` on it. Returns:XMLReader the XML reader or null.

protected XMLReader getXmlReader()

get the XML reader. Non-null only after initValidator(). If the reader is an instance of ParserAdapter then the parser is a SAX1 parser, and you cannot call setFeature(String, boolean) or setProperty(String, String) on it.

Returns:XMLReader: the XML reader or null.

init	back to summary
public void init() throws BuildException Overrides org.apache.tools.ant.Task.init. Called by the project to let the task initialize properly. Exceptions BuildException: if something goes wrong with the build

init

back to summary

public void init() throws BuildException

Overrides org.apache.tools.ant.Task.init.

Called by the project to let the task initialize properly.

Exceptions

BuildException:: if something goes wrong with the build

initValidator	back to summary
protected void initValidator() init the parser : load the parser class, and set features if necessary It is only after this that the reader is valid Exceptions BuildException: if something went wrong

initValidator

back to summary

protected void initValidator()

init the parser : load the parser class, and set features if necessary It is only after this that the reader is valid

Exceptions

BuildException:: if something went wrong

isSax1Parser	back to summary
protected boolean isSax1Parser() test that returns true if we are using a SAX1 parser. Returns:boolean true when a SAX1 parser is in use

isSax1Parser

back to summary

protected boolean isSax1Parser()

test that returns true if we are using a SAX1 parser.

Returns:boolean: true when a SAX1 parser is in use

onSuccessfulValidation	back to summary
protected void onSuccessfulValidation(int fileProcessed) handler called on successful file validation. Parameters fileProcessed:int number of files processed.

onSuccessfulValidation

back to summary

protected void onSuccessfulValidation(int fileProcessed)

handler called on successful file validation.

Parameters

fileProcessed:int: number of files processed.

setClassName back to summary

setClassName	back to summary
public void setClassName(String className) Specify the class name of the SAX parser to be used. (optional) Parameters className:String should be an implementation of SAX2 `org.xml.sax.XMLReader` or SAX2 `org.xml.sax.Parser`. If className is an implementation of `org.xml.sax.Parser`, `setLenient(boolean)`, will be ignored. If not set, the default will be used. See Also `org.xml.sax.XMLReader`, `org.xml.sax.Parser`

public void setClassName(String className)

Specify the class name of the SAX parser to be used. (optional)

Parameters

className:String

should be an implementation of SAX2 org.xml.sax.XMLReader or SAX2 org.xml.sax.Parser.

If className is an implementation of org.xml.sax.Parser, setLenient(boolean), will be ignored.

If not set, the default will be used.

setClasspath	back to summary
public void setClasspath(Path classpath) Specify the classpath to be searched to load the parser (optional) Parameters classpath:Path the classpath to load the parser

setClasspath

back to summary

public void setClasspath(Path classpath)

Specify the classpath to be searched to load the parser (optional)

Parameters

classpath:Path: the classpath to load the parser

setClasspathRef back to summary

setClasspathRef	back to summary
public void setClasspathRef(Reference r) Where to find the parser class; optional. Parameters r:Reference reference to a classpath defined elsewhere See Also `setClasspath`

public void setClasspathRef(Reference r)

Where to find the parser class; optional.

Parameters

r:Reference: reference to a classpath defined elsewhere

See Also

setClasspath

setFailOnError back to summary

setFailOnError	back to summary
public void setFailOnError(boolean fail) Specify how parser error are to be handled. Optional, default is `true`. If set to `true` (default), throw a buildException if the parser yields an error. Parameters fail:boolean if set to `false` do not fail on error

public void setFailOnError(boolean fail)

Specify how parser error are to be handled. Optional, default is true.

If set to true (default), throw a buildException if the parser yields an error.

Parameters

fail:boolean: if set to false do not fail on error

setFeature	back to summary
protected void setFeature(String feature, boolean value) throws BuildException Set a feature on the parser. Parameters feature:String the name of the feature to set value:boolean the value of the feature Exceptions BuildException: if the feature was not supported

setFeature

back to summary

protected void setFeature(String feature, boolean value) throws BuildException

Set a feature on the parser.

Parameters

feature:String: the name of the feature to set
value:boolean: the value of the feature

Exceptions

BuildException:: if the feature was not supported

setFile	back to summary
public void setFile(File file) specify the file to be checked; optional. Parameters file:File the file to be checked

setFile

back to summary

public void setFile(File file)

specify the file to be checked; optional.

Parameters

file:File: the file to be checked

setLenient back to summary

setLenient	back to summary
public void setLenient(boolean bool) Specify whether the parser should be validating. Default is `true`. If set to false, the validation will fail only if the parsed document is not well formed XML. this option is ignored if the specified class with `setClassName(String)` is not a SAX2 XMLReader. Parameters bool:boolean if set to `false` only fail on malformed XML

public void setLenient(boolean bool)

Specify whether the parser should be validating. Default is true.

If set to false, the validation will fail only if the parsed document is not well formed XML.

this option is ignored if the specified class with setClassName(String) is not a SAX2 XMLReader.

Parameters

bool:boolean: if set to false only fail on malformed XML

setProperty	back to summary
protected void setProperty(String name, String value) throws BuildException Sets a property. Parameters name:String a property name value:String a property value. Exceptions BuildException: if an error occurs. if the property was not supported

setProperty

back to summary

protected void setProperty(String name, String value) throws BuildException

Sets a property.

Parameters

name:String: a property name
value:String: a property value.

Exceptions

BuildException:

if an error occurs.
if the property was not supported

setWarn back to summary

setWarn	back to summary
public void setWarn(boolean bool) Specify how parser error are to be handled. If set to `true` (default), log a warn message for each SAX warn event. Parameters bool:boolean if set to `false` do not send warnings

public void setWarn(boolean bool)

Specify how parser error are to be handled.

If set to true (default), log a warn message for each SAX warn event.

Parameters

bool:boolean: if set to false do not send warnings

org.apache.tools.ant.taskdefs.optional back to summary

public Class XMLValidateTask.Attribute

Class Inheritance

extends Object

java.lang.Object
org.apache.tools.ant.taskdefs.optional.XMLValidateTask.Attribute

The class to create to set a feature of the parser.

Since: ant1.6

Field Summary

Modifier and Type	Field and Description
private String	attributeName The name of the attribute to set.
private boolean	attributeValue The value of the feature.

Constructor Summary

Access	Constructor and Description
public	Attribute()

Method Summary

Modifier and Type	Method and Description
public String	Returns: the feature name getName() Gets the attribute name.
public boolean	Returns: the feature value getValue() Gets the attribute value.
public void	setName(String the name to set name) Set the feature name.
public void	setValue(boolean feature value value) Set the feature value to true or false.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

attributeName	back to summary
private String attributeName The name of the attribute to set. Valid attributes include

attributeValue	back to summary
private boolean attributeValue The value of the feature.

Constructor Detail

Attribute	back to summary
public Attribute()

Method Detail

getName

back to summary

public String getName()

Gets the attribute name.

Returns:String: the feature name

getValue

back to summary

public boolean getValue()

Gets the attribute value.

Returns:boolean: the feature value

setName

back to summary

public void setName(String name)

Set the feature name.

Parameters

name:String: the name to set

setValue

back to summary

public void setValue(boolean value)

Set the feature value to true or false.

Parameters

value:boolean: feature value

org.apache.tools.ant.taskdefs.optional back to summary

public final Class XMLValidateTask.Property

Class Inheritance

extends Object

java.lang.Object
org.apache.tools.ant.taskdefs.optional.XMLValidateTask.Property

A Parser property. See XML parser properties for usable properties

Since: ant 1.6.2

Field Summary

Modifier and Type	Field and Description
private String	name
private String	value

Constructor Summary

Access	Constructor and Description
public	Property()

Method Summary

Modifier and Type	Method and Description
public String	Returns: name of the property getName() accessor to the name of the property
public String	Returns: value of the property getValue() getter for the value of the property
public void	setName(String name of the property name) setter for the name of the property
public void	setValue(String value of the property value) sets the value of the property

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

name	back to summary
private String name

value	back to summary
private String value

Constructor Detail

Property	back to summary
public Property()

Method Detail

getName

back to summary

public String getName()

accessor to the name of the property

Returns:String: name of the property

getValue

back to summary

public String getValue()

getter for the value of the property

Returns:String: value of the property

setName

back to summary

public void setName(String name)

setter for the name of the property

Parameters

name:String: name of the property

setValue

back to summary

public void setValue(String value)

sets the value of the property

Parameters

value:String: value of the property

org.apache.tools.ant.taskdefs.optional back to summary

protected Class XMLValidateTask.ValidatorErrorHandler

Class Inheritance

extends Object
implements ErrorHandler

java.lang.Object
org.apache.tools.ant.taskdefs.optional.XMLValidateTask.ValidatorErrorHandler

All Implemented Interfaces

org.xml.sax.ErrorHandler

ValidatorErrorHandler role :

log SAX parse exceptions,
remember if an error occurred

Field Summary

Modifier and Type	Field and Description
protected File	currentFile
protected boolean	failed
protected String	lastErrorMessage

Constructor Summary

Access	Constructor and Description
protected	ValidatorErrorHandler()

Method Summary

Modifier and Type	Method and Description
private void	doLog(SAXParseException e, int logLevel)
public void	error(SAXParseException the error exception) Implements org.xml.sax.ErrorHandler.error. receive notification of a recoverable error
public void	fatalError(SAXParseException the fatal error exception) Implements org.xml.sax.ErrorHandler.fatalError. record a fatal error
public boolean	Returns: did an error happen during last parsing ? getFailure() did an error happen during last parsing ?
private String	getMessage(SAXParseException e)
public void	init(File file used file) initialises the class
public void	warning(SAXParseException the warning exception) Implements org.xml.sax.ErrorHandler.warning. receive notification of a warning

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

currentFile	back to summary
protected File currentFile

failed	back to summary
protected boolean failed

lastErrorMessage	back to summary
protected String lastErrorMessage

Constructor Detail

ValidatorErrorHandler	back to summary
protected ValidatorErrorHandler()

Method Detail

doLog	back to summary
private void doLog(SAXParseException e, int logLevel)

error

back to summary

public void error(SAXParseException exception)

Implements org.xml.sax.ErrorHandler.error.

receive notification of a recoverable error

Parameters

exception:SAXParseException: the error

fatalError

back to summary

public void fatalError(SAXParseException exception)

Implements org.xml.sax.ErrorHandler.fatalError.

record a fatal error

Parameters

exception:SAXParseException: the fatal error

getFailure

back to summary

public boolean getFailure()

did an error happen during last parsing ?

Returns:boolean: did an error happen during last parsing ?

getMessage	back to summary
private String getMessage(SAXParseException e)

init

back to summary

public void init(File file)

initialises the class

Parameters

file:File: file used

warning

back to summary

public void warning(SAXParseException exception)

Implements org.xml.sax.ErrorHandler.warning.

receive notification of a warning

Parameters

exception:SAXParseException: the warning

public Class XMLValidateTask

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class XMLValidateTask.Attribute

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class XMLValidateTask.Property

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class XMLValidateTask.ValidatorErrorHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail