public final class DummyCancellationPoint extends Object implements CancellationPoint
DO_NOT_CLOSE, DUMMY
Constructor and Description |
---|
DummyCancellationPoint() |
Modifier and Type | Method and Description |
---|---|
void |
cancel()
Cancel current point;
|
void |
cancel(String theCause)
Cancels the execution of this computation.
|
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()
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.
|
boolean |
isCancelled() |
void |
wait(long timeout,
TimeUnit unit)
Waits for specified timeout while the process acquired Cancellation point has been finished;
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
forCancelCheck, uncloseable
throwIfCancelled
public String getProcessDescription()
CancellationPoint
getProcessDescription
in interface CancellationPoint
public void check()
CancelCheck
check
in interface CancelCheck
public boolean isCancelled()
isCancelled
in interface CancelCheck
public void cancel()
CancellationPoint
cancel
in interface CancellationPoint
public void cancel(String theCause)
Cancellable
Iterator.next()
or Iterator.hasNext()
after this function is called will result in an exception being thrown. Some implementations might have a different strategy but the
expectation for every implementation is to finish computation in a reasonable time. So implementations that always return few results without
much computation might ignore cancel calls completely.
If a computation is composed of other computations then cancel call will be typically propagated to the child computations since there could be
significant amount of work performed by them before the parent computation returns a single value.
This function is typically called from a different thread the thread that iterates over the results of this computation so implementations
should consider this.cancel
in interface Cancellable
theCause
- the cause of the cancellation or null
if the cause is unknownpublic String getCancellationMessage()
CancelCheck
getCancellationMessage
in interface CancelCheck
getCancellationMessage
in interface CancellationPoint
public void wait(long timeout, TimeUnit unit)
CancellationPoint
wait
in interface CancellationPoint
timeout
- - the time;unit
- - the unit;public void close()
CancellationPoint
close
in interface CancellationPoint
close
in interface AutoCloseable
Copyright © 2010-2016 Stardog Union. All Rights Reserved.