|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.MatchingTask
org.springframework.beandoc.client.AntTask
public class AntTask
Ant task that sets up and runs the beandoc tool based on a properties file containing all configuration options. It's not possible to allow all options to be specified on the Ant task as setters (attributes) since beandoc is extensible and any number of custom decorators or transformers could be added to the core setup, all with their own properties.
This class is a very thin wrapper that accepts the mandatory beandoc options
as task attributes and boots the default context via a
SpringLoader
.
Field Summary | |
---|---|
protected org.apache.commons.logging.Log |
logger
|
Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask |
---|
fileset |
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 | |
---|---|
AntTask()
|
Method Summary | |
---|---|
void |
addFileset(org.apache.tools.ant.types.FileSet fileset)
Specify a set of files to be used as the target for the BeanDoc task. |
void |
execute()
Load and run the default beandoc processor wrapping any Exception as
an Ant BuildException . |
void |
setBeandocContext(String context)
Power users may wish to completely customise beandoc setup through a different context definition file. |
void |
setBeandocProps(File beandocProps)
Specify the location of the required properties file used to configure the beandoc tool. |
void |
setBeandocPropsPrefix(String beandocPropsPrefix)
Specify a prefix for relevant properties. |
void |
setInputFiles(String inputFiles)
Deprecated. use one or more nested FileSet's instead. |
void |
setOutputDir(File outputDir)
Overrides any System or beandoc property to provide a direct value for output directory for the beandoc tool. |
void |
setTitle(String title)
Define a title to be used in the output documentation (principally the HTML) |
Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask |
---|
add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems |
Methods inherited from class org.apache.tools.ant.Task |
---|
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType |
Methods inherited from class org.apache.tools.ant.ProjectComponent |
---|
getProject |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final org.apache.commons.logging.Log logger
Constructor Detail |
---|
public AntTask()
Method Detail |
---|
public void execute() throws org.apache.tools.ant.BuildException
Exception
as
an Ant BuildException
.
execute
in class org.apache.tools.ant.Task
org.apache.tools.ant.BuildException
Task.execute()
public void addFileset(org.apache.tools.ant.types.FileSet fileset)
fileset
- a set of files to add as one or more input filespublic void setInputFiles(String inputFiles)
inputFiles
- a String representing one or more (comma separated or
wildcarded) Resources that will be used as input files.public void setOutputDir(File outputDir)
outputDir
- a directory (which must be writeable for the current
user) where beandoc will store its output.public void setTitle(String title)
title
- the title you wish to see in HTML <title> tags and
headers.public void setBeandocProps(File beandocProps)
beandocProps
- the location of the Properties file to be used to
configure the beandoc toolpublic void setBeandocPropsPrefix(String beandocPropsPrefix)
beandocPropsPrefix
- prefix for relevant propertiessetBeandocProps(File)
public void setBeandocContext(String context)
context
- location of the custom context file to use
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |