net.webpdf.ant.task

Class Task

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

net.webpdf.ant.task.Task

All Implemented Interfaces:

Cloneable, TaskIntf

Direct Known Subclasses:

GroupTask, OperationTask, Variable, WebPDFTask

public abstract class Task
extends org.apache.tools.ant.Task
implements TaskIntf

This class shall provide all mechanisms for a containing parent task to initialize and execute it's children.

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
Task(TaskName taskName) An extending class shall provide a set of basic mechanisms to initialize and execute it's children.

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	execute() Called by the project to let the task do its work.
IterativeTaskFile	getFiles() Returns the container managing the iterative file progression of this task.
AntLogger	getLogger() Returns the logger used by this task.
TaskConfiguration	getTaskConfiguration() Returns the top level task configuration of this sub task.
VariableMap	getVariables() Returns the variables used by this task.
void	setFiles(IterativeTaskFile files) Sets the configuration container managing the iterative file progression in between the encapsulated tasks and sub tasks.
void	setTaskConfiguration(TaskConfiguration taskConfiguration) Passes the top level task configuration on to this sub task.

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

Task

public Task(TaskName taskName)

An extending class shall provide a set of basic mechanisms to initialize and execute it's children.

Method Detail

execute

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

Called by the project to let the task do its work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running "ant target1 target2" will run all tasks in target3 twice.

Specified by:

execute in interface TaskIntf

Overrides:

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

Throws:

org.apache.tools.ant.BuildException - if something goes wrong with the build.

setFiles

public void setFiles(IterativeTaskFile files)

Sets the configuration container managing the iterative file progression in between the encapsulated tasks and sub tasks.

Specified by:

setFiles in interface TaskIntf

Parameters:

files - The file container this task shall be using.

getFiles

public IterativeTaskFile getFiles()

Returns the container managing the iterative file progression of this task.

Specified by:

getFiles in interface TaskIntf

Returns:

The file container this task is currently using.

setTaskConfiguration

public void setTaskConfiguration(TaskConfiguration taskConfiguration)

Passes the top level task configuration on to this sub task.

Specified by:

setTaskConfiguration in interface TaskIntf

Parameters:

taskConfiguration - The task configuration of the top level webPDF task.

getTaskConfiguration

public TaskConfiguration getTaskConfiguration()

Returns the top level task configuration of this sub task.

Specified by:

getTaskConfiguration in interface TaskIntf

Returns:

The task configuration of the containing top level webPDF task.

getVariables

public VariableMap getVariables()

Returns the variables used by this task.

Specified by:

getVariables in interface TaskIntf

Returns:

The variables used by this task.

getLogger

public AntLogger getLogger()

Returns the logger used by this task.

Specified by:

getLogger in interface TaskIntf

Returns:

The logger used by this task.