xdoclet
Class SubTask
- Serializable
public abstract class SubTask
implements Serializable
An abstract base class for all sub-tasks. Common code and the contract is defined here.
Because of the way Ant is designed all setter methods automatically are settable config parameters. Note that by
default init() method inherits default setting from the containing task via DocletContext. Setter methods in sub-task
gives the user finer control over config parameters of the sub-task.
Version:
- Ara Abrahamian (ara_e@email.com)
- June 16, 2001
getCurrentClass , getCurrentClassTag , getCurrentConstructor , getCurrentField , getCurrentFieldTag , getCurrentMethod , getCurrentMethodTag , getCurrentPackage , getCurrentTag , isDocletGenerated , popCurrentClass , pushCurrentClass , setCurrentClass , setCurrentClassTag , setCurrentConstructor , setCurrentField , setCurrentFieldTag , setCurrentMethod , setCurrentMethodTag , setCurrentPackage |
addConfigParam
public void addConfigParam(ConfigParameter configParam)
Specifies a configuration parameter for the subtask.
configParam
- Describe the method parameter
copyAttributesFrom
public void copyAttributesFrom(TemplateSubTask src)
Describe what the method does
src
- Describe what the parameter does
getConfigParams
public List getConfigParams()
Gets the ConfigParams attribute of the SubTask object
- The ConfigParams value
getConfigParamsAsMap
public Map getConfigParamsAsMap()
getContext
protected DocletContext getContext()
A utility method that deleges the call to DocletContext.getSingleInstance().
- the singleton context object
getDestDir
public File getDestDir()
Gets the DestDir attribute of the SubTask object
- The DestDir value
getMergeDir
public File getMergeDir()
Gets the MergeDir attribute of the SubTask object
- The MergeDir value
getSubTaskName
public final String getSubTaskName()
Gets the SubTaskName attribute of the SubTask object
- The SubTaskName value
getXJavaDoc
protected XJavaDoc getXJavaDoc()
init
public void init(XJavaDoc xJavaDoc)
throws XDocletException
Initializes SubTask. It inherits values of the config parameters if not explicitly defined for this sub-task.
xJavaDoc
-
XDocletException
- Description of Exception
execute()
setDestDir
public void setDestDir(File destDir)
Sets the directory where the generated file(s) will be written.
destDir
- The new DestDir value
setMergeDir
public void setMergeDir(File mergeDir)
Specifies the location of the merge directory. This is where XDoclet will look for merge files.
mergeDir
- The new MergeDir value
setSubTaskName
public void setSubTaskName(String subTaskName)
Sets an optional name for the subtask that will be seen in XDoclet's debug messages.
subTaskName
-