net.webpdf.ant.task

Interface TaskIntf

All Known Implementing Classes:

GroupTask, OperationTask, Task, Variable, WebPDFTask

public interface TaskIntf

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

Method Summary

Methods

Modifier and Type	Method and Description
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.

Method Detail

execute

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.

Throws:

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

setFiles

void setFiles(IterativeTaskFile files)

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

Parameters:

files - The file container this task shall be using.

getFiles

IterativeTaskFile getFiles()

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

Returns:

The file container this task is currently using.

setTaskConfiguration

void setTaskConfiguration(TaskConfiguration taskConfiguration)

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

Parameters:

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

getTaskConfiguration

TaskConfiguration getTaskConfiguration()

Returns the top level task configuration of this sub task.

Returns:

The task configuration of the containing top level webPDF task.

getVariables

VariableMap getVariables()

Returns the variables used by this task.

Returns:

The variables used by this task.

getLogger

AntLogger getLogger()

Returns the logger used by this task.

Returns:

The logger used by this task.