|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.tools.ant.ProjectComponent | +--org.apache.tools.ant.Task | +--org.apache.tools.ant.taskdefs.optional.XMLValidateTask
The XMLValidateTask
checks that an XML document is valid,
with a SAX validating parser.
Inner Class Summary | |
protected class |
XMLValidateTask.ValidatorErrorHandler
|
Field Summary | |
protected Path |
classpath
|
static java.lang.String |
DEFAULT_XML_READER_CLASSNAME
The default implementation parser classname used by the task to process validation. |
protected XMLValidateTask.ValidatorErrorHandler |
errorHandler
|
protected boolean |
failOnError
|
protected java.util.Hashtable |
features
|
protected java.io.File |
file
|
protected java.util.Vector |
filesets
|
protected static java.lang.String |
INIT_FAILED_MSG
|
protected boolean |
lenient
|
protected java.lang.String |
readerClassName
|
protected boolean |
warn
|
protected org.xml.sax.XMLReader |
xmlReader
the parser is viewed as a SAX2 XMLReader. |
Fields inherited from class org.apache.tools.ant.Task |
description, location, target, taskName, taskType, wrapper |
Fields inherited from class org.apache.tools.ant.ProjectComponent |
project |
Constructor Summary | |
XMLValidateTask()
|
Method Summary | |
void |
addFileset(FileSet set)
specifify a set of file to be checked |
Path |
createClasspath()
|
void |
execute()
Called by the project to let the task do it's work. |
void |
setClassName(java.lang.String className)
Specify the class name of the SAX parser to be used. |
void |
setClasspath(Path classpath)
Specify the classpath to be searched to load the parser (optional) |
void |
setClasspathRef(Reference r)
|
void |
setFailOnError(boolean fail)
Specify how parser error are to be handled. |
void |
setFile(java.io.File file)
specifify the file to be checked |
void |
setLenient(boolean bool)
Specify whether the parser should be validating. |
void |
setWarn(boolean bool)
Specify how parser error are to be handled. |
Methods inherited from class org.apache.tools.ant.Task |
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorOutput, handleOutput, init, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName |
Methods inherited from class org.apache.tools.ant.ProjectComponent |
getProject, setProject |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static java.lang.String DEFAULT_XML_READER_CLASSNAME
protected static java.lang.String INIT_FAILED_MSG
protected boolean failOnError
protected boolean warn
protected boolean lenient
protected java.lang.String readerClassName
protected java.io.File file
protected java.util.Vector filesets
protected Path classpath
protected org.xml.sax.XMLReader xmlReader
protected XMLValidateTask.ValidatorErrorHandler errorHandler
protected java.util.Hashtable features
Constructor Detail |
public XMLValidateTask()
Method Detail |
public void setFailOnError(boolean fail)
If set to true
(default), throw a buildException if the parser yields an error.
public void setWarn(boolean bool)
If set to true (default), log a warn message for each SAX warn event.
public void setLenient(boolean bool)
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.
public void setClassName(java.lang.String className)
className
- 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 DEFAULT_XML_READER_CLASSNAME
will be used.
public void setClasspath(Path classpath)
public Path createClasspath()
#setClassPath
public void setClasspathRef(Reference r)
#setClassPath
public void setFile(java.io.File file)
public void addFileset(FileSet set)
public void execute() throws BuildException
Task
execute
in class Task
org.apache.tools.ant.Task
BuildException
- if someting goes wrong with the build
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |