org.arquillian.spacelift.execution

Interface Execution<RESULT>

Type Parameters:

RESULT - Type of result to be returned from this execution

public interface Execution<RESULT>

Representation of currently running execution that promises to return RESULT somewhen in the future.

Author:

Karel Piwko

Method Summary

Modifier and Type	Method and Description
RESULT	await() Blocks execution of current thread, waiting for the execution to be finished.
RESULT	awaitAtMost(CountDownWatch timeout) Blocks execution of current thread, waiting for the execution to be finished.
RESULT	awaitAtMost(long timeout, TimeUnit unit) Blocks execution of current thread, waiting for the execution to be finished.
boolean	hasFailed() Checks whether execution failed.
boolean	isFinished() Checks whether process has finished
boolean	isMarkedAsFinished() Checks whether process is marked as finished.
Execution<RESULT>	markAsFinished() Marks execution as finished.
Execution<RESULT>	reexecuteEvery(long step, TimeUnit unit) Sets interval for execution reexecution.
Execution<RESULT>	registerShutdownHook() Registers a shutdown hook that is applied in case program is still running when JVM is going to terminate.
Execution<RESULT>	terminate() Immediately terminates execution evaluation.
RESULT	until(CountDownWatch timeout, ExecutionCondition<RESULT> condition) Continues (re)executing the execution until condition is satisfied.
RESULT	until(long timeout, TimeUnit unit, ExecutionCondition<RESULT> condition) Continues (re)executing the execution until condition is satisfied.

Method Detail

markAsFinished

Execution<RESULT> markAsFinished()

Marks execution as finished. This means that we have discovered that it did the work we expected.

registerShutdownHook

Execution<RESULT> registerShutdownHook()

Registers a shutdown hook that is applied in case program is still running when JVM is going to terminate.

isMarkedAsFinished

boolean isMarkedAsFinished()

Checks whether process is marked as finished.

Returns:

true if execution is marked as finished, false otherwise

isFinished

boolean isFinished()

Checks whether process has finished

Returns:

true if execution has finished, false otherwise

hasFailed

boolean hasFailed()
           throws IllegalStateException

Checks whether execution failed.

Returns:

true if execution has failed, false otherwise

Throws:

IllegalStateException - If execution status could not yet be determined

terminate

Execution<RESULT> terminate()
                     throws ExecutionException

Immediately terminates execution evaluation.

Returns:

immediate execution evaluation

Throws:

ExecutionException

await

RESULT await()
      throws ExecutionException

Blocks execution of current thread, waiting for the execution to be finished.

Returns:

result of execution

Throws:

ExecutionException

awaitAtMost

RESULT awaitAtMost(long timeout,
                   TimeUnit unit)
            throws ExecutionException,
                   TimeoutExecutionException

Blocks execution of current thread, waiting for the execution to be finished.

Parameters:

timeout - the timeout

unit - timeout unit

Returns:

Result of execution

Throws:

ExecutionException - If execution failed

TimeoutExecutionException - If execution was not retrieved during the timeout

awaitAtMost

RESULT awaitAtMost(CountDownWatch timeout)
            throws ExecutionException,
                   TimeoutExecutionException

Blocks execution of current thread, waiting for the execution to be finished.

Parameters:

timeout - the timeout

Returns:

Result of execution

Throws:

ExecutionException - If execution failed

TimeoutExecutionException - If execution was not retrieved during the timeout

reexecuteEvery

Execution<RESULT> reexecuteEvery(long step,
                                 TimeUnit unit)

Sets interval for execution reexecution.

Parameters:

step - the time delay

unit - time unit

Returns:

this execution with reexecution interval set

until

RESULT until(long timeout,
             TimeUnit unit,
             ExecutionCondition<RESULT> condition)
      throws ExecutionException,
             TimeoutExecutionException

Continues (re)executing the execution until condition is satisfied. This call can be used to poll regularly for an external process status.

Parameters:

timeout - the timeout

condition - condition that determines whether reexecution should continue

Throws:

ExecutionException

TimeoutExecutionException

until

RESULT until(CountDownWatch timeout,
             ExecutionCondition<RESULT> condition)
      throws ExecutionException,
             TimeoutExecutionException

Continues (re)executing the execution until condition is satisfied. This call can be used to poll regularly for an external process status.

Parameters:

timeout - the timeout

condition - condition that determines whether reexecution should continue

Throws:

ExecutionException

TimeoutExecutionException