Skip navigation links
A B C D E F G I L M N O P R S T U V W 

A

activate(long, CompletableFuture<?>...) - Method in class com.ebay.bascomtask.core.Engine
 
activate(long, CompletableFuture<T>) - Method in class com.ebay.bascomtask.core.Engine
 
activate(CompletableFuture<?>...) - Method in interface com.ebay.bascomtask.core.Orchestrator
Activates (enables for execution) the task methods behind each supplied CompletableFuture if they were generated through BascomTask and if they are have not already been activated.
activate(CompletableFuture<T>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Variant of Orchestrator.activate(CompletableFuture[] futures) that accepts only a single CompletableFuture argument and returns that same argument after having activated it.
activate(long, TimeUnit, CompletableFuture<?>...) - Method in interface com.ebay.bascomtask.core.Orchestrator
Variant of Orchestrator.activate(long, CompletableFuture[]) with TimeUnit option.
activate(long, TimeUnit, CompletableFuture<T>) - Method in interface com.ebay.bascomtask.core.Orchestrator
 
activate(long, CompletableFuture<T>) - Method in interface com.ebay.bascomtask.core.Orchestrator
 
activate(long, CompletableFuture<?>...) - Method in interface com.ebay.bascomtask.core.Orchestrator
Variant of Orchestrator.activate(CompletableFuture[]) that will timeout according to the TimeoutStrategy * in effect.
activate() - Method in interface com.ebay.bascomtask.core.TaskInterface
Forces immediate activation of task methods instead of the default behavior which is that task methods are only lazily activated according to the rules described in Orchestrator.task(TaskInterface).
activateAndWait(long, CompletableFuture<?>...) - Method in class com.ebay.bascomtask.core.Engine
 
activateAndWait(long, CompletableFuture<T>) - Method in class com.ebay.bascomtask.core.Engine
 
activateAndWait(long, List<CompletableFuture<T>>) - Method in class com.ebay.bascomtask.core.Engine
 
activateAndWait(CompletableFuture<?>...) - Method in interface com.ebay.bascomtask.core.Orchestrator
Variant of Orchestrator.activate(CompletableFuture[]) that waits for all of its arguments to complete (successfully or exceptionally).
activateAndWait(CompletableFuture<T>) - Method in interface com.ebay.bascomtask.core.Orchestrator
 
activateAndWait(long, TimeUnit, CompletableFuture<?>...) - Method in interface com.ebay.bascomtask.core.Orchestrator
activateAndWait(long, TimeUnit, CompletableFuture<T>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Activates then returns its single argument.
activateAndWait(long, CompletableFuture<?>...) - Method in interface com.ebay.bascomtask.core.Orchestrator
Variant of Orchestrator.activateAndWait(CompletableFuture[]) that will timeout according to the TimeoutStrategy in effect.
activateAndWait(long, CompletableFuture<T>) - Method in interface com.ebay.bascomtask.core.Orchestrator
 
activateAndWait(List<CompletableFuture<T>>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Variant of Orchestrator.activateAndWait(CompletableFuture[]) that returns a typed result from typed input.
activateAndWait(long, TimeUnit, List<CompletableFuture<T>>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Variant of Orchestrator.activateAndWait(long timeout, List) with TimeUnit option.
activateAndWait(long, List<CompletableFuture<T>>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Variant of Orchestrator.activateAndWait(long timeout, CompletableFuture[]) that returns a typed result matching the supplied typed input.
activateAsReady(long, List<CompletableFuture<T>>, TriConsumer<T, Throwable, Integer>) - Method in class com.ebay.bascomtask.core.Engine
 
activateAsReady(List<CompletableFuture<T>>, TriConsumer<T, Throwable, Integer>) - Method in interface com.ebay.bascomtask.core.Orchestrator
activateAsReady(long, TimeUnit, List<CompletableFuture<T>>, TriConsumer<T, Throwable, Integer>) - Method in interface com.ebay.bascomtask.core.Orchestrator
activateAsReady(long, List<CompletableFuture<T>>, TriConsumer<T, Throwable, Integer>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Activate each supplied future and invoke the supplied completionFn callback with each result as soon as each result becomes individually available.
activateFuture(long, List<CompletableFuture<T>>) - Method in class com.ebay.bascomtask.core.Engine
 
activateFuture(List<CompletableFuture<T>>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Initiates asynchronous activation on the supplied futures all using spawned threads, keeping the calling thread free.
activateFuture(long, TimeUnit, List<CompletableFuture<T>>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Variant of Orchestrator.activateFuture(long, List) with TimeUnit option.
activateFuture(long, List<CompletableFuture<T>>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Variant of Orchestrator.activateFuture(List) that will timeout according to the TimeoutStrategy in effect
afterDefaultInitialization(Orchestrator, Object) - Method in class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
Subclasses can override to provide custom logic for GlobalOrchestratorConfig.Config.updateConfigurationOn(Orchestrator, Object).
apply() - Method in interface com.ebay.bascomtask.core.ConsumerTask
Creates a CompletableFuture around the lambda expression.
apply() - Method in class com.ebay.bascomtask.core.ConsumerTask.ConsumerTask1
 
apply() - Method in class com.ebay.bascomtask.core.ConsumerTask.ConsumerTask2
 
apply() - Method in interface com.ebay.bascomtask.core.SupplierTask
Creates a CompletableFuture around the lambda expression.
apply() - Method in class com.ebay.bascomtask.core.SupplierTask.SupplierTask0
 
apply() - Method in class com.ebay.bascomtask.core.SupplierTask.SupplierTask1
 
apply() - Method in class com.ebay.bascomtask.core.SupplierTask.SupplierTask2
 
apply(T, U, V) - Method in interface com.ebay.bascomtask.core.TriConsumer
Applies this function to the given arguments.
average - Variable in class com.ebay.bascomtask.runners.StatTaskRunner.Timing
 

B

before(TaskRun) - Method in interface com.ebay.bascomtask.core.TaskRunner
Called before TaskRunner.executeTaskMethod(TaskRun, Thread, Object), but in the parent thread.
before(TaskRun) - Method in class com.ebay.bascomtask.runners.LogTaskRunner
 
before(TaskRun) - Method in class com.ebay.bascomtask.runners.ProfilingTaskRunner
 
before(TaskRun) - Method in class com.ebay.bascomtask.runners.StatTaskRunner
 

C

close() - Method in class com.ebay.bascomtask.core.LaneRunner
 
collect() - Method in class com.ebay.bascomtask.runners.StatTaskRunner
Returns a summarized execution data snapshot.
com.ebay.bascomtask.annotations - package com.ebay.bascomtask.annotations
 
com.ebay.bascomtask.core - package com.ebay.bascomtask.core
 
com.ebay.bascomtask.exceptions - package com.ebay.bascomtask.exceptions
 
com.ebay.bascomtask.runners - package com.ebay.bascomtask.runners
 
CommonConfig - Interface in com.ebay.bascomtask.core
Configuration settings.
complete(R) - Method in interface com.ebay.bascomtask.core.TaskInterface
Convenience method for subclasses that creates a CompletableFuture from a constant value, which may or may not be null.
complete() - Method in interface com.ebay.bascomtask.core.TaskInterface
Convenience method for subclasses that return a void result.
completedBefore(TaskMeta) - Method in interface com.ebay.bascomtask.core.TaskMeta
 
completionTime - Variable in class com.ebay.bascomtask.runners.StatTaskRunner.Stat
 
cond(CompletableFuture<Boolean>, CompletableFuture<R>, boolean) - Method in class com.ebay.bascomtask.core.Engine
 
cond(CompletableFuture<Boolean>, CompletableFuture<R>, boolean, CompletableFuture<R>, boolean) - Method in class com.ebay.bascomtask.core.Engine
 
cond(CompletableFuture<Boolean>, CompletableFuture<R>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Activate the supplied CompletableFuture if the supplied condition evaluates to true.
cond(CompletableFuture<Boolean>, CompletableFuture<R>, boolean) - Method in interface com.ebay.bascomtask.core.Orchestrator
Variant of Orchestrator.cond(CompletableFuture, CompletableFuture) with an additional boolean argument indicating whether to proactively activate thenFuture at the same time as condition.
cond(CompletableFuture<Boolean>, CompletableFuture<R>, CompletableFuture<R>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Activate one of two choices depending on the result of the supplied condition.
cond(CompletableFuture<Boolean>, CompletableFuture<R>, boolean, CompletableFuture<R>, boolean) - Method in interface com.ebay.bascomtask.core.Orchestrator
Variant of Orchestrator.cond(CompletableFuture, CompletableFuture, CompletableFuture) with additional boolean arguments indicating whether to proactively activate thenFuture and/or elseFuture when condition is activated.
Config() - Constructor for class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
 
ConsumerTask - Interface in com.ebay.bascomtask.core
Function tasks added through 'fn()' methods on Orchestrator allow CompletableFuture tasks to be created from lambda expressions that do not return a value.
ConsumerTask.ConsumerTask1<IN> - Class in com.ebay.bascomtask.core
An ConsumerTask that takes 1 argument.
ConsumerTask.ConsumerTask2<IN1,IN2> - Class in com.ebay.bascomtask.core
An ConsumerTask that takes 2 arguments.
ConsumerTask1(Engine, CompletableFuture<IN>, Consumer<IN>) - Constructor for class com.ebay.bascomtask.core.ConsumerTask.ConsumerTask1
 
ConsumerTask2(Engine, CompletableFuture<IN1>, CompletableFuture<IN2>, BiConsumer<IN1, IN2>) - Constructor for class com.ebay.bascomtask.core.ConsumerTask.ConsumerTask2
 
count - Variable in class com.ebay.bascomtask.runners.StatTaskRunner.Stat
 
create() - Static method in interface com.ebay.bascomtask.core.Orchestrator
Creates an Orchestrator with no name.
create(String) - Static method in interface com.ebay.bascomtask.core.Orchestrator
Creates a new named Orchestrator with the supplied name.
create(String, Object) - Static method in interface com.ebay.bascomtask.core.Orchestrator
Creates an Orchestrator with the given name and argument.
current() - Static method in interface com.ebay.bascomtask.core.Orchestrator
Returns the orchestrator used to activate the current task method in the current thread.

D

DEFAULT_FIXED_THREADPOOL_SIZE - Static variable in class com.ebay.bascomtask.core.GlobalOrchestratorConfig
 

E

Engine - Class in com.ebay.bascomtask.core
Core implementation of orchestrator maintains task state during execution.
execTime - Variable in class com.ebay.bascomtask.runners.StatTaskRunner.Stat
 
execute(CompletableFuture<?>...) - Method in interface com.ebay.bascomtask.core.Orchestrator
Deprecated.
execute(long, CompletableFuture<?>...) - Method in interface com.ebay.bascomtask.core.Orchestrator
Deprecated.
execute(long, TimeUnit, CompletableFuture<?>...) - Method in interface com.ebay.bascomtask.core.Orchestrator
Deprecated.
executeAndWait(CompletableFuture<?>...) - Method in interface com.ebay.bascomtask.core.Orchestrator
Deprecated.
executeAndWait(long, TimeUnit, CompletableFuture<?>...) - Method in interface com.ebay.bascomtask.core.Orchestrator
Deprecated.
executeAndWait(long, CompletableFuture<?>...) - Method in interface com.ebay.bascomtask.core.Orchestrator
Deprecated.
executeTaskMethod(TaskRun, Thread, Object) - Method in interface com.ebay.bascomtask.core.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).
executeTaskMethod(TaskRun, Thread, Object) - Method in class com.ebay.bascomtask.runners.LogTaskRunner
 
executeTaskMethod(TaskRun, Thread, Object) - Method in class com.ebay.bascomtask.runners.ProfilingTaskRunner
 
executeTaskMethod(TaskRun, Thread, Object) - Method in class com.ebay.bascomtask.runners.StatTaskRunner
 
executorService - Variable in class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
 

F

fate(CompletableFuture<?>...) - Method in class com.ebay.bascomtask.core.Engine
 
fate(CompletableFuture<?>...) - Method in interface com.ebay.bascomtask.core.Orchestrator
Ties the 'fates' of the supplied CompletableFutures together, which means that as soon as there is a fault on any one of them, back-pressure is applied to prevent any of the remaining tasks or their predecessors (as determined recursively) from starting if they have not already been started, and forcing a TaskNotStartedException on any CompletableFuture that was prevented from starting in that manner.
first - Variable in class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
 
firstInterceptWith(TaskRunner) - Method in interface com.ebay.bascomtask.core.CommonConfig
Adds a TaskRunner that will be processed before any existing TaskRunner.
firstInterceptWith(TaskRunner) - Method in class com.ebay.bascomtask.core.Engine
 
firstInterceptWith(TaskRunner) - Method in class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
 
fn(Supplier<R>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Produces function task value that takes no arguments and produces one result.
fn(Supplier<IN>, Function<IN, R>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Produces function task value that takes one argument and produces one result.
fn(CompletableFuture<T>, Function<T, R>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Produces function result from one argument.
fn(CompletableFuture<T>, CompletableFuture<U>, BiFunction<T, U, R>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Produces function result from two arguments.
fn(Supplier<IN1>, CompletableFuture<IN2>, BiFunction<IN1, IN2, R>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Produces function task value that takes mixed arguments and produces one result.
fn(CompletableFuture<IN1>, Supplier<IN2>, BiFunction<IN1, IN2, R>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Produces function task value that takes mixed arguments and produces one result.
fn(Supplier<IN1>, Supplier<IN2>, BiFunction<IN1, IN2, R>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Produces function task value that takes two lambda arguments and produces one result.
fnTask(Supplier<R>) - Method in class com.ebay.bascomtask.core.Engine
 
fnTask(Supplier<IN>, Function<IN, R>) - Method in class com.ebay.bascomtask.core.Engine
 
fnTask(CompletableFuture<T>, Function<T, R>) - Method in class com.ebay.bascomtask.core.Engine
 
fnTask(CompletableFuture<T>, CompletableFuture<U>, BiFunction<T, U, R>) - Method in class com.ebay.bascomtask.core.Engine
 
fnTask(Supplier<R>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Produces function task that takes no arguments and produces one result.
fnTask(Supplier<IN>, Function<IN, R>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Produces function task that takes one argument and produces one result.
fnTask(CompletableFuture<T>, Function<T, R>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Produces function task that takes one argument.
fnTask(CompletableFuture<T>, CompletableFuture<U>, BiFunction<T, U, R>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Produces function task that takes two arguments.
fnTask(Supplier<IN1>, CompletableFuture<IN2>, BiFunction<IN1, IN2, R>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Produces function task that takes mixed arguments and produces one result.
fnTask(CompletableFuture<IN1>, Supplier<IN2>, BiFunction<IN1, IN2, R>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Produces function task that takes mixed arguments and produces one result.
fnTask(Supplier<IN1>, Supplier<IN2>, BiFunction<IN1, IN2, R>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Produces function task that takes two lambda arguments and produces one result.
format() - Method in class com.ebay.bascomtask.runners.ProfilingTaskRunner
Returns a tabular execution profile with events as rows and threads as columns.
formatActualSignature(StringBuilder) - Method in interface com.ebay.bascomtask.core.TaskRun
 

G

get(CompletableFuture<R>) - Method in interface com.ebay.bascomtask.core.TaskInterface
Convenience method for subclasses for accessing a CompletableFuture argument.
getCompletedAt() - Method in interface com.ebay.bascomtask.core.TaskMeta
Returns the time at which this task method was completed, which for CompletableFutures is the time at which it had a value assigned.
getConfig() - Static method in class com.ebay.bascomtask.core.GlobalOrchestratorConfig
 
getCountOfThreadsSpawned() - Method in class com.ebay.bascomtask.core.Engine
 
getCountOfThreadsSpawned() - Method in interface com.ebay.bascomtask.core.Orchestrator
Returns the number of threads that have been spawned by this Orchestrator.
getEndedAt() - Method in interface com.ebay.bascomtask.core.TaskMeta
Returns the time at which this task method was ended.
getExecutorService() - Method in interface com.ebay.bascomtask.core.CommonConfig
 
getExecutorService() - Method in class com.ebay.bascomtask.core.Engine
 
getExecutorService() - Method in class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
 
getName() - Method in class com.ebay.bascomtask.core.Engine
 
getName() - Method in interface com.ebay.bascomtask.core.Orchestrator
getName() - Method in interface com.ebay.bascomtask.core.TaskInterface
Returns the name of this task, useful for logging and profiling.
getName() - Method in interface com.ebay.bascomtask.core.TaskRun
Returns the task name, e.g.
getNumberOfInterceptors() - Method in interface com.ebay.bascomtask.core.CommonConfig
Returns the current number of interceptors, as set by CommonConfig.firstInterceptWith(TaskRunner), CommonConfig.lastInterceptWith(TaskRunner), or for Orchestrators as set from current global settings.
getNumberOfInterceptors() - Method in class com.ebay.bascomtask.core.Engine
 
getNumberOfInterceptors() - Method in class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
 
getSpawnMode() - Method in interface com.ebay.bascomtask.core.CommonConfig
Gets the most recently set mode.
getSpawnMode() - Method in class com.ebay.bascomtask.core.Engine
 
getSpawnMode() - Method in class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
 
getStartedAt() - Method in interface com.ebay.bascomtask.core.TaskMeta
Returns the time at which this task method was started.
getTask() - Method in interface com.ebay.bascomtask.core.TaskRun
Returns the user task pojo if there is one.
getTaskMeta(CompletableFuture<?>) - Method in class com.ebay.bascomtask.core.Engine
 
getTaskMeta(CompletableFuture<?>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Returns details for any future previously registered with Orchestrator.activate(CompletableFuture[]) (directly or through an operation on a CompletableFuture return value).
getTaskPlusMethodName() - Method in interface com.ebay.bascomtask.core.TaskRun
 
getTimeoutMs() - Method in interface com.ebay.bascomtask.core.CommonConfig
Gets the current timeout.
getTimeoutMs() - Method in class com.ebay.bascomtask.core.Engine
 
getTimeoutMs() - Method in class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
 
getTimeoutStrategy() - Method in interface com.ebay.bascomtask.core.CommonConfig
Gets the current timeout strategy, default is TimeoutStrategy.PREVENT_NEW.
getTimeoutStrategy() - Method in class com.ebay.bascomtask.core.Engine
 
getTimeoutStrategy() - Method in class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
 
GlobalOrchestratorConfig - Class in com.ebay.bascomtask.core
Maintains configuration settings that will be applied to new Orchestrators.
GlobalOrchestratorConfig() - Constructor for class com.ebay.bascomtask.core.GlobalOrchestratorConfig
 
GlobalOrchestratorConfig.Config - Class in com.ebay.bascomtask.core
Default implementation maintains values that are transferred to an Orchestrator on demand.

I

initializers - Variable in class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
 
initializeWith(BiConsumer<Orchestrator, Object>) - Method in class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
 
interceptFirstOnCreate(Supplier<T>) - Static method in class com.ebay.bascomtask.core.GlobalOrchestratorConfig
Set a TaskRunner creation function that will apply to every Orchestrator created in this this thread.
interceptLastOnCreate(Supplier<T>) - Static method in class com.ebay.bascomtask.core.GlobalOrchestratorConfig
Set a TaskRunner creation function that will apply to every Orchestrator created in this this thread.
InvalidTaskException - Exception in com.ebay.bascomtask.exceptions
Applies to a task that cannot be processed by the framework.
InvalidTaskException(String) - Constructor for exception com.ebay.bascomtask.exceptions.InvalidTaskException
 
InvalidTaskMethodException - Exception in com.ebay.bascomtask.exceptions
Applies to a task that cannot method be executed by the framework.
InvalidTaskMethodException(String) - Constructor for exception com.ebay.bascomtask.exceptions.InvalidTaskMethodException
 
isActivate() - Method in interface com.ebay.bascomtask.core.TaskInterface
Indicates that task methods should be activated immediately.
isEnabled(Logger) - Method in enum com.ebay.bascomtask.runners.LogTaskLevel
 
isLight() - Method in interface com.ebay.bascomtask.core.TaskInterface
Indicates the default weight of task methods that do not have a Light annotation.
isMainThreadReusable() - Method in enum com.ebay.bascomtask.core.SpawnMode
Returns true if this mode allows for the main thread can be picked up while idle and otherwise waiting for a CompletableFuture to complete, and used to to process spawning task methods.
isRunSpawned() - Method in interface com.ebay.bascomtask.core.TaskInterface
Indicates that task methods should have threads spawned for them.

L

LaneRunner<T extends TaskRunner> - Class in com.ebay.bascomtask.core
Establishes a TaskRunner creation capability that for each new Orchestrator created in this thread will be applied and recorded for later retrieval.
last - Variable in class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
 
lastInterceptWith(TaskRunner) - Method in interface com.ebay.bascomtask.core.CommonConfig
Adds a TaskRunner that will be processed after any existing TaskRunner.
lastInterceptWith(TaskRunner) - Method in class com.ebay.bascomtask.core.Engine
 
lastInterceptWith(TaskRunner) - Method in class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
 
Light - Annotation Type in com.ebay.bascomtask.annotations
Marks a task method that is fast, likely because it does not make external calls or access a database.
light() - Method in interface com.ebay.bascomtask.core.TaskInterface
Forces inline execution of task methods on this object, i.e.
LogTaskLevel - Enum in com.ebay.bascomtask.runners
Provides missing log levels for slf4j.
LogTaskRunner - Class in com.ebay.bascomtask.runners
Logs task execution before and after, with a configurable level and detail.
LogTaskRunner() - Constructor for class com.ebay.bascomtask.runners.LogTaskRunner
 

M

max - Variable in class com.ebay.bascomtask.runners.StatTaskRunner.Timing
 
min - Variable in class com.ebay.bascomtask.runners.StatTaskRunner.Timing
 
MisplacedTaskMethodException - Exception in com.ebay.bascomtask.exceptions
Thrown when a TaskInterface method is called directly on a user POJO rather than the wrapper return from Orchestrator.task(TaskInterface), when the user POJO has not overridden such methods (which is usually the case).
MisplacedTaskMethodException(TaskInterface<?>, String) - Constructor for exception com.ebay.bascomtask.exceptions.MisplacedTaskMethodException
 

N

name(String) - Method in interface com.ebay.bascomtask.core.TaskInterface
Provides a name for this task, useful for logging and profiling.

O

onComplete(TaskRun, Object, boolean) - Method in interface com.ebay.bascomtask.core.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.
onComplete(TaskRun, Object, boolean) - Method in class com.ebay.bascomtask.runners.LogTaskRunner
 
onComplete(TaskRun, Object, boolean) - Method in class com.ebay.bascomtask.runners.ProfilingTaskRunner
 
onComplete(TaskRun, Object, boolean) - Method in class com.ebay.bascomtask.runners.StatTaskRunner
 
Orchestrator - Interface in com.ebay.bascomtask.core
Provides entry points for task method activation, and for common configuration among all such tasks.
overlapped(TaskMeta) - Method in interface com.ebay.bascomtask.core.TaskMeta
 

P

ProfilingTaskRunner - Class in com.ebay.bascomtask.runners
Tracks and creates a task execution profile on demand.
ProfilingTaskRunner() - Constructor for class com.ebay.bascomtask.runners.ProfilingTaskRunner
 

R

removeAllInterceptors() - Method in interface com.ebay.bascomtask.core.CommonConfig
Removes all interceptors from the current list.
removeAllInterceptors() - Method in class com.ebay.bascomtask.core.Engine
 
removeAllInterceptors() - Method in class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
 
removeInterceptor(TaskRunner) - Method in interface com.ebay.bascomtask.core.CommonConfig
Removes the given TaskRunner from the current list, if it is there.
removeInterceptor(TaskRunner) - Method in class com.ebay.bascomtask.core.Engine
 
removeInterceptor(TaskRunner) - Method in class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
 
report(PrintStream) - Method in class com.ebay.bascomtask.runners.StatTaskRunner
Prints a tabular-formatted summary of statistics to the given PrintStream.
report() - Method in class com.ebay.bascomtask.runners.StatTaskRunner
Returns a table-formatted summary as a string.
Report() - Constructor for class com.ebay.bascomtask.runners.StatTaskRunner.Report
 
restoreConfigurationDefaults(Object) - Method in interface com.ebay.bascomtask.core.CommonConfig
Restore default settings.
restoreConfigurationDefaults(Object) - Method in class com.ebay.bascomtask.core.Engine
 
restoreConfigurationDefaults(Object) - Method in class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
 
restoreDefaultExecutorService() - Method in interface com.ebay.bascomtask.core.CommonConfig
 
restoreDefaultExecutorService() - Method in class com.ebay.bascomtask.core.Engine
 
restoreDefaultExecutorService() - Method in class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
 
run() - Method in interface com.ebay.bascomtask.core.TaskRun
 
runners - Variable in class com.ebay.bascomtask.core.LaneRunner
Exposes all TaskRunners created by the thread that invoked the constructor, up until the time this LaneRunner was closed (if it has been closed).
runSpawned() - Method in interface com.ebay.bascomtask.core.TaskInterface
Forces a new thread to be allocated for task methods on this class, which can be useful to keep the calling thread free for other purposes.

S

setConfig(GlobalOrchestratorConfig.Config) - Static method in class com.ebay.bascomtask.core.GlobalOrchestratorConfig
 
setExecutorService(ExecutorService) - Method in interface com.ebay.bascomtask.core.CommonConfig
Resets the service used by this framework for spawning threads.
setExecutorService(ExecutorService) - Method in class com.ebay.bascomtask.core.Engine
 
setExecutorService(ExecutorService) - Method in class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
 
setFullSignatureLogging(boolean) - Method in class com.ebay.bascomtask.runners.LogTaskRunner
Makes log output include actual method arguments.
setLevel(LogTaskLevel) - Method in class com.ebay.bascomtask.runners.LogTaskRunner
Set debug level.
setName(String) - Method in class com.ebay.bascomtask.core.Engine
 
setName(String) - Method in interface com.ebay.bascomtask.core.Orchestrator
Sets name that will become part of the name for any threads spawned by this Orchestrator.
setSpawnMode(SpawnMode) - Method in interface com.ebay.bascomtask.core.CommonConfig
Changes the thread-spawning logic to be consistent with the specified mode.
setSpawnMode(SpawnMode) - Method in class com.ebay.bascomtask.core.Engine
 
setSpawnMode(SpawnMode) - Method in class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
 
setTimeout(long, TimeUnit) - Method in interface com.ebay.bascomtask.core.CommonConfig
Calls CommonConfig.setTimeoutMs(long) after calculating the millisecond duration from the supplied arguments.
setTimeoutMs(long) - Method in interface com.ebay.bascomtask.core.CommonConfig
Sets the current timeout.
setTimeoutMs(long) - Method in class com.ebay.bascomtask.core.Engine
 
setTimeoutMs(long) - Method in class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
 
setTimeoutStrategy(TimeoutStrategy) - Method in interface com.ebay.bascomtask.core.CommonConfig
Sets the strategy to apply if a timeout greater than zero is in effect and is exceeded.
setTimeoutStrategy(TimeoutStrategy) - Method in class com.ebay.bascomtask.core.Engine
 
setTimeoutStrategy(TimeoutStrategy) - Method in class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
 
spawnMode - Variable in class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
 
SpawnMode - Enum in com.ebay.bascomtask.core
Defines thread spawning behavior for the BascomTask framework.
Stat() - Constructor for class com.ebay.bascomtask.runners.StatTaskRunner.Stat
 
StatTaskRunner - Class in com.ebay.bascomtask.runners
Collects various task execution statistics.
StatTaskRunner() - Constructor for class com.ebay.bascomtask.runners.StatTaskRunner
 
StatTaskRunner.Report - Class in com.ebay.bascomtask.runners
 
StatTaskRunner.Stat - Class in com.ebay.bascomtask.runners
 
StatTaskRunner.Timing - Class in com.ebay.bascomtask.runners
 
SupplierTask<R> - Interface in com.ebay.bascomtask.core
Function tasks added through 'fn()' methods on Orchestrator allow CompletableFuture tasks to be created from lambda expressions that supply a return value.
SupplierTask.SupplierTask0<R> - Class in com.ebay.bascomtask.core
An SupplierTask that takes no arguments.
SupplierTask.SupplierTask1<T,R> - Class in com.ebay.bascomtask.core
An SupplierTask that takes 1 argument.
SupplierTask.SupplierTask2<T,U,R> - Class in com.ebay.bascomtask.core
An SupplierTask that takes 2 arguments.
SupplierTask0(Engine, Supplier<R>) - Constructor for class com.ebay.bascomtask.core.SupplierTask.SupplierTask0
 
SupplierTask1(Engine, CompletableFuture<T>, Function<T, R>) - Constructor for class com.ebay.bascomtask.core.SupplierTask.SupplierTask1
 
SupplierTask2(Engine, CompletableFuture<T>, CompletableFuture<U>, BiFunction<T, U, R>) - Constructor for class com.ebay.bascomtask.core.SupplierTask.SupplierTask2
 

T

task(SUB) - Method in class com.ebay.bascomtask.core.Engine
 
task(SUB) - Method in interface com.ebay.bascomtask.core.Orchestrator
Creates a task wrapper around any POJO class whose interface X in turn implements TaskInterface<X>.
task(TASK, Function<TASK, R>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Creates a task wrapper on any user pojo task method.
TaskInterface<T> - Interface in com.ebay.bascomtask.core
Common interface that all user POJO task interfaces must implement in order to be added to an Orchestrator, for example like this:
TaskMeta - Interface in com.ebay.bascomtask.core
Exposes execution statistics to TaskRunners.
taskMethod - Variable in class com.ebay.bascomtask.runners.StatTaskRunner.Stat
 
TaskNotStartedException - Exception in com.ebay.bascomtask.exceptions
Applies to a task that was never started because of an exception elsewhere.
TaskNotStartedException(Throwable) - Constructor for exception com.ebay.bascomtask.exceptions.TaskNotStartedException
 
TaskRun - Interface in com.ebay.bascomtask.core
User task wrapper exposed to TaskRunners.
TaskRunner - Interface in com.ebay.bascomtask.core
Interface for task execution hooks that allow custom code to be inserted before and after the invocation of task methods.
TimeoutExceededException - Exception in com.ebay.bascomtask.exceptions
When a timeout has been specified and exceeded.
TimeoutExceededException(String) - Constructor for exception com.ebay.bascomtask.exceptions.TimeoutExceededException
 
timeoutMs - Variable in class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
 
timeoutStrategy - Variable in class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
 
TimeoutStrategy - Enum in com.ebay.bascomtask.core
Strategies for dealing with execution timeouts that impact threads spawned during the execution of a request such as CompletableFuture.get(long, TimeUnit).
Timing() - Constructor for class com.ebay.bascomtask.runners.StatTaskRunner.Timing
 
toString() - Method in class com.ebay.bascomtask.core.Engine
 
TriConsumer<T,U,V> - Interface in com.ebay.bascomtask.core
Three-arg variant of BiConsumer.

U

updateConfigurationOn(Orchestrator, Object) - Method in class com.ebay.bascomtask.core.GlobalOrchestratorConfig.Config
Transfers configuration settings to the supplied orchestrator.

V

valueOf(String) - Static method in enum com.ebay.bascomtask.core.SpawnMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ebay.bascomtask.core.TimeoutStrategy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ebay.bascomtask.runners.LogTaskLevel
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.ebay.bascomtask.core.SpawnMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ebay.bascomtask.core.TimeoutStrategy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ebay.bascomtask.runners.LogTaskLevel
Returns an array containing the constants of this enum type, in the order they are declared.
vfn(Supplier<IN>, Consumer<IN>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Produces function task value that takes one lambda argument and produces no result.
vfn(CompletableFuture<IN1>, Supplier<IN2>, BiConsumer<IN1, IN2>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Produces function task value that takes mixed arguments and produces no result.
vfn(CompletableFuture<IN1>, CompletableFuture<IN2>, BiConsumer<IN1, IN2>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Produces function task value that takes non-lambda arguments and produces no result.
vfn(Supplier<IN1>, CompletableFuture<IN2>, BiConsumer<IN1, IN2>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Produces function task value that takes mixed arguments and produces no result.
vfn(Supplier<IN1>, Supplier<IN2>, BiConsumer<IN1, IN2>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Produces function task value that takes two lambda arguments and produces no result.
vfnTask(Supplier<IN>, Consumer<IN>) - Method in class com.ebay.bascomtask.core.Engine
 
vfnTask(CompletableFuture<IN1>, Supplier<IN2>, BiConsumer<IN1, IN2>) - Method in class com.ebay.bascomtask.core.Engine
 
vfnTask(CompletableFuture<IN1>, CompletableFuture<IN2>, BiConsumer<IN1, IN2>) - Method in class com.ebay.bascomtask.core.Engine
 
vfnTask(Supplier<IN1>, CompletableFuture<IN2>, BiConsumer<IN1, IN2>) - Method in class com.ebay.bascomtask.core.Engine
 
vfnTask(Supplier<IN1>, Supplier<IN2>, BiConsumer<IN1, IN2>) - Method in class com.ebay.bascomtask.core.Engine
 
vfnTask(Supplier<IN>, Consumer<IN>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Produces function task that takes one lambda argument and produces no result.
vfnTask(CompletableFuture<IN1>, Supplier<IN2>, BiConsumer<IN1, IN2>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Produces function task that takes mixed arguments and produces no result.
vfnTask(CompletableFuture<IN1>, CompletableFuture<IN2>, BiConsumer<IN1, IN2>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Produces function task that takes non-lambda arguments and produces no result.
vfnTask(Supplier<IN1>, CompletableFuture<IN2>, BiConsumer<IN1, IN2>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Produces function task that takes mixed arguments and produces no result.
vfnTask(Supplier<IN1>, Supplier<IN2>, BiConsumer<IN1, IN2>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Produces function task that takes two lambda arguments and produces no result.
voidTask(TASK, Consumer<TASK>) - Method in interface com.ebay.bascomtask.core.Orchestrator
Adds a task wrapper on any user pojo task method with a void result.

W

write(Logger, String) - Method in enum com.ebay.bascomtask.runners.LogTaskLevel
 
write(Logger, String, Object) - Method in enum com.ebay.bascomtask.runners.LogTaskLevel
 
write(Logger, String, Object, Object) - Method in enum com.ebay.bascomtask.runners.LogTaskLevel
 
write(Logger, String, Object...) - Method in enum com.ebay.bascomtask.runners.LogTaskLevel
 
write(Logger, String, Throwable) - Method in enum com.ebay.bascomtask.runners.LogTaskLevel
 
A B C D E F G I L M N O P R S T U V W 
Skip navigation links

Copyright © 2021. All rights reserved.