|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object xdoclet.DocletSupport xdoclet.SubTask
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.
Field Summary |
Fields inherited from class xdoclet.DocletSupport |
currentClassTag, currentFieldTag, currentMethodTag |
Constructor Summary | |
SubTask()
|
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.XJavaDoc |
getXJavaDoc()
|
void |
init(xjavadoc.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. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public SubTask()
Method Detail |
public final String getSubTaskName()
public List getConfigParams()
public Map getConfigParamsAsMap()
public File getDestDir()
public File getMergeDir()
public void setSubTaskName(String subTaskName)
subTaskName
- public void setDestDir(File destDir)
destDir
- The new DestDir valuepublic void setMergeDir(File mergeDir)
mergeDir
- The new MergeDir valuepublic void addConfigParam(ConfigParameter configParam)
configParam
- Describe the method parameterpublic void copyAttributesFrom(TemplateSubTask src)
src
- Describe what the parameter doespublic void init(xjavadoc.XJavaDoc xJavaDoc) throws XDocletException
xJavaDoc
-
XDocletException
- Description of Exceptionexecute()
public abstract void execute() throws XDocletException
XDocletException
- Description of Exceptionpublic void validateOptions() throws XDocletException
XDocletException
- Description of Exceptionprotected DocletContext getContext()
protected xjavadoc.XJavaDoc getXJavaDoc()
|
http://xdoclet.sourceforge.net/ | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |