|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
xjavadoc.ant.XJavadocTask
xdoclet.DocletTask
public class DocletTask
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.
Field Summary | |
---|---|
static java.lang.String |
XDOCLET_VERSION
|
Fields inherited from class org.apache.tools.ant.Task |
---|
target, taskName, taskType, wrapper |
Fields inherited from class org.apache.tools.ant.ProjectComponent |
---|
description, location, project |
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(org.apache.tools.ant.types.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(java.lang.String className)
Throws BuildException if a specific class is not on the CP. |
java.lang.Object |
createDynamicElement(java.lang.String name)
|
java.lang.String |
getAddedTags()
|
java.util.List |
getConfigParams()
Gets the ConfigParams attribute of the DocletTask object |
protected java.util.HashMap |
getConfigParams(java.util.List subtasks)
Gets the ConfigParams attribute of the DocletTask object |
java.util.Map |
getConfigParamsAsMap()
|
java.io.File |
getDestDir()
Gets the DestDir attribute of the DocletTask object |
java.lang.String |
getExcludedTags()
Gets the ExcludedTags attribute of the DocletTask object |
java.io.File |
getMergeDir()
Gets the MergeDir attribute of the DocletTask object |
java.util.List |
getPackageSubstitutions()
Gets the PackageSubstitutions attribute of the EjbDocletTask object |
static java.lang.String |
getSubTaskName(java.lang.Class subTaskClass)
|
protected java.util.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(java.lang.String addedTags)
Add some JavaDoc tags (or comments) to the generated classes. |
void |
setDestDir(java.io.File dir)
Destination directory for output files |
void |
setDynamicAttribute(java.lang.String name,
java.lang.String value)
|
void |
setExcludedTags(java.lang.String tags)
Deprecated. |
void |
setExcludePackageNames(java.lang.String src)
Deprecated. |
void |
setForce(boolean force)
Specify if the generation of files should be forced. |
void |
setMergeDir(java.io.File dir)
Directory where subtasks will look for files to be merged with generated files. |
void |
setPackageNames(java.lang.String src)
Deprecated. |
void |
setPackageSubstitutions(java.util.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 |
Methods inherited from class xjavadoc.ant.XJavadocTask |
---|
createIgnoredtag, execute, getClasspath, getXJavaDoc, setDocencoding, setEncoding, setIgnoredtags, setValidating |
Methods inherited from class org.apache.tools.ant.Task |
---|
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType |
Methods inherited from class org.apache.tools.ant.ProjectComponent |
---|
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String XDOCLET_VERSION
Constructor Detail |
---|
public DocletTask()
Method Detail |
---|
public static java.lang.String getSubTaskName(java.lang.Class subTaskClass)
public java.util.List getPackageSubstitutions()
public java.util.List getConfigParams()
public java.util.Map getConfigParamsAsMap()
public java.io.File getMergeDir()
public java.lang.String getExcludedTags()
public java.io.File getDestDir()
public boolean isForce()
public boolean isVerbose()
public java.lang.String getAddedTags()
public void setPackageSubstitutions(java.util.List packageSubstitutions)
packageSubstitutions
- The new PackageSubstitutions valuepublic void setDynamicAttribute(java.lang.String name, java.lang.String value)
setDynamicAttribute
in interface org.apache.tools.ant.DynamicAttribute
name
- value
- public void setPackageNames(java.lang.String src)
src
- The new PackageNames valuepublic void setExcludePackageNames(java.lang.String src)
src
- The new ExcludePackageNames valuepublic void setExcludedTags(java.lang.String tags)
tags
- The new ExcludedTags valuepublic void setDestDir(java.io.File dir)
dir
- The new DestDir valuepublic void setMergeDir(java.io.File dir)
dir
- The new MergeDir valuepublic void setForce(boolean force)
force
- The new Force valuepublic void setVerbose(boolean verbose)
verbose
- The new Verbose valuepublic void setAddedTags(java.lang.String addedTags)
addedTags
- public void addPackageSubstitution(PackageTagsHandler.PackageSubstitution ps)
ps
- The feature to be added to the Fileset attributepublic void addFileset(org.apache.tools.ant.types.FileSet set)
addFileset
in class xjavadoc.ant.XJavadocTask
set
- a fileset to addpublic java.lang.Object createDynamicElement(java.lang.String name) throws org.apache.tools.ant.BuildException
createDynamicElement
in interface org.apache.tools.ant.DynamicElement
name
-
org.apache.tools.ant.BuildException
public void addSubTask(SubTask subtask)
subtask
- The subtask to be addedpublic void addTemplate(TemplateSubTask subtask) throws org.apache.tools.ant.BuildException
subtask
- Describe the method parameter
org.apache.tools.ant.BuildException
public void addXmlTemplate(XmlSubTask subtask)
subtask
- Describe the method parameterpublic void addConfigParam(ConfigParameter configParam)
configParam
- Describe the method parameterprotected final java.util.List getSubTasks()
protected java.util.HashMap getConfigParams(java.util.List subtasks)
subtasks
- Describe what the parameter does
protected void start() throws org.apache.tools.ant.BuildException
start
in class xjavadoc.ant.XJavadocTask
org.apache.tools.ant.BuildException
protected void validateOptions() throws org.apache.tools.ant.BuildException
validateOptions
in class xjavadoc.ant.XJavadocTask
org.apache.tools.ant.BuildException
- Describe the exceptionprotected void checkClass(java.lang.String className)
className
- protected void validateSubTasks() throws org.apache.tools.ant.BuildException
org.apache.tools.ant.BuildException
- Describe the exception
|
http://xdoclet.sourceforge.net/ | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |