net.officefloor.frame.util

Class AbstractSingleTask<W extends Work,D extends Enum<D>,F extends Enum<F>>

java.lang.Object

net.officefloor.frame.util.AbstractSingleTask<W,D,F>

All Implemented Interfaces:

TaskFactory<W,D,F>, WorkFactory<W>, Task<W,D,F>, Work

Direct Known Subclasses:

AutoWireEscalationCauseRouteWorkSource.AutoWireEscalationCauseRouteTask, CleanupTask, CleanupTask, CloseEntityManagerTask, ConnectionManagerImpl, HttpFileFactoryTask, HttpFileWorkSource.SendHttpFileTask, HttpFileWriterTask, HttpParametersLoaderWorkSource.HttpParametersLoaderTask, HttpResponseSendTask, HttpRouteTask, HttpServletTask, HttpTemplateArrayIteratorWorkSource.HttpTemplateArrayIteratorTask, HttpTemplateInitialTask, HttpTemplateTask, HttpUrlContinuationTask, OnMessageTask, RecycleJdbcTask, RecycleJmsServerTask, ServerSocketAccepter, ServletBridgeManagedObjectSource.CompleteAsyncContextTask, ServletContainerResourceSectionSource.ServletContainerResourceTask, ServletRouteTask, SocketListener, SslTaskWork

public abstract class AbstractSingleTask<W extends Work,D extends Enum<D>,F extends Enum<F>>
extends Object
implements WorkFactory<W>, Work, TaskFactory<W,D,F>, Task<W,D,F>

Provides an abstract Task.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
AbstractSingleTask()

Method Summary

Modifier and Type	Method and Description
Task<W,D,F>	createTask(W work) Creates the Task.
W	createWork() Creates a new Work instance.
protected <MO extends ManagedObject> RecycleManagedObjectParameter<MO>	getRecycleManagedObjectParameter(TaskContext<W,D,F> context, Class<MO> managedObjectClass) Obtains the RecycleManagedObjectParameter.
void	registerAsRecycleTask(ManagedObjectSourceContext context, String teamName) Registers this Task to recycle the ManagedObject.
ManagedObjectTaskBuilder<D,F>	registerTask(String workName, String taskName, String teamName, ManagedObjectSourceContext<F> context) Registers this Task with the input ManagedObjectSourceContext.
TaskBuilder<W,D,F>	registerTask(String workName, String taskName, String teamName, OfficeBuilder officeBuilder) Registers this Task with the input OfficeBuilder.
TaskBuilder<W,D,F>	registerTask(String taskName, String teamName, WorkBuilder<W> workBuilder) Registers the Task with the input WorkBuilder.
WorkBuilder<W>	registerWork(String workName, OfficeBuilder officeBuilder) Registers this Work with the input OfficeBuilder.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.frame.api.execute.Task

doTask

Constructor Detail

AbstractSingleTask

public AbstractSingleTask()

Method Detail

registerWork

public WorkBuilder<W> registerWork(String workName,
                                   OfficeBuilder officeBuilder)

Registers this Work with the input OfficeBuilder.

Parameters:

workName - Name for Work.

officeBuilder - OfficeBuilder.

Returns:

WorkBuilder to configure the Work.

registerTask

public TaskBuilder<W,D,F> registerTask(String taskName,
                                       String teamName,
                                       WorkBuilder<W> workBuilder)

Registers the Task with the input WorkBuilder.

Parameters:

taskName - Name for Task.

teamName - Name for Team.

workBuilder - WorkBuilder.

Returns:

TaskBuilder to configure the Task.

registerTask

public TaskBuilder<W,D,F> registerTask(String workName,
                                       String taskName,
                                       String teamName,
                                       OfficeBuilder officeBuilder)

Registers this Task with the input OfficeBuilder.

Parameters:

workName - Name for Work.

taskName - Name for Task.

teamName - Name for Team.

officeBuilder - OfficeBuilder.

Returns:

TaskBuilder to configure the Task.

registerTask

public ManagedObjectTaskBuilder<D,F> registerTask(String workName,
                                                  String taskName,
                                                  String teamName,
                                                  ManagedObjectSourceContext<F> context)

Registers this Task with the input ManagedObjectSourceContext.

Parameters:

workName - Name for Work.

taskName - Name for Task.

teamName - Name for Team.

context - ManagedObjectSourceContext.

Returns:

ManagedObjectTaskBuilder to configure the Task.

registerAsRecycleTask

public void registerAsRecycleTask(ManagedObjectSourceContext context,
                                  String teamName)

Registers this Task to recycle the ManagedObject.

Parameters:

context - ManagedObjectSourceContext.

teamName - Name of the Team to recycle the ManagedObject.

See Also:

getRecycleManagedObjectParameter(TaskContext, Class)

getRecycleManagedObjectParameter

protected <MO extends ManagedObject> RecycleManagedObjectParameter<MO> getRecycleManagedObjectParameter(TaskContext<W,D,F> context,
                                                                                                        Class<MO> managedObjectClass)

Obtains the RecycleManagedObjectParameter.

Type Parameters:

MO - ManagedObject type.

Parameters:

context - TaskContext.

managedObjectClass - Class of the ManagedObject.

Returns:

RecycleManagedObjectParameter.

createWork

public W createWork()

Description copied from interface: WorkFactory

Creates a new Work instance.

Specified by:

createWork in interface WorkFactory<W extends Work>

Returns:

New Work instance.

createTask

public Task<W,D,F> createTask(W work)

Description copied from interface: TaskFactory

Creates the Task.

Specified by:

createTask in interface TaskFactory<W extends Work,D extends Enum<D>,F extends Enum<F>>

Parameters:

work - Work for the Task.

Returns:

Task to be done for the Work.