com.bigdata.util.concurrent

Interface IHaltable<V>

Type Parameters:

V - The generic type of the computation to which the Future evaluates.

All Superinterfaces:

Future<V>

All Known Subinterfaces:

IRunningQuery

All Known Implementing Classes:

AbstractRunningQuery, ChunkedRunningQuery, FederatedRunningQuery, Haltable, MockRunningQuery

public interface IHaltable<V>
extends Future<V>

Interface extends Future and provides an interface for managing the termination of a process from within that process.

Method Summary

Methods

Modifier and Type	Method and Description
Throwable	getAsThrownCause() Return the first cause regardless of whether it is indicative of normal termination and null iff no cause has been set.
Throwable	getCause() Return the first Throwable which caused this process to halt, but only for abnormal termination.
<T extends Throwable> T	halt(T cause) Halt (exception thrown).
void	halt(V v) Halt (normal termination).

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Method Detail

halt

void halt(V v)

Halt (normal termination).

halt

<T extends Throwable> T halt(T cause)

Halt (exception thrown). The caller is responsible for throwing their given cause out of their own context. As a convenience, this method returns the given cause.

Parameters:

cause - The cause (required).

Returns:

The argument.

getCause

Throwable getCause()

Return the first Throwable which caused this process to halt, but only for abnormal termination.

IHaltable considers exceptions triggered by an interrupt to be normal termination of the process and will return null for such exceptions.

Returns:

The first Throwable which caused this process to halt and null if the process has not halted or if it halted through normal termination.

getAsThrownCause

Throwable getAsThrownCause()

Return the first cause regardless of whether it is indicative of normal termination and null iff no cause has been set.