vdoclet.ant

Class XmlCheckTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

vdoclet.ant.XmlCheckTask

All Implemented Interfaces:

Cloneable

public class XmlCheckTask
extends org.apache.tools.ant.Task

Check that XML documents are valid with a SAX validating parser.

The following nested elements are supported:

• fileset = files to check
• dtd = register a DTD

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	XmlCheckTask.CheckHandler A parse-handler that reports errors via Ant logging
static class	XmlCheckTask.DTDLocation A configured DTD location

Field Summary

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

Constructors

Constructor and Description
XmlCheckTask()

Method Summary

Methods

Modifier and Type	Method and Description
void	addConfiguredDTD(XmlCheckTask.DTDLocation dtdLocation) Add a DTD location
void	addFileset(org.apache.tools.ant.types.FileSet set) Add a set of files to be checked
void	execute() Execute the task
protected void	validateFile(File file) Parse a file
protected void	validateFiles() Parse all the files

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmlCheckTask

public XmlCheckTask()

Method Detail

addFileset

public void addFileset(org.apache.tools.ant.types.FileSet set)

Add a set of files to be checked

addConfiguredDTD

public void addConfiguredDTD(XmlCheckTask.DTDLocation dtdLocation)

Add a DTD location

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Execute the task

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException

validateFile

protected void validateFile(File file)
                     throws org.apache.tools.ant.BuildException

Parse a file

Throws:

org.apache.tools.ant.BuildException

validateFiles

protected void validateFiles()
                      throws org.apache.tools.ant.BuildException

Parse all the files

Throws:

org.apache.tools.ant.BuildException