xdoclet

Class SubTask

Implemented Interfaces:
Serializable

public abstract class SubTask
extends xdoclet.DocletSupport
implements Serializable

Field Summary

Fields inherited from class xdoclet.DocletSupport

currentClassTag, currentFieldTag, currentMethodTag

Method Summary

void
addConfigParam(ConfigParameter configParam)
void
copyAttributesFrom(xdoclet.TemplateSubTask src)
abstract void
execute()
List
getConfigParams()
Map
getConfigParamsAsMap()
protected xdoclet.DocletContext
getContext()
File
getDestDir()
File
getMergeDir()
String
getSubTaskName()
protected XJavaDoc
getXJavaDoc()
void
init(XJavaDoc xJavaDoc)
void
setDestDir(File destDir)
void
setMergeDir(File mergeDir)
void
setSubTaskName(String subTaskName)
void
validateOptions()

Methods inherited from class xdoclet.DocletSupport

getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage

Method Details

addConfigParam

public void addConfigParam(ConfigParameter configParam)

copyAttributesFrom

public void copyAttributesFrom(xdoclet.TemplateSubTask src)

execute

public abstract void execute()
            throws xdoclet.XDocletException

getConfigParams

public List getConfigParams()

getConfigParamsAsMap

public Map getConfigParamsAsMap()

getContext

protected xdoclet.DocletContext getContext()

getDestDir

public File getDestDir()

getMergeDir

public File getMergeDir()

getSubTaskName

public final String getSubTaskName()

getXJavaDoc

protected XJavaDoc getXJavaDoc()

init

public void init(XJavaDoc xJavaDoc)
            throws xdoclet.XDocletException

setDestDir

public void setDestDir(File destDir)

setMergeDir

public void setMergeDir(File mergeDir)

setSubTaskName

public void setSubTaskName(String subTaskName)

validateOptions

public void validateOptions()
            throws xdoclet.XDocletException