xdoclet.ant
Class XDocletTask

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

All Implemented Interfaces:

DynamicConfigurator

Direct Known Subclasses:

AntDocletTask

public class XDocletTask

extends Task

implements DynamicConfigurator

Ant task for XDoclet. It's just a thin adapter. Let's keep it that way! We're using Ant's IntrospectionHelper to set attributes in the XDoclet object (which is totally decoupled from Ant). If you need to adapt a particular subclass of XDoclet, subclass this class and override createXDoclet().

Version:

$Revision: 1.14 $

Author:

Aslak Hellesøy

Nested Class Summary

static class

XDocletTask.PlusAction

Field Summary

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

XDocletTask()

Method Summary

Object	createDynamicElement(String name)
protected XDoclet	createXDoclet() Subclasses should override this method if they need to adapt a different subclass of XDoclet.
void	execute() Callback method called by our superclass' execute() method.
protected String	getClasspath() Returns the classpath
protected XDoclet	getXDoclet()
void	setDynamicAttribute(String name, String value)
void	setGui(boolean flag)
void	setProject(Project project) Callback from Ant.
void	setTaskName(String taskName) Callback from Ant.

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

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

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

getProject

Methods inherited from class java.lang.Object

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

Constructor Detail

XDocletTask

public XDocletTask()

Method Detail

setDynamicAttribute

public final void setDynamicAttribute(String name,
                                      String value)
                               throws BuildException

Specified by:

setDynamicAttribute in interface DynamicConfigurator

BuildException

createDynamicElement

public final Object createDynamicElement(String name)
                                  throws BuildException

Specified by:

createDynamicElement in interface DynamicConfigurator

BuildException

setProject

public final void setProject(Project project)

Callback from Ant. This method is called right after a new XDocletTask object is created.

Overrides:

setProject in class ProjectComponent

Parameters:

project - the Ant project.

setTaskName

public void setTaskName(String taskName)

Callback from Ant. This will be called after setProject(org.apache.tools.ant.Project).

Overrides:

setTaskName in class Task

Parameters:

taskName - the name of the task.

createXDoclet

protected XDoclet createXDoclet()

Subclasses should override this method if they need to adapt a different subclass of XDoclet.

Returns:

an instance of an XDoclet

getXDoclet

protected final XDoclet getXDoclet()

execute

public void execute()
             throws BuildException

Callback method called by our superclass' execute() method. Override this method if you want to add aditional plugins or other functionality.

Overrides:

execute in class Task

Throws:

BuildException

getClasspath

protected String getClasspath()

Returns the classpath

Returns:

the classpath

setGui

public void setGui(boolean flag)