Package com.seibel.distanthorizons.api.methods.events.sharedParameterObjects

Class DhApiCancelableEventParam<T>

java.lang.Object

com.seibel.distanthorizons.api.methods.events.sharedParameterObjects.DhApiEventParam<T>

com.seibel.distanthorizons.api.methods.events.sharedParameterObjects.DhApiCancelableEventParam<T>

public class DhApiCancelableEventParam<T>
extends DhApiEventParam<T>

Extension of DhApiEventParam that allows the event to be canceled.

Since:

API 1.0.0

Field Summary

Fields inherited from class com.seibel.distanthorizons.api.methods.events.sharedParameterObjects.DhApiEventParam

value

Constructor Summary

Constructors

Constructor	Description
DhApiCancelableEventParam(T value)

Method Summary

Modifier and Type	Method	Description
void	cancelEvent()	Prevents the DH event from completing after all bound event handlers have been fired.
boolean	isEventCanceled()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DhApiCancelableEventParam

public DhApiCancelableEventParam(T value)

Method Details

cancelEvent

public void cancelEvent()

Prevents the DH event from completing after all bound event handlers have been fired.

isEventCanceled

public boolean isEventCanceled()

Returns:

if this DH event has been canceled, either by this event handler or a previous one.