Package com.thoughtworks.paranamer.ant
Class ParanamerTask
- java.lang.Object
-
- org.apache.tools.ant.ProjectComponent
-
- org.apache.tools.ant.Task
-
- com.thoughtworks.paranamer.ant.ParanamerTask
-
- All Implemented Interfaces:
Cloneable
public class ParanamerTask extends org.apache.tools.ant.Task
Ant Task to process parameter names. This ant task facilitates the specification of the java source and class files to process as attributes, nested file sets or a combination of both. The attributes applicable to this ant task include a source directory, class directory, include pattern and exclude pattern. i.e.: <paranamer srcdir="src" classdir="classes" includes="*.java" excludes="excluded.java"/> Each of these attributes contains a default: - srcdir: the base directory of the project - classdir: srcdir - includes: "
-
-
Constructor Summary
Constructors Constructor Description ParanamerTask()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addFileset(org.apache.tools.ant.types.FileSet fileset)
Called automatically by ant when an embedded fileset element is present.void
execute()
Execute the task.protected QdoxParanamerGenerator
makeQdoxParanamerGenerator()
Provide this as a method so that it can be overridden and custom QdoxParanamerGenerators can be returned in place of the default.void
setClassdir(String classdir)
Called automatically by ant when the classdir attribute is present.void
setExcludes(String excludes)
Called automatically by ant when the excludes attribute is present.void
setIncludes(String includes)
Called automatically by ant when the includes attribute is present.void
setSrcdir(String srcdir)
Called automatically by ant when the srcdir attribute is present.-
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
-
-
-
-
Method Detail
-
execute
public void execute() throws org.apache.tools.ant.BuildException
Execute the task.- Overrides:
execute
in classorg.apache.tools.ant.Task
- Throws:
org.apache.tools.ant.BuildException
-
addFileset
public void addFileset(org.apache.tools.ant.types.FileSet fileset)
Called automatically by ant when an embedded fileset element is present.- Parameters:
fileset
- the fileset specification
-
setSrcdir
public void setSrcdir(String srcdir)
Called automatically by ant when the srcdir attribute is present.- Parameters:
srcdir
- the content of the srcdir attribute.
-
setIncludes
public void setIncludes(String includes)
Called automatically by ant when the includes attribute is present.- Parameters:
includes
- the content of the includes attribute.
-
setExcludes
public void setExcludes(String excludes)
Called automatically by ant when the excludes attribute is present.- Parameters:
excludes
- the content of the excludes attribute.
-
setClassdir
public void setClassdir(String classdir)
Called automatically by ant when the classdir attribute is present.- Parameters:
classdir
- the content of the classdir attribute.
-
makeQdoxParanamerGenerator
protected QdoxParanamerGenerator makeQdoxParanamerGenerator()
Provide this as a method so that it can be overridden and custom QdoxParanamerGenerators can be returned in place of the default. This is used for testing purposes.- Returns:
- the qdox paranamer generated instance to use to generate the paranamer data.
-
-