xdoclet
public abstract class SubTask extends DocletSupport 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: $Revision: 1.75 $
UNKNOWN: June 16, 2001
Method Summary | |
---|---|
void | addConfigParam(ConfigParameter configParam)
Specifies a configuration parameter for the subtask.
|
void | copyAttributesFrom(TemplateSubTask src)
Describe what the method does
|
abstract void | execute()
Called to start execution of the sub-task.
|
List | getConfigParams()
Gets the ConfigParams attribute of the SubTask object
|
Map | getConfigParamsAsMap() |
protected DocletContext | getContext()
A utility method that deleges the call to DocletContext.getSingleInstance().
|
File | getDestDir()
Gets the DestDir attribute of the SubTask object
|
File | getMergeDir()
Gets the MergeDir attribute of the SubTask object
|
String | getSubTaskName()
Gets the SubTaskName attribute of the SubTask object
|
protected XJavaDoc | getXJavaDoc() |
void | init(XJavaDoc xJavaDoc)
Initializes SubTask. |
void | setDestDir(File destDir)
Sets the directory where the generated file(s) will be written.
|
void | setMergeDir(File mergeDir)
Specifies the location of the merge directory. |
void | setSubTaskName(String subTaskName)
Sets an optional name for the subtask that will be seen in XDoclet's debug messages.
|
void | validateOptions()
Called to validate configuration parameters.
|
Parameters: configParam Describe the method parameter
Parameters: src Describe what the parameter does
Throws: XDocletException Description of Exception
Returns: The ConfigParams value
Returns: the singleton context object
Returns: The DestDir value
Returns: The MergeDir value
Returns: The SubTaskName value
Parameters: xJavaDoc
Throws: XDocletException Description of Exception
See Also: execute
Parameters: destDir The new DestDir value
Parameters: mergeDir The new MergeDir value
Parameters: subTaskName
Throws: XDocletException Description of Exception