com.github.dm.jrt.runner

Class RunnerDecorator

java.lang.Object

com.github.dm.jrt.runner.RunnerDecorator

All Implemented Interfaces:

Runner

public class RunnerDecorator
extends Object
implements Runner

Implementation of a decorator of a runner object.

Created by davide-maestroni on 09/22/2014.

Constructor Summary

Constructors

Constructor and Description
RunnerDecorator(Runner wrapped) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel(Execution execution) Cancels the specified execution if not already run. Note that the method will have no effect in case the runner does not maintain a queue or the specified execution has been already processed at the moment of the call. Note also that, in case the same execution has been added more than once to the runner queue, when the method returns, the queue will not contain the execution instance anymore, with the consequence that the Runnable.run() method will never be called.
boolean	isExecutionThread() Checks if the calling thread belongs to the ones employed by the runner implementation.
void	run(Execution execution, long delay, TimeUnit timeUnit) Runs the specified execution (that is, it calls the Runnable.run() method inside the runner thread).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RunnerDecorator

public RunnerDecorator(@NotNull
               Runner wrapped)

Constructor.

Parameters:

wrapped - the wrapped instance.

Method Detail

cancel

public void cancel(@NotNull
          Execution execution)

Description copied from interface: Runner

Cancels the specified execution if not already run.
Note that the method will have no effect in case the runner does not maintain a queue or the specified execution has been already processed at the moment of the call.
Note also that, in case the same execution has been added more than once to the runner queue, when the method returns, the queue will not contain the execution instance anymore, with the consequence that the Runnable.run() method will never be called.

The implementation of this method is optional, still, it may greatly increase the performance by avoiding to start invocations which are already aborted. The runner implementation can safely ignore all those executions whose method Execution.mayBeCanceled() returns false.

Specified by:

cancel in interface Runner

Parameters:

execution - the execution.

isExecutionThread

public boolean isExecutionThread()

Description copied from interface: Runner

Checks if the calling thread belongs to the ones employed by the runner implementation.

The implementation of this method is not strictly mandatory, even if, the classes always returning false effectively prevent the correct detection of possible deadlocks.
A synchronous runner implementation will always return true.

Specified by:

isExecutionThread in interface Runner

Returns:

whether the calling thread is managed by the runner.

run

public void run(@NotNull
       Execution execution,
       long delay,
       @NotNull
       TimeUnit timeUnit)

Description copied from interface: Runner

Runs the specified execution (that is, it calls the Runnable.run() method inside the runner thread).

Specified by:

run in interface Runner

Parameters:

execution - the execution.

delay - the execution delay.

timeUnit - the delay time unit.