com.linkedin.parseq

Interface Cancellable

All Known Subinterfaces:

ParTask<T>, Task<T>, Tuple2Task<T1,T2>, Tuple3Task<T1,T2,T3>, Tuple4Task<T1,T2,T3,T4>, Tuple5Task<T1,T2,T3,T4,T5>, Tuple6Task<T1,T2,T3,T4,T5,T6>, Tuple7Task<T1,T2,T3,T4,T5,T6,T7>, Tuple8Task<T1,T2,T3,T4,T5,T6,T7,T8>, Tuple9Task<T1,T2,T3,T4,T5,T6,T7,T8,T9>

All Known Implementing Classes:

ActionTask, AsyncCallableTask, BaseTask, CallableTask, Par2Task, Par3Task, Par4Task, Par5Task, Par6Task, Par7Task, Par8Task, Par9Task, Tuple2TaskDelegate, Tuple3TaskDelegate, Tuple4TaskDelegate, Tuple5TaskDelegate, Tuple6TaskDelegate, Tuple7TaskDelegate, Tuple8TaskDelegate, Tuple9TaskDelegate

public interface Cancellable

An object that can be cancelled with a reason.

Author:

Chris Pettitt (cpettitt@linkedin.com)

Method Summary

Modifier and Type	Method and Description
boolean	cancel(java.lang.Exception reason) Attempts to cancel the object with the given reason.

Method Detail

cancel

boolean cancel(java.lang.Exception reason)

Attempts to cancel the object with the given reason. Check the return value to determine if cancellation was successful. Subsequent calls to cancel will always return false.

Parameters:

reason - an Exception indicating why this object was cancelled

Returns:

true iff the object was successfully cancelled as a result of this invocation.