org.databene.task
Interface Task

All Superinterfaces:
java.io.Closeable, org.databene.commons.ThreadAware
All Known Implementing Classes:
AbstractTask, CompositeTask, FileDeleter, FileJoiner, GenerateAndConsumeTask, PerfTrackingTaskProxy, RunnableTask, SequentialTask, StateTrackingTaskProxy, SynchronizedTask, TaskProxy, TimedTask

public interface Task
extends org.databene.commons.ThreadAware, java.io.Closeable

Interface for the GoF 'Command' pattern. General usage is to call the executeStep() method once or several times for executing the task's work. After usage, close() must be called. When implementing the Task interface, you should preferably inherit from AbstractTask, this may compensate for future interface changes.

Created: 06.07.2007 06:30:22

Since:
0.2
Author:
Volker Bergmann

Method Summary
 void close()
           
 TaskResult execute(org.databene.commons.Context context, org.databene.commons.ErrorHandler errorHandler)
          Executes the task's work, possibly interacting with the context.
 java.lang.String getTaskName()
           
 void pageFinished()
           
 
Methods inherited from interface org.databene.commons.ThreadAware
isParallelizable, isThreadSafe
 

Method Detail

getTaskName

java.lang.String getTaskName()
Returns:
the name of the task.

execute

TaskResult execute(org.databene.commons.Context context,
                   org.databene.commons.ErrorHandler errorHandler)
Executes the task's work, possibly interacting with the context.


pageFinished

void pageFinished()

close

void close()
Specified by:
close in interface java.io.Closeable


Copyright © 2013. All Rights Reserved.