vdoclet.ant

Class VDocletTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

vdoclet.ant.VDocletTask

All Implemented Interfaces:

Cloneable

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

Ant task for invocation of vDoclet. It takes the following arguments:

• srcPath = input Java source-path
• destDir = output directory (required)
• template = name of control template (required)
• classPath = path for templates and helper-classes

and supports the following nested elements:

• fileset = source-files
• classPath = path for templates and helper-classes

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
VDocletTask()

Method Summary

Methods

Modifier and Type	Method and Description
void	addConfiguredFileSet(org.apache.tools.ant.types.FileSet fileSet) Nested <fileset> element
void	addConfiguredParam(VDocletParameter param) nested <param>
org.apache.tools.ant.types.Path	createClassPath() Nested <classpath> element
void	execute() Invoke vDoclet
void	setClassPath(org.apache.tools.ant.types.Path classPath) classpath attribute
void	setDestDir(File destDir) destDir attribute
void	setOut(File outputFile) out attribute
void	setProject(org.apache.tools.ant.Project project)
void	setSrcDir(org.apache.tools.ant.types.Path srcDir) Alias for srcPath
void	setSrcPath(org.apache.tools.ant.types.Path srcPath) srcPath attribute
void	setTemplate(String template) template attribute

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

Methods inherited from class java.lang.Object

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

Constructor Detail

VDocletTask

public VDocletTask()

Method Detail

setProject

public void setProject(org.apache.tools.ant.Project project)

Overrides:

setProject in class org.apache.tools.ant.ProjectComponent

setSrcPath

public void setSrcPath(org.apache.tools.ant.types.Path srcPath)

srcPath attribute

setSrcDir

public void setSrcDir(org.apache.tools.ant.types.Path srcDir)

Alias for srcPath

addConfiguredFileSet

public void addConfiguredFileSet(org.apache.tools.ant.types.FileSet fileSet)

Nested <fileset> element

setDestDir

public void setDestDir(File destDir)

destDir attribute

setOut

public void setOut(File outputFile)

out attribute

setTemplate

public void setTemplate(String template)

template attribute

setClassPath

public void setClassPath(org.apache.tools.ant.types.Path classPath)

classpath attribute

createClassPath

public org.apache.tools.ant.types.Path createClassPath()

Nested <classpath> element

addConfiguredParam

public void addConfiguredParam(VDocletParameter param)

nested <param>

execute

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

Invoke vDoclet

Overrides:

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

Throws:

org.apache.tools.ant.BuildException