sirius.web.tasks

Class ManagedTaskSetup

java.lang.Object

sirius.web.tasks.ManagedTaskSetup

public class ManagedTaskSetup
extends Object

A builder pattern to create a ManagedTask.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	category
protected ManagedTasks	managedTasks
protected String	name
protected Consumer<ManagedTaskContext>	task

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ManagedTaskSetup(ManagedTasks managedTasks, String name)

Method Summary

Modifier and Type	Method and Description
ManagedTask	execute(Consumer<ManagedTaskContext> task) Creates the managed task for the given consumer which will be supplied with a ManagedTaskContext and executed in the background.
ManagedTaskSetup	withCategory(String category) Used to specify the executor / category of the task.

Methods inherited from class java.lang.Object

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

Field Detail

managedTasks

protected ManagedTasks managedTasks

name

protected String name

category

protected String category

task

protected Consumer<ManagedTaskContext> task

Constructor Detail

ManagedTaskSetup

protected ManagedTaskSetup(ManagedTasks managedTasks,
                           String name)

Method Detail

withCategory

public ManagedTaskSetup withCategory(String category)

Used to specify the executor / category of the task.

Parameters:

category - the category to execute this task in

Returns:

the setup itself for fluent method calls

See Also:

Tasks.executor(String)

execute

public ManagedTask execute(Consumer<ManagedTaskContext> task)

Creates the managed task for the given consumer which will be supplied with a ManagedTaskContext and executed in the background.

Parameters:

task - the actual task to execute

Returns:

the newly created managed task