com.ebay.bascomtask.core

Interface TaskInterface<T>

Type Parameters:

T - identifies that interface as one that defines task methods

All Known Subinterfaces:

ConsumerTask, SupplierTask<R>

All Known Implementing Classes:

ConsumerTask.ConsumerTask1, ConsumerTask.ConsumerTask2, SupplierTask.SupplierTask0, SupplierTask.SupplierTask1, SupplierTask.SupplierTask2

public interface TaskInterface<T>

Common interface that all user POJO task object interfaces should implement, like this:

 interface IDelay implements TaskInterface<IDelay> {
    public void exec(...);
 }

 class Delay implements IDelay {...}
 

Note that Delay or IDelay can implement/extend other interfaces, but among all of them only one should be designated as a TaskInterface in the manner above.

There are no methods to implement from this interface, but it does provide several common methods on tasks. It also allows the BT task-dependency mechanism to work properly.

Author:

Brendan McCarthy

Method Summary

Modifier and Type	Method and Description
default CompletableFuture<Void>	complete() Convenience method for returning a void result.
default <R> CompletableFuture<R>	complete(R arg) Convenience method creates a CompletableFuture from a constant value, which may or may not be null.
default <R> R	get(Future<R> future) Convenience method that calls future.get() but turns any checked exceptions from that call into unchecked ones.
default String	getName() Returns the name of this task, useful for logging and profiling.
default T	light() Forces execution within the outer thread, i.e.
default T	name(String name) Provides a name for this task, useful for logging and profiling.
default T	runSpawned() Forces a new thread to be allocated for this task.

Method Detail

name

default T name(String name)

Provides a name for this task, useful for logging and profiling. Subclasses can optionally override if they want to allow setting a default name. When invoked on a TaskWrapper (the object that is returned by adding a task to an Orchestrator), it does not pass that call to this method. TaskWrappers manages names on their own (any number of TaskWrappers can reference the same user task).

Parameters:

name - to set

Returns:

this

getName

default String getName()

Returns the name of this task, useful for logging and profiling. Subclasses can optionally override if they want to expose something other than the class name as the default name. Whether or not overridden, any TaskWrapper (the object that is returned by adding a task to an Orchestrator) that wraps this object (there can be more than one) will manage its own name and use this value returned here only if not explicitly set during task orchestration.

Returns:

name

light

default T light()

Forces execution within the outer thread, i.e. prevents a new thread from being spawned for this task. Equivalent to using the Light annotation on a task method.

Reverses any previous call to runSpawned()

Returns:

this

runSpawned

default T runSpawned()

Forces a new thread to be allocated for this task. This can be useful to keep the calling task free for other purposes. This overrides the default behavior, which is spawn threads for each task > 1 when an executing thread finds more than one task ready to fire.

Reverses any previous call to light() or any Light annotation

Returns:

this

get

default <R> R get(Future<R> future)

Convenience method that calls future.get() but turns any checked exceptions from that call into unchecked ones. This is useful in tasks because a task is always called with valid futures so those exceptions will never be generated. Calling this method is not a requirement as task methods can simply call future.get() directly and handle or throw the exceptions themselves.

Type Parameters:

R - type of value returned

Parameters:

future - to retrieve value from

Returns:

value wrapped by the supplied future, which may or may not be null

complete

default <R> CompletableFuture<R> complete(R arg)

Convenience method creates a CompletableFuture from a constant value, which may or may not be null.

Type Parameters:

R - type of value returned

Parameters:

arg - value to wrap

Returns:

CompletableFuture that wraps the provided value

complete

default CompletableFuture<Void> complete()

Convenience method for returning a void result. The framework requires a return result even for logically void methods in order to expose common methods (such as being able to start task execution) on the return result.

Returns:

a void result