com.github.dexecutor.core

Class DefaultExecutionEngine<T,R>

java.lang.Object

com.github.dexecutor.core.DefaultExecutionEngine<T,R>

Type Parameters:

T - Type of Node/Task ID

R - Type of Node/Task result

All Implemented Interfaces:

ExecutionEngine<T,R>

public final class DefaultExecutionEngine<T,R>
extends Object
implements ExecutionEngine<T,R>

Default Executor, which internally operates on @ExecutorService

Author:

Nadeem Mohammad

Constructor Summary

Constructors

Constructor and Description
DefaultExecutionEngine(DexecutorState<T,R> state, ExecutorService executorService)
DefaultExecutionEngine(DexecutorState<T,R> state, ExecutorService executorService, ExecutionListener<T,R> listener) Creates the default instance given @ExecutorService, internally it uses @CompletionService

Method Summary

Modifier and Type	Method and Description
boolean	isAnyTaskInError()
boolean	isDistributed() Hints dexecutor if the execution engine is distributed or not
ExecutionResult<T,R>	processResult() This method is expected to block, if there are no execution result, otherwise return the result immediately.
void	setExecutionListener(ExecutionListener<T,R> listener) Sets the ExecutionListener
void	submit(Task<T,R> task) Submits the task for execution, the method is expected to return immediately.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultExecutionEngine

public DefaultExecutionEngine(DexecutorState<T,R> state,
                              ExecutorService executorService)

DefaultExecutionEngine

public DefaultExecutionEngine(DexecutorState<T,R> state,
                              ExecutorService executorService,
                              ExecutionListener<T,R> listener)

Creates the default instance given @ExecutorService, internally it uses @CompletionService

Parameters:

state - the state

executorService - Underlying execution service, where in tasks would be scheduled.

listener - to notify

Method Detail

processResult

public ExecutionResult<T,R> processResult()

Description copied from interface: ExecutionEngine

This method is expected to block, if there are no execution result, otherwise return the result immediately.

Specified by:

processResult in interface ExecutionEngine<T,R>

Returns:

returns the execution result. *

submit

public void submit(Task<T,R> task)

Description copied from interface: ExecutionEngine

Submits the task for execution, the method is expected to return immediately.

Specified by:

submit in interface ExecutionEngine<T,R>

Parameters:

task - to be submitted for execution

isDistributed

public boolean isDistributed()

Description copied from interface: ExecutionEngine

Hints dexecutor if the execution engine is distributed or not

Specified by:

isDistributed in interface ExecutionEngine<T,R>

Returns:

true If this execution engine is a distributed false it it is non distributed

isAnyTaskInError

public boolean isAnyTaskInError()

Specified by:

isAnyTaskInError in interface ExecutionEngine<T,R>

Returns:

true if there are any task errors identified till that instance of time false otherwise.

toString

public String toString()

Overrides:

toString in class Object

setExecutionListener

public void setExecutionListener(ExecutionListener<T,R> listener)

Description copied from interface: ExecutionEngine

Sets the ExecutionListener

Specified by:

setExecutionListener in interface ExecutionEngine<T,R>

Parameters:

listener - to notify