xdoclet
Class DocletTask

java.lang.Object
  |
  +--org.apache.tools.ant.ProjectComponent
        |
        +--org.apache.tools.ant.Task
              |
              +--xdoclet.DocletTask

Direct Known Subclasses:

DocumentDocletTask, EjbDocletTask, JMXDocletTask, WebDocletTask

public class DocletTask

extends org.apache.tools.ant.Task

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.

Version:

$Revision: 1.22 $

Author:

Ara Abrahamian (ara_e@email.com)

Inner Class Summary

static class

DocletTask.DocletMain

Field Summary

protected DocletContext	context
static java.lang.String	XDOCLET_VERSION

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

DocletTask()

Method Summary

void	addConfigParam(ConfigParameter config_param)
void	addFileset(org.apache.tools.ant.types.FileSet set) Adds a set of files (nested fileset attribute).
void	addTemplate(TemplateSubTask subtask)
void	addXmlTemplate(XmlSubTask subtask)
org.apache.tools.ant.types.Path	createClasspath()
org.apache.tools.ant.types.Path	createSourcepath() Create a nested element for multiple source path support.
protected org.apache.tools.ant.taskdefs.Javadoc	createTask()
void	execute()
org.apache.tools.ant.types.Path	getClasspath()
org.apache.tools.ant.types.Reference	getClasspathRef()
java.util.Vector	getConfigParams()
protected java.util.Hashtable	getConfigParams(java.util.Vector subtasks)
protected DocletContext	getContext() Returns the singleton context object and creates it if not already created and registers it as the single instance.
java.io.File	getDestDir()
java.lang.String	getExcludedTags()
java.lang.String	getExcludePackageNames()
java.util.Vector	getFilesets()
java.lang.String	getMaxmemory()
java.io.File	getMergeDir()
java.lang.String	getPackageNames()
org.apache.tools.ant.types.Path	getSourcePath()
protected SubTask	getSubTaskFromPlaceHolder(TemplateSubTask holder)
protected java.util.Vector	getSubTasks()
java.util.Vector	getTemplates()
boolean	isForce()
protected void	saveContext(DocletContext context, java.lang.String file_name)
void	setClasspath(org.apache.tools.ant.types.Path src)
void	setClasspathRef(org.apache.tools.ant.types.Reference ref)
void	setDestDir(java.io.File dir)
void	setExcludedTags(java.lang.String tags)
void	setExcludePackageNames(java.lang.String src)
void	setForce(boolean force)
void	setMaxmemory(java.lang.String maxmemory)
void	setMergeDir(java.io.File dir)
void	setPackageNames(java.lang.String src)
void	setSourcepath(org.apache.tools.ant.types.Path src)
protected void	validateOptions()
protected void	validateSubTasks()

Methods inherited from class org.apache.tools.ant.Task

getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorOutput, handleOutput, init, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, setProject

Methods inherited from class java.lang.Object

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

Field Detail

XDOCLET_VERSION

public static final java.lang.String XDOCLET_VERSION

context

protected transient DocletContext context

Constructor Detail

DocletTask

public DocletTask()

Method Detail

getConfigParams

public java.util.Vector getConfigParams()

getMergeDir

public java.io.File getMergeDir()

getSourcePath

public org.apache.tools.ant.types.Path getSourcePath()

getClasspath

public org.apache.tools.ant.types.Path getClasspath()

getClasspathRef

public org.apache.tools.ant.types.Reference getClasspathRef()

getFilesets

public java.util.Vector getFilesets()

getPackageNames

public java.lang.String getPackageNames()

getExcludePackageNames

public java.lang.String getExcludePackageNames()

getExcludedTags

public java.lang.String getExcludedTags()

getTemplates

public java.util.Vector getTemplates()

getDestDir

public java.io.File getDestDir()

getMaxmemory

public java.lang.String getMaxmemory()

isForce

public boolean isForce()

setPackageNames

public void setPackageNames(java.lang.String src)

setExcludePackageNames

public void setExcludePackageNames(java.lang.String src)

setExcludedTags

public void setExcludedTags(java.lang.String tags)

setDestDir

public void setDestDir(java.io.File dir)

setMergeDir

public void setMergeDir(java.io.File dir)

setSourcepath

public void setSourcepath(org.apache.tools.ant.types.Path src)

setClasspath

public void setClasspath(org.apache.tools.ant.types.Path src)

setClasspathRef

public void setClasspathRef(org.apache.tools.ant.types.Reference ref)

setMaxmemory

public void setMaxmemory(java.lang.String maxmemory)

setForce

public void setForce(boolean force)

createSourcepath

public org.apache.tools.ant.types.Path createSourcepath()

Create a nested element for multiple source path support.

Returns:

a nested src element.

createClasspath

public org.apache.tools.ant.types.Path createClasspath()

addFileset

public void addFileset(org.apache.tools.ant.types.FileSet set)

Adds a set of files (nested fileset attribute).

Parameters:

set - The feature to be added to the Fileset attribute

addTemplate

public void addTemplate(TemplateSubTask subtask)

addXmlTemplate

public void addXmlTemplate(XmlSubTask subtask)

addConfigParam

public void addConfigParam(ConfigParameter config_param)

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Overrides:

execute in class org.apache.tools.ant.Task

getSubTasks

protected java.util.Vector getSubTasks()

getSubTaskFromPlaceHolder

protected SubTask getSubTaskFromPlaceHolder(TemplateSubTask holder)

getContext

protected DocletContext getContext()

Returns the singleton context object and creates it if not already created and registers it as the single instance.

Returns:

the singleton context object

getConfigParams

protected java.util.Hashtable getConfigParams(java.util.Vector subtasks)

validateOptions

protected void validateOptions()
                        throws org.apache.tools.ant.BuildException

validateSubTasks

protected void validateSubTasks()
                         throws org.apache.tools.ant.BuildException

createTask

protected org.apache.tools.ant.taskdefs.Javadoc createTask()
                                                    throws org.apache.tools.ant.BuildException

saveContext

protected void saveContext(DocletContext context,
                           java.lang.String file_name)
                    throws java.io.IOException