Index (com.ebay.bascomtask:bascomtask-core 1.2.0 API)

A B C D E F G H I M N O P R S T V W

A

addConditionally(Object, boolean) - Method in class com.ebay.bascomtask.main.Orchestrator: A convenience method, adds a task with a default name that is either active or passive depending on the given condition.
addIgnoreTaskMethods(Object) - Method in class com.ebay.bascomtask.main.Orchestrator: Adds an object without considering any @Work or @PassThru methods even if they exist, as if the object did not have such methods in the first place.
addPassThru(Object) - Method in class com.ebay.bascomtask.main.Orchestrator: Adds a task whose @PassThru methods (rather than its @@Work methods) will be invoked, always in the calling thread -- no separate thread is created to execute a @PassThru method since it assumed to perform simple actions like providing a default or passing-through its arguments with no or little change.
addWork(Object) - Method in class com.ebay.bascomtask.main.Orchestrator: Adds a task to be made available to other task's task (@Work or @PassThru) methods, and whose own @Work methods will only be invoked (fired) when its task arguments have so fired.
after(Object) - Method in interface com.ebay.bascomtask.main.ITask: The inverse of ITask.before(Object), achieving the same effect while allowing the arguments to be reversed.
asAdded(Object) - Method in class com.ebay.bascomtask.main.Orchestrator: Returns the ITask wrapper for a POJO task that has already been added to this orchestrator

B

BascomConfigFactory - Class in com.ebay.bascomtask.config
BascomConfigFactory() - Constructor for class com.ebay.bascomtask.config.BascomConfigFactory
before(Object) - Method in interface com.ebay.bascomtask.main.ITask: Ensures this task completes before the given task.

C

closureGenerator(ITaskClosureGenerator) - Method in class com.ebay.bascomtask.main.Orchestrator: Sets a closure generator to use for this orchestrator, rather than the default which is retrieved from whichever IBascomConfig is active.
com.ebay.bascomtask.annotations - package com.ebay.bascomtask.annotations
com.ebay.bascomtask.config - package com.ebay.bascomtask.config
com.ebay.bascomtask.exceptions - package com.ebay.bascomtask.exceptions
com.ebay.bascomtask.main - package com.ebay.bascomtask.main
constructThreadId(TaskThreadStat, String, String, int) - Static method in class com.ebay.bascomtask.config.DefaultBascomConfig
create() - Static method in class com.ebay.bascomtask.main.Orchestrator

D

DefaultBascomConfig - Class in com.ebay.bascomtask.config
DefaultBascomConfig() - Constructor for class com.ebay.bascomtask.config.DefaultBascomConfig

E

equals(Object) - Method in class com.ebay.bascomtask.main.Orchestrator.ExecutionStats
execute() - Method in class com.ebay.bascomtask.main.Orchestrator: Calls Orchestrator.execute(long) with a default from current IBascomConfig.getDefaultOrchestratorTimeoutMs()
execute(String) - Method in class com.ebay.bascomtask.main.Orchestrator
execute(long) - Method in class com.ebay.bascomtask.main.Orchestrator
execute(long, String) - Method in class com.ebay.bascomtask.main.Orchestrator: Begins processing of previously added tasks within the calling thread, spawning new threads where possible to exploit parallel execution and returning when all no-wait tasks are finished.
executeTaskMethod() - Method in interface com.ebay.bascomtask.main.ITaskMethodClosure: Invokes the task method.
executeTaskMethod() - Method in class com.ebay.bascomtask.main.TaskMethodClosure: Invokes the actual pojo task method.

F

Foo - Class in com.ebay.bascomtask.main
Foo() - Constructor for class com.ebay.bascomtask.main.Foo
fork() - Method in interface com.ebay.bascomtask.main.ITask: Prevents this task from being run by the calling thread, spawning a new thread if needed.

G

getClosure() - Method in interface com.ebay.bascomtask.config.ITaskClosureGenerator: Provides a closure for invoking task method calls.
getClosure() - Method in class com.ebay.bascomtask.main.TaskMethodClosure: Returns a closure for nested (non-root, i.e.
getConfig() - Static method in class com.ebay.bascomtask.config.BascomConfigFactory
getDefaultOrchestratorTimeoutMs() - Method in class com.ebay.bascomtask.config.DefaultBascomConfig: 30-second default timeout.
getDefaultOrchestratorTimeoutMs() - Method in interface com.ebay.bascomtask.config.IBascomConfig: Returns the default value for orchestrator timeout (when Orchestrator.execute() is called).
getDurationMs() - Method in interface com.ebay.bascomtask.main.ITaskMethodClosure: Returns millisecond duration of executeTaskMethod call, valid even if exception thrown.
getDurationMs() - Method in class com.ebay.bascomtask.main.TaskMethodClosure
getDurationNs() - Method in interface com.ebay.bascomtask.main.ITaskMethodClosure: Returns nanosecond duration of executeTaskMethod call, valid even if exception thrown.
getDurationNs() - Method in class com.ebay.bascomtask.main.TaskMethodClosure
getExceptions() - Method in exception com.ebay.bascomtask.exceptions.RuntimeGraphError.Multi
getExecutionHook(Orchestrator, String) - Method in class com.ebay.bascomtask.config.DefaultBascomConfig
getExecutionHook(Orchestrator, String) - Method in interface com.ebay.bascomtask.config.IBascomConfig: Returns a generator for use within an orchestration execution scope -- i.e.
getExecutionTime() - Method in class com.ebay.bascomtask.main.Orchestrator.ExecutionStats: Returns the time spent during the last call to Orchestrator.execute().
getExecutor() - Method in class com.ebay.bascomtask.config.DefaultBascomConfig
getExecutor() - Method in interface com.ebay.bascomtask.config.IBascomConfig: The pool from which threads are drawn as needed for parallel execution.
getGlobalIndex() - Method in class com.ebay.bascomtask.main.TaskThreadStat: Returns the index of the associated thread within this process.
getGraphState() - Method in class com.ebay.bascomtask.main.Orchestrator: Returns a newline-separated list of all calls of all tasks.
getId() - Method in class com.ebay.bascomtask.main.Orchestrator: Returns an id for this instance which has very low probability of clashing with other ids.
getLocalIndex() - Method in class com.ebay.bascomtask.main.TaskThreadStat: Returns the index of the associated thread within TaskThreadStat.getOrchestrator().
getMethodActualSignature() - Method in interface com.ebay.bascomtask.main.ITaskMethodClosure: Method name with argument values.
getMethodActualSignature() - Method in class com.ebay.bascomtask.main.TaskMethodClosure
getMethodBindings() - Method in interface com.ebay.bascomtask.main.ITaskMethodClosure: Returns the list of POJO arguments to be passed to the task method.
getMethodBindings() - Method in class com.ebay.bascomtask.main.TaskMethodClosure
getMethodFormalSignature() - Method in interface com.ebay.bascomtask.main.ITaskMethodClosure: Method name with argument types.
getMethodFormalSignature() - Method in class com.ebay.bascomtask.main.TaskMethodClosure
getMethodName() - Method in interface com.ebay.bascomtask.main.ITaskMethodClosure: Retrieves the method name.
getMethodName() - Method in class com.ebay.bascomtask.main.TaskMethodClosure
getName() - Method in interface com.ebay.bascomtask.main.ITask: The name of this pojoCalled instance in an orchestrator, guaranteed to always be unique that orchestrator.
getName() - Method in class com.ebay.bascomtask.main.Orchestrator: The name previously set by Orchestrator.name(String)
getNoWaitStats() - Method in class com.ebay.bascomtask.main.Orchestrator: Returns a snapshot of execution statistics resulting from a previous execution, including any nowait tasks.
getNumberOfOpenThreads() - Method in class com.ebay.bascomtask.main.Orchestrator: Returns the number of threads that have been spawned but not yet completed.
getNumberOfTasksExecuted() - Method in class com.ebay.bascomtask.main.Orchestrator.ExecutionStats: Returns the number of task method calls made.
getNumberOfThreadsCreated() - Method in class com.ebay.bascomtask.main.Orchestrator: Returns the number of additional threads (not including the starting thread) used in computing the result from this orchestrator.
getOrchestrator() - Method in interface com.ebay.bascomtask.main.ITask: Returns the orchestrator which created and owns this task.
getOrchestrator() - Method in class com.ebay.bascomtask.main.TaskThreadStat: The creator of this TaskThreadStat
getParallelizationSaving() - Method in class com.ebay.bascomtask.main.Orchestrator.ExecutionStats: Returns the time saved by executing tasks in parallel rather than sequentially.
getRoot() - Method in class com.ebay.bascomtask.main.TaskThreadStat: Returns parent thread which created this thread.
getStats() - Method in class com.ebay.bascomtask.main.Orchestrator: Returns a snapshot of execution statistics resulting from a previous execution, excluding any nowait tasks.
getTargetPojoTask() - Method in interface com.ebay.bascomtask.main.ITaskMethodClosure: Returns the target object.
getTargetPojoTask() - Method in class com.ebay.bascomtask.main.TaskMethodClosure
getTaskName() - Method in interface com.ebay.bascomtask.main.ITaskMethodClosure: Returns the class name of the POJO or its overwritten name(String) value.
getTaskName() - Method in class com.ebay.bascomtask.main.TaskMethodClosure
getThreadNameWidthMax() - Method in class com.ebay.bascomtask.config.DefaultBascomConfig: Indicates the width max for thread names such that when exceeded a '..' string will be provided in place of any more predecessors.
getThreadStatForCurrentThread() - Method in class com.ebay.bascomtask.main.Orchestrator
go(int, boolean) - Method in class com.ebay.bascomtask.main.Foo
go(int) - Method in class com.ebay.bascomtask.main.Foo

H

hashCode() - Method in class com.ebay.bascomtask.main.Orchestrator.ExecutionStats

I

IBascomConfig - Interface in com.ebay.bascomtask.config: BascomTask configuration.
InvalidGraph - Exception in com.ebay.bascomtask.exceptions: Conditions that occur prior to any task being processed.
InvalidGraph(String) - Constructor for exception com.ebay.bascomtask.exceptions.InvalidGraph
InvalidGraph.Circular - Exception in com.ebay.bascomtask.exceptions: A circular reference has been detected in the graph.
InvalidGraph.Circular(String) - Constructor for exception com.ebay.bascomtask.exceptions.InvalidGraph.Circular
InvalidGraph.MissingDependents - Exception in com.ebay.bascomtask.exceptions: A task cannot be executed because it has no call with all paramaters added.
InvalidGraph.MissingDependents(String) - Constructor for exception com.ebay.bascomtask.exceptions.InvalidGraph.MissingDependents
InvalidGraph.MultiMethod - Exception in com.ebay.bascomtask.exceptions: A task has more than one method that can fire.
InvalidGraph.MultiMethod(String) - Constructor for exception com.ebay.bascomtask.exceptions.InvalidGraph.MultiMethod
InvalidGraph.ViolatedProvides - Exception in com.ebay.bascomtask.exceptions: When a promise is made that a task will provide an instance, but that task does not actually add that instance.
InvalidGraph.ViolatedProvides(String) - Constructor for exception com.ebay.bascomtask.exceptions.InvalidGraph.ViolatedProvides
InvalidTask - Exception in com.ebay.bascomtask.exceptions: A task supplied to an archestrator cannot be processed.
InvalidTask(String) - Constructor for exception com.ebay.bascomtask.exceptions.InvalidTask
InvalidTask.AlreadyAdded - Exception in com.ebay.bascomtask.exceptions: Attempts to add the same POJO task more than once are rejected else the results would be ambiguous.
InvalidTask.AlreadyAdded(String) - Constructor for exception com.ebay.bascomtask.exceptions.InvalidTask.AlreadyAdded
InvalidTask.BadParam - Exception in com.ebay.bascomtask.exceptions: Thrown when a task method has a parameter that cannot be processed by the orchestrator.
InvalidTask.BadParam(String) - Constructor for exception com.ebay.bascomtask.exceptions.InvalidTask.BadParam
InvalidTask.BadReturn - Exception in com.ebay.bascomtask.exceptions: Thrown when a task method has a return type that is neither void nor boolean.
InvalidTask.BadReturn(String) - Constructor for exception com.ebay.bascomtask.exceptions.InvalidTask.BadReturn
InvalidTask.NameConflict - Exception in com.ebay.bascomtask.exceptions
InvalidTask.NameConflict(String) - Constructor for exception com.ebay.bascomtask.exceptions.InvalidTask.NameConflict
InvalidTask.NotPublic - Exception in com.ebay.bascomtask.exceptions
InvalidTask.NotPublic(String) - Constructor for exception com.ebay.bascomtask.exceptions.InvalidTask.NotPublic
invokeTaskMethod(ITaskMethodClosure) - Method in interface com.ebay.bascomtask.config.ITaskInterceptor: Called when a task method is ready to be invoked.
isActive() - Method in class com.ebay.bascomtask.main.TaskThreadStat: True iff the associated thread is actively executing a task.
isFork() - Method in interface com.ebay.bascomtask.main.ITask: Should this task not be run in the calling thread?
isMultiMethodOk() - Method in interface com.ebay.bascomtask.main.ITask: Should an exception be thrown when a task has more than one method each of which has all parameters added to the graph?
isWait() - Method in interface com.ebay.bascomtask.main.ITask: Should the orchestrator wait for this task to finish before completing an invocation of the Orchestrator.execute() method?
ITask - Interface in com.ebay.bascomtask.main: Shadow object for POJO tasks added to an orchestrator.
ITaskClosureGenerator - Interface in com.ebay.bascomtask.config
ITaskInterceptor - Interface in com.ebay.bascomtask.config: Interceptor for POJO task method calls.
ITaskMethodClosure - Interface in com.ebay.bascomtask.main: Wraps a call to a POJO task method.

M

main(String[]) - Static method in class com.ebay.bascomtask.main.Foo
multiMethodOk() - Method in interface com.ebay.bascomtask.main.ITask: Indicates that it is ok if the task has more than one method which can fire.

N

name(String) - Method in interface com.ebay.bascomtask.main.ITask: Each task has a name that defaults to its type name followed by a unique integer for that type, unless overridden here.
name(String) - Method in class com.ebay.bascomtask.main.Orchestrator: Sets a name used on entry and exit debugging statements, useful for identify which orchestrator is being invoked when there are many involved.
notifyTerminate() - Method in class com.ebay.bascomtask.config.DefaultBascomConfig
notifyTerminate() - Method in interface com.ebay.bascomtask.config.IBascomConfig: Called on shutdown (when it is possible to do so, typically in a stand-alone program only).
notifyThreadEnd(TaskThreadStat) - Method in class com.ebay.bascomtask.config.DefaultBascomConfig
notifyThreadEnd(TaskThreadStat) - Method in interface com.ebay.bascomtask.config.IBascomConfig: Called after a thread is has finished executing a task and there are no other tasks ready to execute.
notifyThreadStart(TaskThreadStat) - Method in class com.ebay.bascomtask.config.DefaultBascomConfig: Sets the thread name.
notifyThreadStart(TaskThreadStat) - Method in interface com.ebay.bascomtask.config.IBascomConfig: Called after a thread is pulled from the pool and before it starts executing any task.
noWait() - Method in interface com.ebay.bascomtask.main.ITask: Convenience method for setWait(false);

O

Orchestrator - Class in com.ebay.bascomtask.main: A dataflow-driven collector and executor of tasks that implicitly honors all dependencies while pursuing maximum parallelization with a minimum number of threads.
Orchestrator.ExecutionStats - Class in com.ebay.bascomtask.main

P

PassThru - Annotation Type in com.ebay.bascomtask.annotations: Marks a task method that may be executed when a task is added through Orchestrator.addPassThru(Object) rather than Orchestrator.addWork(Object).
prepare() - Method in class com.ebay.bascomtask.main.TaskMethodClosure
prepareTaskMethod() - Method in class com.ebay.bascomtask.main.TaskMethodClosure: Called before TaskMethodClosure.executeTaskMethod().
provides(Class<?>) - Method in interface com.ebay.bascomtask.main.ITask: Indicates that a task will add to the current orchestrator a pojo task instance of the given class.

R

recordException(Call.Instance, Exception) - Method in class com.ebay.bascomtask.main.Orchestrator
recordException(Exception) - Method in class com.ebay.bascomtask.main.Orchestrator
RuntimeGraphError - Exception in com.ebay.bascomtask.exceptions: Generated during Orchestrator execution.
RuntimeGraphError(String) - Constructor for exception com.ebay.bascomtask.exceptions.RuntimeGraphError
RuntimeGraphError(String, Exception) - Constructor for exception com.ebay.bascomtask.exceptions.RuntimeGraphError
RuntimeGraphError.Multi - Exception in com.ebay.bascomtask.exceptions: When multiple errors occur.
RuntimeGraphError.Multi(Exception, List<Exception>) - Constructor for exception com.ebay.bascomtask.exceptions.RuntimeGraphError.Multi
RuntimeGraphError.Stall - Exception in com.ebay.bascomtask.exceptions: An internal error when the main thread is waiting yet there are no other active threads to complete the task(s) being waited on.
RuntimeGraphError.Stall(String) - Constructor for exception com.ebay.bascomtask.exceptions.RuntimeGraphError.Stall
RuntimeGraphError.Timeout - Exception in com.ebay.bascomtask.exceptions
RuntimeGraphError.Timeout(long) - Constructor for exception com.ebay.bascomtask.exceptions.RuntimeGraphError.Timeout

S

Scope - Enum in com.ebay.bascomtask.annotations: Specifies desired behavior when a task is fired more than once.
setConfig(IBascomConfig) - Static method in class com.ebay.bascomtask.config.BascomConfigFactory
setThreadName(TaskThreadStat) - Method in class com.ebay.bascomtask.config.DefaultBascomConfig: Sets the name of given thread like so:
shutdownAndAwaitTermination(ExecutorService) - Static method in class com.ebay.bascomtask.config.DefaultBascomConfig: Standard way to shutdown an executor as defined in ExecutorService shutdown, used by this class and also made public here for convenience.

T

TaskMethodClosure - Class in com.ebay.bascomtask.main: Wraps an invocation of a task method call and its result.
TaskMethodClosure() - Constructor for class com.ebay.bascomtask.main.TaskMethodClosure
TaskThreadStat - Class in com.ebay.bascomtask.main: Wrapper for threads used during orchestrator execution.
TaskThreadStat(Orchestrator, int, int, TaskThreadStat) - Constructor for class com.ebay.bascomtask.main.TaskThreadStat
toString() - Method in class com.ebay.bascomtask.main.Orchestrator.ExecutionStats
toString() - Method in class com.ebay.bascomtask.main.Orchestrator
toString() - Method in class com.ebay.bascomtask.main.TaskMethodClosure

V

valueOf(String) - Static method in enum com.ebay.bascomtask.annotations.Scope: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.ebay.bascomtask.annotations.Scope: Returns an array containing the constants of this enum type, in the order they are declared.

W

wait(boolean) - Method in interface com.ebay.bascomtask.main.ITask: Specifies whether the orchestrator should wait for this instance to finish.
Work - Annotation Type in com.ebay.bascomtask.annotations: Marks a method as a "task method" to be executed when a task is added by calling Orchestrator.addWork(Object) rather than Orchestrator.addPassThru(Object).

A B C D E F G H I M N O P R S T V W