xdoclet

Class DocletTask

Implemented Interfaces:
DynamicConfigurator

public class DocletTask
extends XJavadocTask
implements DynamicConfigurator

Field Summary

static String
XDOCLET_VERSION

Constructor Summary

DocletTask()

Method Summary

void
addConfigParam(ConfigParameter configParam)
void
addFileset(FileSet set)
void
addPackageSubstitution(PackageTagsHandler.PackageSubstitution ps)
void
addSubTask(xdoclet.SubTask subtask)
void
addTemplate(xdoclet.TemplateSubTask subtask)
void
addXmlTemplate(xdoclet.XmlSubTask subtask)
protected void
checkClass(String className)
Object
createDynamicElement(String name)
String
getAddedTags()
List
getConfigParams()
protected HashMap
getConfigParams(List subtasks)
Map
getConfigParamsAsMap()
File
getDestDir()
String
getExcludedTags()
File
getMergeDir()
List
getPackageSubstitutions()
static String
getSubTaskName(Class subTaskClass)
protected List
getSubTasks()
boolean
isForce()
boolean
isVerbose()
void
setAddedTags(String addedTags)
void
setDestDir(File dir)
void
setDynamicAttribute(String name, String value)
void
setExcludePackageNames(String src)
void
setExcludedTags(String tags)
void
setForce(boolean force)
void
setMergeDir(File dir)
void
setPackageNames(String src)
void
setPackageSubstitutions(List packageSubstitutions)
void
setVerbose(boolean verbose)
protected void
start()
protected void
validateOptions()
protected void
validateSubTasks()

Field Details

XDOCLET_VERSION

public static final String XDOCLET_VERSION

Constructor Details

DocletTask

public DocletTask()

Method Details

addConfigParam

public void addConfigParam(ConfigParameter configParam)

addFileset

public void addFileset(FileSet set)

addPackageSubstitution

public void addPackageSubstitution(PackageTagsHandler.PackageSubstitution ps)

addSubTask

public void addSubTask(xdoclet.SubTask subtask)

addTemplate

public void addTemplate(xdoclet.TemplateSubTask subtask)
            throws BuildException

addXmlTemplate

public void addXmlTemplate(xdoclet.XmlSubTask subtask)

checkClass

protected void checkClass(String className)

createDynamicElement

public Object createDynamicElement(String name)
            throws BuildException

getAddedTags

public String getAddedTags()

getConfigParams

public List getConfigParams()

getConfigParams

protected HashMap getConfigParams(List subtasks)

getConfigParamsAsMap

public Map getConfigParamsAsMap()

getDestDir

public File getDestDir()

getExcludedTags

public String getExcludedTags()

getMergeDir

public File getMergeDir()

getPackageSubstitutions

public List getPackageSubstitutions()

getSubTaskName

public static String getSubTaskName(Class subTaskClass)

getSubTasks

protected final List getSubTasks()

isForce

public boolean isForce()

isVerbose

public boolean isVerbose()

setAddedTags

public void setAddedTags(String addedTags)

setDestDir

public void setDestDir(File dir)

setDynamicAttribute

public void setDynamicAttribute(String name,
                                String value)

setExcludePackageNames

public void setExcludePackageNames(String src)

setExcludedTags

public void setExcludedTags(String tags)

setForce

public void setForce(boolean force)

setMergeDir

public void setMergeDir(File dir)

setPackageNames

public void setPackageNames(String src)

setPackageSubstitutions

public void setPackageSubstitutions(List packageSubstitutions)

setVerbose

public void setVerbose(boolean verbose)

start

protected void start()
            throws BuildException

validateOptions

protected void validateOptions()
            throws BuildException

validateSubTasks

protected void validateSubTasks()
            throws BuildException