public abstract class PipeEvent
extends java.lang.Object
cancel()
, however this will
only have an effect if canBeCancelled
is true. Refer to individual classes for information on if they can
be cancelled, and what cancelling the event does.Modifier and Type | Field and Description |
---|---|
boolean |
canBeCancelled |
IPipeHolder |
holder |
Modifier | Constructor and Description |
---|---|
protected |
PipeEvent(boolean canBeCancelled,
IPipeHolder holder)
deprecated: Because cancellation is going to be removed (at some point in the future)
|
|
PipeEvent(IPipeHolder holder) |
Modifier and Type | Method and Description |
---|---|
void |
cancel() |
java.lang.String |
checkStateForErrors()
Called after every event handler has received this pipe event, to pick up simple mistakes when implementing pipe
event handlers.
|
boolean |
isCanceled() |
public final boolean canBeCancelled
public final IPipeHolder holder
public PipeEvent(IPipeHolder holder)
protected PipeEvent(boolean canBeCancelled, IPipeHolder holder)
public void cancel()
public boolean isCanceled()
public java.lang.String checkStateForErrors()