Index (Dependent Tasks Executor Core 1.1.2 API)

A B C D E G H I L M N P S T V

A

add(ExecutionResult<T, R>) - Method in class com.github.dexecutor.core.task.ExecutionResults: adds result to existing collection of results
addAsDependencyToAllInitialNodes(T) - Method in class com.github.dexecutor.core.DefaultDexecutor
addAsDependencyToAllInitialNodes(T) - Method in class com.github.dexecutor.core.DefaultDexecutorState
addAsDependencyToAllInitialNodes(T) - Method in interface com.github.dexecutor.core.Dexecutor: Adds the node as dependency to all initial nodes (at the time of adding), meaning this given node would be evaluated first and then all initial nodes would run in parallel
addAsDependencyToAllInitialNodes(T) - Method in interface com.github.dexecutor.core.DexecutorState: Adds the node as dependency to all initial nodes (at the time of adding), meaning this given node would be evaluated first and then all initial nodes would run in parallel
addAsDependentOnAllLeafNodes(T) - Method in class com.github.dexecutor.core.DefaultDexecutor
addAsDependentOnAllLeafNodes(T) - Method in class com.github.dexecutor.core.DefaultDexecutorState
addAsDependentOnAllLeafNodes(T) - Method in interface com.github.dexecutor.core.Dexecutor: Adds the node as dependent on all leaf nodes (at the time of adding), meaning all leaf nodes would be evaluated first and then the given node
addAsDependentOnAllLeafNodes(T) - Method in interface com.github.dexecutor.core.DexecutorState: Adds the node as dependent on all leaf nodes (at the time of adding), meaning all leaf nodes would be evaluated first and then the given node
addDependency(T, T) - Method in class com.github.dexecutor.core.DefaultDexecutor
addDependency(T, T) - Method in class com.github.dexecutor.core.DefaultDexecutorState
addDependency(T, T) - Method in interface com.github.dexecutor.core.Dexecutor: Add Two dependent nodes into the graph, creating the nodes if not already present
addDependency(T, T) - Method in interface com.github.dexecutor.core.DexecutorState: Add Two dependent nodes into the graph, creating the nodes if not already present
addDependency(T, T) - Method in interface com.github.dexecutor.core.graph.Dag: Should add the two nodes in the datastructure in such a way that evalFirstValue should be evaluated before evalAfterValue.
addDependency(T, T) - Method in class com.github.dexecutor.core.graph.DefaultDag
addInComingNode(Node<T, R>) - Method in class com.github.dexecutor.core.graph.Node: Add the given node, to the set of incoming nodes
addIndependent(T) - Method in class com.github.dexecutor.core.DefaultDexecutor
addIndependent(T) - Method in class com.github.dexecutor.core.DefaultDexecutorState
addIndependent(T) - Method in interface com.github.dexecutor.core.Dexecutor: Add a node as independent, it does not require any dependent node
addIndependent(T) - Method in interface com.github.dexecutor.core.DexecutorState: Add a node as independent, it does not require any dependent node
addIndependent(T) - Method in interface com.github.dexecutor.core.graph.Dag: Adds the given node to the datastructure whith out any dependency Nodes should be created only if it is not already added.
addIndependent(T) - Method in class com.github.dexecutor.core.graph.DefaultDag
addOutGoingNode(Node<T, R>) - Method in class com.github.dexecutor.core.graph.Node: add the given to the set of out going nodes
allNodes() - Method in interface com.github.dexecutor.core.graph.Dag: Returns all nodes in this graph
allNodes() - Method in class com.github.dexecutor.core.graph.DefaultDag
anyParentSkipped() - Method in class com.github.dexecutor.core.task.ExecutionResults

B

BaseTraversar<T extends Comparable<T>,R> - Class in com.github.dexecutor.core.graph
BaseTraversar() - Constructor for class com.github.dexecutor.core.graph.BaseTraversar

C

checkArgument(boolean, String) - Static method in class com.github.dexecutor.core.support.Preconditions: Ensures the truth of an expression involving one or more parameters to the calling method.
checkNotNull(T, String) - Static method in class com.github.dexecutor.core.support.Preconditions: Checks if the reference is null, and if that is the case throws IllegalArgumentException
com.github.dexecutor.core - package com.github.dexecutor.core
com.github.dexecutor.core.graph - package com.github.dexecutor.core.graph
com.github.dexecutor.core.support - package com.github.dexecutor.core.support
com.github.dexecutor.core.task - package com.github.dexecutor.core.task
CyclicValidator<T extends Comparable<T>,R> - Class in com.github.dexecutor.core.graph: A Validator which does cyclic checks
CyclicValidator() - Constructor for class com.github.dexecutor.core.graph.CyclicValidator

D

Dag<T extends Comparable<T>,R> - Interface in com.github.dexecutor.core.graph: Dependency would be constructed based on this APIs, Dexecutor uses this data structure to represent the dependencies between tasks
decrementUnProcessedNodesCount() - Method in class com.github.dexecutor.core.DefaultDexecutorState
decrementUnProcessedNodesCount() - Method in interface com.github.dexecutor.core.DexecutorState: decrements the count of total number of unprocessed nodes
DefaultDag<T extends Comparable<T>,R> - Class in com.github.dexecutor.core.graph: Default implementation of Graph
DefaultDag() - Constructor for class com.github.dexecutor.core.graph.DefaultDag
DefaultDexecutor<T extends Comparable<T>,R> - Class in com.github.dexecutor.core: Default implementation of @Dexecutor
DefaultDexecutor(ExecutionEngine<T, R>, TaskProvider<T, R>) - Constructor for class com.github.dexecutor.core.DefaultDexecutor
DefaultDexecutor(DexecutorConfig<T, R>) - Constructor for class com.github.dexecutor.core.DefaultDexecutor: Creates the Executor with Config
DefaultDexecutorState<T extends Comparable<T>,R> - Class in com.github.dexecutor.core
DefaultDexecutorState() - Constructor for class com.github.dexecutor.core.DefaultDexecutorState
DefaultExecutionEngine<T extends Comparable<T>,R> - Class in com.github.dexecutor.core: Default Executor, which internally operates on @ExecutorService
DefaultExecutionEngine(ExecutorService) - Constructor for class com.github.dexecutor.core.DefaultExecutionEngine: Creates the default instance given @ExecutorService, internally it uses @CompletionService
Dexecutor<T extends Comparable<T>> - Interface in com.github.dexecutor.core: Main Interface for Dexecutor framework, It provides api to build the graph and and to kick off the execution.
DexecutorConfig<T extends Comparable<T>,R> - Class in com.github.dexecutor.core: Configuration Object for Dexecutor framework.
DexecutorConfig(ExecutorService, TaskProvider<T, R>) - Constructor for class com.github.dexecutor.core.DexecutorConfig: Construct the object with mandatory params, rest are optional
DexecutorConfig(ExecutionEngine<T, R>, TaskProvider<T, R>) - Constructor for class com.github.dexecutor.core.DexecutorConfig: Construct the object with mandatory params, rest are optional
DexecutorState<T extends Comparable<T>,R> - Interface in com.github.dexecutor.core: Represents Dexecutor state at any given moment of time, It basically tracks Phase : Current Phase Dexecutor is in Graph : Exposes API around building graph unprocessed nodes count : How many nodes are waiting to be processed processed nodes : Nodes which are processed till that point Discontinued nodes : Nodes for which processing should continue after system comes to valid state
Duration - Class in com.github.dexecutor.core
Duration(long, TimeUnit) - Constructor for class com.github.dexecutor.core.Duration

E

equals(Object) - Method in class com.github.dexecutor.core.graph.Node
errored() - Method in class com.github.dexecutor.core.task.ExecutionResult: Marks the execution result as errored
execute(ExecutionConfig) - Method in class com.github.dexecutor.core.DefaultDexecutor
execute(ExecutionConfig) - Method in interface com.github.dexecutor.core.Dexecutor: Kicks off the execution of the nodes based on the dependency graph constructed, using addDepen*** apis
execute() - Method in class com.github.dexecutor.core.task.Task: Framework would call this method, when it comes for tasks to be executed.
ExecutionBehavior - Enum in com.github.dexecutor.core: Defines the execution behavior of the tasks TERMINATING : Whole tasks execution would come to an end after the execution is thrown NON_TERMINATING : Tasks execution wont come to halt after an exception is thrown out of task RETRY_ONCE_TERMINATING : A retry would be attempted after an exception is thrown, and then if the execption is thrown again, the tasks execution would stop
ExecutionConfig - Class in com.github.dexecutor.core
ExecutionConfig() - Constructor for class com.github.dexecutor.core.ExecutionConfig
ExecutionEngine<T extends Comparable<T>,R> - Interface in com.github.dexecutor.core: An Executor is the main execution engine, where in all the tasks are executed
ExecutionResult<T,R> - Class in com.github.dexecutor.core.task: Holds execution result of a node identified by id
ExecutionResult(T) - Constructor for class com.github.dexecutor.core.task.ExecutionResult
ExecutionResult(T, R) - Constructor for class com.github.dexecutor.core.task.ExecutionResult
ExecutionResult(T, R, ExecutionStatus) - Constructor for class com.github.dexecutor.core.task.ExecutionResult
ExecutionResults<T,R> - Class in com.github.dexecutor.core.task: Wrapper class around @ExecutionResult
ExecutionResults() - Constructor for class com.github.dexecutor.core.task.ExecutionResults
ExecutionStatus - Enum in com.github.dexecutor.core.task: Represents Tasks Execution status ERRORED : Task Execution was in error SKIPPED : Task Execution was skipped SUCCESS : Task Execution was successful

G

get(T) - Method in interface com.github.dexecutor.core.graph.Dag: Returns the node with the given id
get(T) - Method in class com.github.dexecutor.core.graph.DefaultDag
getAll() - Method in class com.github.dexecutor.core.task.ExecutionResults
getCurrentPhase() - Method in class com.github.dexecutor.core.DefaultDexecutorState
getCurrentPhase() - Method in interface com.github.dexecutor.core.DexecutorState
getData() - Method in class com.github.dexecutor.core.graph.Node
getDexecutorState() - Method in class com.github.dexecutor.core.DexecutorConfig
getDiscontinuedNodes() - Method in class com.github.dexecutor.core.DefaultDexecutorState
getDiscontinuedNodes() - Method in interface com.github.dexecutor.core.DexecutorState
getDuration() - Method in class com.github.dexecutor.core.Duration
getExecutionBehavior() - Method in class com.github.dexecutor.core.ExecutionConfig
getFirst() - Method in class com.github.dexecutor.core.task.ExecutionResults
getGraphNode(T) - Method in class com.github.dexecutor.core.DefaultDexecutorState
getGraphNode(T) - Method in interface com.github.dexecutor.core.DexecutorState: Returns the node with the given id
getId() - Method in class com.github.dexecutor.core.task.ExecutionResult
getId() - Method in class com.github.dexecutor.core.task.Task
getImmediateRetryPoolThreadsCount() - Method in class com.github.dexecutor.core.DexecutorConfig
getInComingNodes() - Method in class com.github.dexecutor.core.graph.Node
getInitialNodes() - Method in class com.github.dexecutor.core.DefaultDexecutorState
getInitialNodes() - Method in interface com.github.dexecutor.core.DexecutorState: Returns the Set of nodes for which there is no incoming dependencies.
getInitialNodes() - Method in interface com.github.dexecutor.core.graph.Dag: Returns the Set of nodes for which there is no incoming dependencies.
getInitialNodes() - Method in class com.github.dexecutor.core.graph.DefaultDag
getLeafNodes() - Method in interface com.github.dexecutor.core.graph.Dag: Retruns the set of nodes for which there is no outgoing dependencies.
getLeafNodes() - Method in class com.github.dexecutor.core.graph.DefaultDag
getOutGoingNodes() - Method in class com.github.dexecutor.core.graph.Node
getProcessedNodes() - Method in class com.github.dexecutor.core.DefaultDexecutorState
getProcessedNodes() - Method in interface com.github.dexecutor.core.DexecutorState
getResult() - Method in class com.github.dexecutor.core.graph.Node
getResult() - Method in class com.github.dexecutor.core.task.ExecutionResult
getRetryCount() - Method in class com.github.dexecutor.core.ExecutionConfig
getRetryDelay() - Method in class com.github.dexecutor.core.ExecutionConfig
getScheduledRetryPoolThreadsCount() - Method in class com.github.dexecutor.core.DexecutorConfig
getStatus() - Method in class com.github.dexecutor.core.task.ExecutionResult
getTimeUnit() - Method in class com.github.dexecutor.core.Duration
getUnProcessedNodesCount() - Method in class com.github.dexecutor.core.DefaultDexecutorState
getUnProcessedNodesCount() - Method in interface com.github.dexecutor.core.DexecutorState
getValue() - Method in class com.github.dexecutor.core.graph.Node
graphSize() - Method in class com.github.dexecutor.core.DefaultDexecutorState
graphSize() - Method in interface com.github.dexecutor.core.DexecutorState: Returns the total number of nodes in this graph

H

hasAnyParentResult() - Method in class com.github.dexecutor.core.task.ExecutionResults
hashCode() - Method in class com.github.dexecutor.core.graph.Node

I

immediateRetrying(int) - Method in class com.github.dexecutor.core.ExecutionConfig
incrementUnProcessedNodesCount() - Method in class com.github.dexecutor.core.DefaultDexecutorState
incrementUnProcessedNodesCount() - Method in interface com.github.dexecutor.core.DexecutorState: increments the count of total number of unprocessed nodes
initState() - Method in class com.github.dexecutor.core.DefaultDexecutorState
initState() - Method in interface com.github.dexecutor.core.DexecutorState: Initialize the Dexecutor state, either to new or existing state
ioIntesivePoolSize() - Static method in class com.github.dexecutor.core.support.ThreadPoolUtil: Each tasks blocks 90% of the time, and works only 10% of its lifetime.
isAnyTaskInError() - Method in class com.github.dexecutor.core.DefaultExecutionEngine
isAnyTaskInError() - Method in interface com.github.dexecutor.core.ExecutionEngine
isDiscontinuedNodesNotEmpty() - Method in class com.github.dexecutor.core.DefaultDexecutorState
isDiscontinuedNodesNotEmpty() - Method in interface com.github.dexecutor.core.DexecutorState
isDistributed() - Method in class com.github.dexecutor.core.DefaultExecutionEngine
isDistributed() - Method in interface com.github.dexecutor.core.ExecutionEngine: Hints dexecutor if the execution engine is distributed or not
isErrored() - Method in class com.github.dexecutor.core.graph.Node
isErrored() - Method in class com.github.dexecutor.core.task.ExecutionResult
isImmediatelyRetrying() - Method in class com.github.dexecutor.core.ExecutionConfig
isNonTerminating() - Method in class com.github.dexecutor.core.ExecutionConfig
isScheduledRetrying() - Method in class com.github.dexecutor.core.ExecutionConfig
isSkipped() - Method in class com.github.dexecutor.core.graph.Node
isSkipped() - Method in class com.github.dexecutor.core.task.ExecutionResult
isSuccess() - Method in class com.github.dexecutor.core.graph.Node
isSuccess() - Method in class com.github.dexecutor.core.task.ExecutionResult
isTerminating() - Method in class com.github.dexecutor.core.ExecutionConfig

L

LevelOrderTraversar<T extends Comparable<T>,R> - Class in com.github.dexecutor.core.graph: A Traversar which does level order traversal of the given graph
LevelOrderTraversar() - Constructor for class com.github.dexecutor.core.graph.LevelOrderTraversar

M

markDiscontinuedNodesProcessed() - Method in class com.github.dexecutor.core.DefaultDexecutorState
markDiscontinuedNodesProcessed() - Method in interface com.github.dexecutor.core.DexecutorState: clear (or marks) all the discontinued nodes till this point as processed
markProcessingDone(Node<T, R>) - Method in class com.github.dexecutor.core.DefaultDexecutorState
markProcessingDone(Node<T, R>) - Method in interface com.github.dexecutor.core.DexecutorState: Mark the node as processed.
MergedLevelOrderTraversar<T extends Comparable<T>,R> - Class in com.github.dexecutor.core.graph: A Traversar which does level order traversal of the given graph and merges each level
MergedLevelOrderTraversar() - Constructor for class com.github.dexecutor.core.graph.MergedLevelOrderTraversar
MINIMAL_DURATION - Static variable in class com.github.dexecutor.core.Duration

N

newWorker(Task<T, R>) - Static method in class com.github.dexecutor.core.task.TaskFactory
Node<T,R> - Class in com.github.dexecutor.core.graph: A node representation in this graph, every node may have set of incoming edges and outgoing edges, a node is represented by unique value
Node(T) - Constructor for class com.github.dexecutor.core.graph.Node: Constructs the node with the given node Id
NON_TERMINATING - Static variable in class com.github.dexecutor.core.ExecutionConfig
nonTerminating() - Method in class com.github.dexecutor.core.ExecutionConfig

P

Phase - Enum in com.github.dexecutor.core
poolSize(double) - Static method in class com.github.dexecutor.core.support.ThreadPoolUtil: Number of threads = Number of Available Cores / (1 - Blocking Coefficient) where the blocking coefficient is between 0 and 1.
Preconditions - Class in com.github.dexecutor.core.support: Support class to check for preconditions
print(Writer) - Method in class com.github.dexecutor.core.DefaultDexecutor
print(Traversar<T, R>, Writer) - Method in class com.github.dexecutor.core.DefaultDexecutorState
print(Writer) - Method in interface com.github.dexecutor.core.Dexecutor: Prints the graph into the writer
print(Traversar<T, R>, Writer) - Method in interface com.github.dexecutor.core.DexecutorState: Prints the graph into the writer using the Traversar
printGraph(List<List<Node<T, R>>>, Writer) - Method in class com.github.dexecutor.core.graph.BaseTraversar
processAfterNoError(Collection<Node<T, R>>) - Method in class com.github.dexecutor.core.DefaultDexecutorState
processAfterNoError(Collection<Node<T, R>>) - Method in interface com.github.dexecutor.core.DexecutorState: Add to existing collection of discontinued nodes to be processed later, if system come to valid state.
processResult() - Method in class com.github.dexecutor.core.DefaultExecutionEngine
processResult() - Method in interface com.github.dexecutor.core.ExecutionEngine: This method is expected to block, if there are no execution result, otherwise return the result immediately.
provideTask(T) - Method in interface com.github.dexecutor.core.task.TaskProvider: Given the node id, returns the task to be executed, while building graph only the node ids are required, when it comes to execution Task objects would be constructed

S

scheduledRetrying(int, Duration) - Method in class com.github.dexecutor.core.ExecutionConfig
setConsiderExecutionError(boolean) - Method in class com.github.dexecutor.core.task.Task: sets whether execution errors should be considered or not?
setCurrentPhase(Phase) - Method in class com.github.dexecutor.core.DefaultDexecutorState
setCurrentPhase(Phase) - Method in interface com.github.dexecutor.core.DexecutorState: sets the phase to that of provided
setData(Object) - Method in class com.github.dexecutor.core.graph.Node: Sets the node's data to a new value
setDexecutorState(DexecutorState<T, R>) - Method in class com.github.dexecutor.core.DexecutorConfig
setErrored() - Method in class com.github.dexecutor.core.graph.Node: Sets the node's execution result to ERRORED
setId(T) - Method in class com.github.dexecutor.core.task.Task: Sets the new id
setImmediateRetryPoolThreadsCount(int) - Method in class com.github.dexecutor.core.DexecutorConfig: sets the immediate retry thread pool size to that of specified
setResult(R) - Method in class com.github.dexecutor.core.graph.Node: sets the node's execution result to a new value
setScheduledRetryPoolThreadsCount(int) - Method in class com.github.dexecutor.core.DexecutorConfig: sets the scheduled thread pool size to that of specified
setSkipped() - Method in class com.github.dexecutor.core.graph.Node: Sets the node's execution result to SKIPPED
setSuccess() - Method in class com.github.dexecutor.core.graph.Node: Sets the node's execution result to SUCCESS
setTraversar(Traversar<T, R>) - Method in class com.github.dexecutor.core.DexecutorConfig: Change the traversar to that of specified
setValidator(Validator<T, R>) - Method in class com.github.dexecutor.core.DexecutorConfig: change the validator to that of specified
shouldConsiderExecutionError() - Method in class com.github.dexecutor.core.task.Task
shouldExecute(ExecutionResults<T, R>) - Method in class com.github.dexecutor.core.task.Task: Defines whether or not this task should be executed
shouldProcess(Node<T, R>) - Method in class com.github.dexecutor.core.DefaultDexecutorState
shouldProcess(Node<T, R>) - Method in interface com.github.dexecutor.core.DexecutorState
shouldRetry(int) - Method in class com.github.dexecutor.core.ExecutionConfig
size() - Method in interface com.github.dexecutor.core.graph.Dag: Returns the total number of nodes in this graph
size() - Method in class com.github.dexecutor.core.graph.DefaultDag
skipped() - Method in class com.github.dexecutor.core.task.ExecutionResult: Marks the execution result as skipped
submit(Task<T, R>) - Method in class com.github.dexecutor.core.DefaultExecutionEngine
submit(Task<T, R>) - Method in interface com.github.dexecutor.core.ExecutionEngine: Submits the task for execution, the method is expected to return immediately.

T

Task<T extends Comparable<T>,R> - Class in com.github.dexecutor.core.task: Represent a unit of execution in Dexecutor framework
Task() - Constructor for class com.github.dexecutor.core.task.Task
TaskExecutionException - Exception in com.github.dexecutor.core.task: Tasks can throw this exception to report any issues encountered during task execution
TaskExecutionException(String) - Constructor for exception com.github.dexecutor.core.task.TaskExecutionException: Create a new TaskExecutionException.
TaskExecutionException(String, Throwable) - Constructor for exception com.github.dexecutor.core.task.TaskExecutionException: Create a new TaskExecutionException.
TaskFactory - Class in com.github.dexecutor.core.task: A factory to create Worker task for dexecutor based on @ExecutionBehavior
TaskFactory() - Constructor for class com.github.dexecutor.core.task.TaskFactory
TaskProvider<T extends Comparable<T>,R> - Interface in com.github.dexecutor.core.task: A Task Provider provides Tasks to be executed, when it comes to execution
TERMINATING - Static variable in class com.github.dexecutor.core.ExecutionConfig
terminating() - Method in class com.github.dexecutor.core.ExecutionConfig
ThreadPoolUtil - Class in com.github.dexecutor.core.support: Support class for thread pool size
toString() - Method in class com.github.dexecutor.core.DefaultExecutionEngine
toString() - Method in class com.github.dexecutor.core.graph.Node
toString() - Method in class com.github.dexecutor.core.task.ExecutionResult
toString() - Method in class com.github.dexecutor.core.task.ExecutionResults
Traversar<T extends Comparable<T>,R> - Interface in com.github.dexecutor.core.graph: Provides an API to Traverse a given graph
traverse(Dag<T, R>, Writer) - Method in class com.github.dexecutor.core.graph.LevelOrderTraversar
traverse(Dag<T, R>, Writer) - Method in class com.github.dexecutor.core.graph.MergedLevelOrderTraversar
traverse(Dag<T, R>, Writer) - Method in interface com.github.dexecutor.core.graph.Traversar: Traverse the given graph and print it on the Writer
traverseLevelOrder(Dag<T, R>) - Method in class com.github.dexecutor.core.graph.BaseTraversar

V

validate(Validator<T, R>) - Method in class com.github.dexecutor.core.DefaultDexecutorState
validate(Validator<T, R>) - Method in interface com.github.dexecutor.core.DexecutorState: validates the graph using the validator
validate() - Method in class com.github.dexecutor.core.ExecutionConfig: Does basic validation to make sure object is valid
validate(Dag<T, R>) - Method in class com.github.dexecutor.core.graph.CyclicValidator
validate(Dag<T, R>) - Method in interface com.github.dexecutor.core.graph.Validator: Called to figure out if a graph is valid or not, exception should be thrown if the graph is invalid
Validator<T extends Comparable<T>,R> - Interface in com.github.dexecutor.core.graph: This interface provides API to validate the graph before tasks execution
valueOf(String) - Static method in enum com.github.dexecutor.core.ExecutionBehavior: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.github.dexecutor.core.Phase: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.github.dexecutor.core.task.ExecutionStatus: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.github.dexecutor.core.ExecutionBehavior: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.github.dexecutor.core.Phase: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.github.dexecutor.core.task.ExecutionStatus: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E G H I L M N P S T V