public interface CancellationPoint extends AutoCloseable, CancelCheck, Cancellable
DO_NOT_CLOSE, DUMMY
Modifier and Type | Method and Description |
---|---|
void |
cancel()
Cancel current point;
|
void |
close()
Closes cancellation point;
|
static CancellationPoint |
forCancelCheck(String description,
CancelCheck check)
Wraps the non-cancellable
CancelCheck as a cancellable CancellationPoint . |
String |
getCancellationMessage()
Returns null if the process has not been cancelled, otherwise the cancellation cause (if set).
|
String |
getProcessDescription()
Returns the description of the process that this cancellation point represents.
|
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;
|
check, isCancelled, throwIfCancelled
cancel
String getProcessDescription()
void cancel()
String getCancellationMessage()
CancelCheck
getCancellationMessage
in interface CancelCheck
void wait(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException
timeout
- - the time;unit
- - the unit;InterruptedException
ExecutionException
TimeoutException
void close()
close
in interface AutoCloseable
static CancellationPoint uncloseable(CancellationPoint cp)
static CancellationPoint forCancelCheck(String description, CancelCheck check)
CancelCheck
as a cancellable CancellationPoint
. This is supposed to be used in those rare cases when
a process can be cancelled externally (i.e. gets a CancelCheck
from the outer code) but also spawns sub-processes which it can cancel
itself. This method makes it easier to ensure that sub-processes get cancelled both from outside of the main process and from inside it.
Note: the returned object does not support waiting
.description
- the process descriptioncheck
- the external cancellation checkCopyright © 2010-2016 Stardog Union. All Rights Reserved.