xdoclet
public class DocletTask extends XJavadocTask implements DynamicConfigurator
UNKNOWN: June 19, 2001 name = "xdoclet" display-name = "XDoclet Standard Task" name = "encoding" description = "Specify the source file encoding name, such as Windows-31J, EUC-JP, * UTF-8. In default, system default encoding is used." name = "docencoding" description = "Specify encoding name for template engine. The generated file * encoding may be this value. In default, system default encoding is used."
Field Summary | |
---|---|
static String | XDOCLET_VERSION |
Constructor Summary | |
---|---|
DocletTask() |
Method Summary | |
---|---|
void | addConfigParam(ConfigParameter configParam)
Allows to set configuration parameters that will be included in the element as attribute value pair.
|
void | addFileset(FileSet set)
Ant's <fileset> definition. |
void | addPackageSubstitution(PackageTagsHandler.PackageSubstitution ps)
Substitutes the package of the generated files.
|
void | addSubTask(SubTask subtask)
Generic subtask.
|
void | addTemplate(TemplateSubTask subtask)
Generic subtask for processing a user-supplied template.
|
void | addXmlTemplate(XmlSubTask subtask)
Generic subtask for processing a user-supplied template, to generate an XML document.
|
protected void | checkClass(String className)
Throws BuildException if a specific class is not on the CP. |
Object | createDynamicElement(String name) |
String | getAddedTags() |
List | getConfigParams()
Gets the ConfigParams attribute of the DocletTask object
|
protected HashMap | getConfigParams(List subtasks)
Gets the ConfigParams attribute of the DocletTask object
|
Map | getConfigParamsAsMap() |
File | getDestDir()
Gets the DestDir attribute of the DocletTask object
|
String | getExcludedTags()
Gets the ExcludedTags attribute of the DocletTask object
|
File | getMergeDir()
Gets the MergeDir attribute of the DocletTask object
|
List | getPackageSubstitutions()
Gets the PackageSubstitutions attribute of the EjbDocletTask object
|
static String | getSubTaskName(Class subTaskClass) |
protected List | getSubTasks()
Gets the SubTasks attribute of the DocletTask object
|
boolean | isForce()
Gets the Force attribute of the DocletTask object.
|
boolean | isVerbose()
Gets the Verbose attribute of the DocletTask object.
|
void | setAddedTags(String addedTags)
Add some JavaDoc tags (or comments) to the generated classes. |
void | setDestDir(File dir)
Destination directory for output files
|
void | setDynamicAttribute(String name, String value) |
void | setExcludedTags(String tags)
Specify tags that should not be automatically written to output files. |
void | setExcludePackageNames(String src)
Sets the ExcludePackageNames attribute of the DocletTask object
|
void | setForce(boolean force)
Specify if the generation of files should be forced. |
void | setMergeDir(File dir)
Directory where subtasks will look for files to be merged with generated files.
|
void | setPackageNames(String src)
Sets the PackageNames attribute of the DocletTask object
|
void | setPackageSubstitutions(List packageSubstitutions)
Sets the PackageSubstitutions attribute of the EjbDocletTask object
|
void | setVerbose(boolean verbose)
Sets the Verbose attribute of the DocletTask object.
|
protected void | start() |
protected void | validateOptions()
Called by superclass before start() is called
|
protected void | validateSubTasks()
Describe what the method does
|
Parameters: configParam Describe the method parameter
Parameters: set a fileset to add
Parameters: ps The feature to be added to the Fileset attribute
Parameters: subtask The subtask to be added
UNKNOWN:
Parameters: subtask Describe the method parameter
Throws: BuildException
UNKNOWN:
Parameters: subtask Describe the method parameter
UNKNOWN:
Parameters: className
Parameters: name
Returns:
Throws: BuildException
Returns: The ConfigParams value
Parameters: subtasks Describe what the parameter does
Returns: The ConfigParams value
Returns: The DestDir value
Returns: The ExcludedTags value
Returns: The MergeDir value
Returns: The PackageSubstitutions value
Returns: The SubTasks value
Returns: The Force value
Returns: The Verbose value
Parameters: addedTags
Parameters: dir The new DestDir value
UNKNOWN: Onlyifit's notspecifiedfor asubtask.
Parameters: name value
Deprecated:
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.0Parameters: tags The new ExcludedTags value
Deprecated:
Sets the ExcludePackageNames attribute of the DocletTask objectParameters: src The new ExcludePackageNames value
UNKNOWN:
Parameters: force The new Force value
Parameters: dir The new MergeDir value
UNKNOWN: No,butshould besetif youwantto usethemerge feature.
Deprecated:
Sets the PackageNames attribute of the DocletTask objectParameters: src The new PackageNames value
UNKNOWN:
Parameters: packageSubstitutions The new PackageSubstitutions value
UNKNOWN:
Parameters: verbose The new Verbose value
Throws: BuildException
Throws: BuildException Describe the exception
Throws: BuildException Describe the exception