net.webpdf.ant

Class GroupTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

net.webpdf.ant.task.Task

net.webpdf.ant.GroupTask

All Implemented Interfaces:

Cloneable, TaskIntf, org.apache.tools.ant.TaskContainer

public class GroupTask
extends Task
implements org.apache.tools.ant.TaskContainer

Task mapping the ant tag and all it's options.

Field Summary

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

Constructors

Constructor and Description
GroupTask() A Group Task shall be able to contain individual operations, that are bundled to one sequential groups, defining common rules and resources.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(org.apache.tools.ant.UnknownElement task) This method shall define special handling for unknown sub elements.
void	add(Variable variable) Adds a variable to the group context.
void	addTask(org.apache.tools.ant.Task task) Method to add sub elements to this task.
void	execute() Central method to execute a task and all it's sub tasks.

Methods inherited from class net.webpdf.ant.task.Task

getFiles, getLogger, getTaskConfiguration, getVariables, setFiles, setTaskConfiguration

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

Constructor Detail

GroupTask

public GroupTask()

A Group Task shall be able to contain individual operations, that are bundled to one sequential groups, defining common rules and resources.

Method Detail

execute

public void execute()

Central method to execute a task and all it's sub tasks. This method shall prepare and define the needed context and shall execute it's sub tasks sequentially in an ordered fashion.

Specified by:

execute in interface TaskIntf

Specified by:

execute in class Task

addTask

public void addTask(org.apache.tools.ant.Task task)

Method to add sub elements to this task. This shall be used by ant access methods and shall treat each appended element according to it's type.

Specified by:

addTask in interface org.apache.tools.ant.TaskContainer

Parameters:

task - The sub task, that shall be added.

add

public final void add(org.apache.tools.ant.UnknownElement task)

This method shall define special handling for unknown sub elements. In this context an "unknown element" is most likely an operation tag. It is expected, that unknown elements will be treated as pure XML content of the containing task, instead of representing a task themselves.

It is not expected to use this method actively, as it is specifically defined for the access by ANT.

add

public final void add(Variable variable)

Adds a variable to the group context. The variable and it's value shall only be known later on, when the group is executed.

Parameters:

variable - The variable, that shall be added.