com.ebay.bascomtask.core

Class ConsumerTask.ConsumerTask1<IN>

java.lang.Object

com.ebay.bascomtask.core.ConsumerTask.ConsumerTask1<IN>

Type Parameters:

IN - type of input

All Implemented Interfaces:

ConsumerTask, TaskInterface<ConsumerTask>, TaskMeta, TaskRun, TaskRunner

Enclosing interface:

ConsumerTask

public static class ConsumerTask.ConsumerTask1<IN>
extends Object
implements ConsumerTask

An ConsumerTask that takes 1 argument.

Nested Class Summary

Nested classes/interfaces inherited from interface com.ebay.bascomtask.core.ConsumerTask

ConsumerTask.ConsumerTask1<IN>, ConsumerTask.ConsumerTask2<IN1,IN2>

Constructor Summary

Constructors

Constructor and Description
ConsumerTask1(Engine engine, CompletableFuture<IN> input, Consumer<IN> fn)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	apply() Creates a CompletableFuture around the lambda expression.
Object	before(TaskRun taskRun) Called before TaskRunner.executeTaskMethod(TaskRun, Thread, Object), but in the parent thread.
protected <RV> com.ebay.bascomtask.core.BascomTaskFuture<RV>	ensureWrapped(CompletableFuture<RV> cf, boolean registerAsDependentInput) Ensures the provided CF is or is wrapped by a BT-controlled CF, and registered as an input argument.
Object	executeTaskMethod(TaskRun taskRun, Thread parentThread, Object fromBefore) Task invocation -- an implementation should invoke TaskRun.run() to complete the invocation (unless there is some reason to prevent it, but then the implementation must take responsibility to ensure the all CompletableFuture return values are completed).
void	formatActualSignature(StringBuilder sb)
long	getCompletedAt() Returns the time at which this task method was completed, which for CompletableFutures is the time at which it had a value assigned.
long	getEndedAt() Returns the time at which this task method was ended.
String	getName() Returns the task name, e.g.
long	getStartedAt() Returns the time at which this task method was started.
TaskInterface<?>	getTask() Returns the user task pojo if there is one.
String	getTaskPlusMethodName()
protected Object	invokeTaskMethod()
boolean	isLight()
boolean	isRunSpawned()
THIS	name(String name)
void	onComplete(TaskRun taskRun, Object fromBefore, boolean doneOnExit) Called once any CompletableFuture return result completes, which may be before the call to TaskRun.run() or after if a method returns an incomplete CompletableFuture.
Object	run()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ebay.bascomtask.core.TaskInterface

activate, complete, complete, get, getName, isActivate, isLight, isRunSpawned, light, name, runSpawned

Methods inherited from interface com.ebay.bascomtask.core.TaskMeta

completedBefore, overlapped

Constructor Detail

ConsumerTask1

public ConsumerTask1(Engine engine,
                     CompletableFuture<IN> input,
                     Consumer<IN> fn)

Method Detail

apply

@Light
public CompletableFuture<Void> apply()

Description copied from interface: ConsumerTask

Creates a CompletableFuture around the lambda expression.

Specified by:

apply in interface ConsumerTask

Returns:

evaluated CompletableFuture

name

public THIS name(String name)

getTask

public TaskInterface<?> getTask()

Description copied from interface: TaskRun

Returns the user task pojo if there is one. For some internal tasks, there may not be.

Returns:

possibly null userTask

formatActualSignature

public void formatActualSignature(StringBuilder sb)

invokeTaskMethod

protected Object invokeTaskMethod()

toString

public String toString()

Overrides:

toString in class Object

isLight

public boolean isLight()

isRunSpawned

public boolean isRunSpawned()

ensureWrapped

protected <RV> com.ebay.bascomtask.core.BascomTaskFuture<RV> ensureWrapped(CompletableFuture<RV> cf,
                                                                           boolean registerAsDependentInput)

Ensures the provided CF is or is wrapped by a BT-controlled CF, and registered as an input argument.

Type Parameters:

RV - type of return value

Parameters:

cf - to ensure

registerAsDependentInput - if argument should be added to inputs list

Returns:

BT-controlled CF

before

public Object before(TaskRun taskRun)

Description copied from interface: TaskRunner

Called before TaskRunner.executeTaskMethod(TaskRun, Thread, Object), but in the parent thread. If there is no immediate spawning then it will be the same thread. The returned object will simply be passed to executeTaskMethod and is otherwise not read or modified by the framework.

Specified by:

before in interface TaskRunner

Parameters:

taskRun - that will also be passed to executeTaskMethod

Returns:

a possibly-null object to pass to executeTaskMethod

executeTaskMethod

public Object executeTaskMethod(TaskRun taskRun,
                                Thread parentThread,
                                Object fromBefore)

Description copied from interface: TaskRunner

Task invocation -- an implementation should invoke TaskRun.run() to complete the invocation (unless there is some reason to prevent it, but then the implementation must take responsibility to ensure the all CompletableFuture return values are completed). A typical subclass implementation would be to simply surround the call, e.g.:

     public Object executeTaskMethod(TaskRun taskRun, Thread parentThread, Object fromBefore) {
         LOG.info("STARTED " + taskRun.getTaskPlusMethodName());
         try {
             taskRun.run()
         } finally {
             LOG.info("ENDED " + taskRun.getTaskPlusMethodName());
         }
     }
 

Specified by:

executeTaskMethod in interface TaskRunner

Parameters:

taskRun - to execute

parentThread - of spawned task, which may be same as Thread.currentThread()

fromBefore - value returned from TaskRunner.before(TaskRun)

Returns:

return value from task invocation

onComplete

public void onComplete(TaskRun taskRun,
                       Object fromBefore,
                       boolean doneOnExit)

Description copied from interface: TaskRunner

Called once any CompletableFuture return result completes, which may be before the call to TaskRun.run() or after if a method returns an incomplete CompletableFuture.

The provided doneOnExit parameter indicates whether a CompletableFuture return value had isDone()==true when the method completed. This should not be taken as very close but not exactly precise, since there are very small time intervals involved in the steps behind making that determination.

Specified by:

onComplete in interface TaskRunner

Parameters:

taskRun - that was executed

fromBefore - value returned from TaskRunner.before(TaskRun)

doneOnExit - false iff a CompletableFuture was returned and it was not done when the method exited

run

public final Object run()

Specified by:

run in interface TaskRun

getName

public final String getName()

Description copied from interface: TaskRun

Returns the task name, e.g. for a user task TASK.METHOD, where TASK is the the user-specified task renaming else the class name if none.

Specified by:

getName in interface TaskRun

Returns:

never null name

getTaskPlusMethodName

public final String getTaskPlusMethodName()

Specified by:

getTaskPlusMethodName in interface TaskRun

getStartedAt

public long getStartedAt()

Description copied from interface: TaskMeta

Returns the time at which this task method was started.

Specified by:

getStartedAt in interface TaskMeta

Returns:

start time in ms or 0 if not started

getEndedAt

public long getEndedAt()

Description copied from interface: TaskMeta

Returns the time at which this task method was ended. This value would always be greater than or equal to TaskMeta.getStartedAt().

Specified by:

getEndedAt in interface TaskMeta

Returns:

end time in ms or 0 if not ended

getCompletedAt

public long getCompletedAt()

Description copied from interface: TaskMeta

Returns the time at which this task method was completed, which for CompletableFutures is the time at which it had a value assigned. This value is always greater than or equal to TaskMeta.getEndedAt(), and is greater than the ending time iff the CompletableFuture had !isDone() on method exit.

Specified by:

getCompletedAt in interface TaskMeta

Returns:

completion time in ms or 0 if not ended