A base class for all Tasks. It can also be used directly, useful for the case where you want to execute a template
file but you don't want to bother writing a new task.
addConfigParam
public void addConfigParam(ConfigParameter configParam)
Allows to set configuration parameters that will be included in the element as attribute value pair.
configParam
- Describe the method parameter
addFileset
public void addFileset(FileSet set)
Ant's <fileset> definition. To define the files to parse.
addPackageSubstitution
public void addPackageSubstitution(PackageTagsHandler.PackageSubstitution ps)
Substitutes the package of the generated files.
ps
- The feature to be added to the Fileset attribute
addSubTask
public void addSubTask(SubTask subtask)
Generic subtask.
subtask
- The subtask to be added
addTemplate
public void addTemplate(TemplateSubTask subtask)
throws BuildException
Generic subtask for processing a user-supplied template.
subtask
- Describe the method parameter
addXmlTemplate
public void addXmlTemplate(XmlSubTask subtask)
Generic subtask for processing a user-supplied template, to generate an XML document.
subtask
- Describe the method parameter
checkClass
protected void checkClass(String className)
Throws BuildException if a specific class is not on the CP. Should be called from subclasses' validateOptions()
to verify that classpath is OK.
createDynamicElement
public Object createDynamicElement(String name)
throws BuildException
getAddedTags
public String getAddedTags()
getConfigParams
public List getConfigParams()
Gets the ConfigParams attribute of the DocletTask object
getConfigParams
protected HashMap getConfigParams(List subtasks)
Gets the ConfigParams attribute of the DocletTask object
subtasks
- Describe what the parameter does
getConfigParamsAsMap
public Map getConfigParamsAsMap()
getDestDir
public File getDestDir()
Gets the DestDir attribute of the DocletTask object
getExcludedTags
public String getExcludedTags()
Gets the ExcludedTags attribute of the DocletTask object
getMergeDir
public File getMergeDir()
Gets the MergeDir attribute of the DocletTask object
getPackageSubstitutions
public List getPackageSubstitutions()
Gets the PackageSubstitutions attribute of the EjbDocletTask object
- The PackageSubstitutions value
getSubTaskName
public static String getSubTaskName(Class subTaskClass)
getSubTasks
protected final List getSubTasks()
Gets the SubTasks attribute of the DocletTask object
isForce
public boolean isForce()
Gets the Force attribute of the DocletTask object.
isVerbose
public boolean isVerbose()
Gets the Verbose attribute of the DocletTask object.
setAddedTags
public void setAddedTags(String addedTags)
Add some JavaDoc tags (or comments) to the generated classes. A special case @ xdoclet-generated. If this is
included, ejbdoclet will not consider the file if it is by error in the fileset of the ejbdoclet task.
setDestDir
public void setDestDir(File dir)
Destination directory for output files
dir
- The new DestDir value
- Onlyifit's
notspecifiedfor
asubtask.
setDynamicAttribute
public void setDynamicAttribute(String name,
String value)
setExcludePackageNames
public void setExcludePackageNames(String src)
Sets the ExcludePackageNames attribute of the DocletTask object
src
- The new ExcludePackageNames value
setExcludedTags
public void setExcludedTags(String tags)
Specify tags that should not be automatically written to output files. The normal behaviour is to include all @
tags from the source file to the output files. This may cause trouble if you use cvs-like tag like $Revision: 1.5
$ that will be overwritten at each build and causes a difference for CVS even if the code himself is not changed.
Example: excludedtags="@ version" For excluded tags, ejbdoclet will generate an hardcoded tag. Example: @ version
XDOCLET 1.0
tags
- The new ExcludedTags value
setForce
public void setForce(boolean force)
Specify if the generation of files should be forced. In normal cases, the timestamp of generated file is checked
against the timestamps of the class (and its super classes) we generate from. When this timestamp checking should
be bypassed (for example after the installtion of a new xdoclet version) then the user should force the
regeneration. The easiest way is to run the Ant build file with a parameter "-Dxdoclet.force=true" and add the
option "force=${xdoclet.force}" to the doclet call.
force
- The new Force value
setMergeDir
public void setMergeDir(File dir)
Directory where subtasks will look for files to be merged with generated files.
dir
- The new MergeDir value
- No,butshould
besetif
youwantto
usethemerge
feature.
setPackageNames
public void setPackageNames(String src)
Sets the PackageNames attribute of the DocletTask object
src
- The new PackageNames value
setPackageSubstitutions
public void setPackageSubstitutions(List packageSubstitutions)
Sets the PackageSubstitutions attribute of the EjbDocletTask object
packageSubstitutions
- The new PackageSubstitutions value
setVerbose
public void setVerbose(boolean verbose)
Sets the Verbose attribute of the DocletTask object.
verbose
- The new Verbose value
start
protected void start()
throws BuildException
validateOptions
protected void validateOptions()
throws BuildException
Called by superclass before start() is called
validateSubTasks
protected void validateSubTasks()
throws BuildException
Describe what the method does