xdoclet
Class SubTask

java.lang.Object
  |
  +--xdoclet.DocletSupport
        |
        +--xdoclet.SubTask

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

TemplateSubTask

public abstract class SubTask

extends DocletSupport

implements java.io.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.62 $

Author:

Ara Abrahamian (ara_e@email.com)

See Also:

Serialized Form

Fields inherited from class xdoclet.DocletSupport

currentTag

Constructor Summary

SubTask()

Method Summary

void	addConfigParam(ConfigParameter config_param)
abstract void	execute() Called to start execution of the sub-task.
java.util.Vector	getConfigParams()
protected DocletContext	getContext() A utility method that deleges the call to DocletContext.getSingleInstance().
java.io.File	getDestDir()
java.io.File	getMergeDir()
java.lang.String	getSubTaskName()
void	init() Initializes SubTask.
void	setDestDir(java.io.File destDir)
void	setMergeDir(java.io.File mergeDir) Sets the value of mergeDir.
void	setSubTaskName(java.lang.String subtaskName)
void	validateOptions() Called to validate configuration parameters.

Methods inherited from class xdoclet.DocletSupport

getCurrentClass, getCurrentConstructor, getCurrentField, getCurrentMethod, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentConstructor, setCurrentField, setCurrentMethod, setCurrentPackage, setCurrentTag

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SubTask

public SubTask()

Method Detail

getConfigParams

public java.util.Vector getConfigParams()

getDestDir

public java.io.File getDestDir()

getMergeDir

public java.io.File getMergeDir()

getSubTaskName

public java.lang.String getSubTaskName()

setSubTaskName

public void setSubTaskName(java.lang.String subtaskName)

setDestDir

public void setDestDir(java.io.File destDir)

setMergeDir

public void setMergeDir(java.io.File mergeDir)

Sets the value of mergeDir.

Parameters:

mergeDir - The new MergeDir value

addConfigParam

public void addConfigParam(ConfigParameter config_param)

init

public void init()
          throws XDocletException

Initializes SubTask. It inherits values of the config parameters if not explicitly defined for this sub-task.

Throws:

XDocletException - Description of Exception

See Also:

execute()

execute

public abstract void execute()
                      throws XDocletException

Called to start execution of the sub-task.

Throws:

XDocletException - Description of Exception

validateOptions

public void validateOptions()
                     throws XDocletException

Called to validate configuration parameters.

Throws:

XDocletException - Description of Exception

getContext

protected DocletContext getContext()

A utility method that deleges the call to DocletContext.getSingleInstance().

Returns:

the singleton context object