com.complexible.common.cancellation

Interface CancellationPoint

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DefaultCancellationPoint, DelegatingCancellationPoint, DummyCancellationPoint

public interface CancellationPoint
extends AutoCloseable

Interface for cancellation points; We create cancellation point in one place and have a contract that we don't dispose system or don't drop database while the point is active and actual;

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel current point;
void	cancel(String theCause) Cancel current point;
void	check() Check if cancellation point is valid; It throws an exception in case if the cancellation point has been canceled.
void	close() Closes cancellation point;
String	getCancellationMessage()
String	getProcessDescription() Returns the description of the process that this cancellation point represents.
boolean	isCancelled()
static CancellationPoint	uncloseable(CancellationPoint cp) Returns a cancellation point which can be checked but cannot be closed.
void	wait(long timeout, TimeUnit unit) Waits for specified timeout while the process acquired Cancellation point has been finished;

Method Detail

getProcessDescription

String getProcessDescription()

Returns the description of the process that this cancellation point represents.

Returns:

the process description.

check

void check()

Check if cancellation point is valid; It throws an exception in case if the cancellation point has been canceled.

isCancelled

boolean isCancelled()

Returns:

true if point has been cancelled, false otherwise;

cancel

void cancel()

Cancel current point;

cancel

void cancel(String theCause)

Cancel current point;

Parameters:

theCause - - the message which will be used while cancellation exception will be thrown;

getCancellationMessage

String getCancellationMessage()

Returns:

cancellation message used for cancel;

wait

void wait(long timeout,
          TimeUnit unit)
   throws InterruptedException,
          ExecutionException,
          TimeoutException

Waits for specified timeout while the process acquired Cancellation point has been finished;

Parameters:

timeout - - the time;

unit - - the unit;

Throws:

InterruptedException

ExecutionException

TimeoutException

close

void close()

Closes cancellation point;

Specified by:

close in interface AutoCloseable

uncloseable

static CancellationPoint uncloseable(CancellationPoint cp)

Returns a cancellation point which can be checked but cannot be closed. Useful for passing a cancellation point into processes which don't own it and are not supposed to close it.