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

Class DhApiEventRegister

java.lang.Object

com.seibel.distanthorizons.api.methods.events.DhApiEventRegister

public class DhApiEventRegister
extends Object

Handles adding/removing event handlers.

Since:

API 1.0.0

Constructor Summary

Constructors

Constructor	Description
DhApiEventRegister()

Method Summary

Modifier and Type	Method	Description
static DhApiResult<Void>	off(Class<? extends IDhApiEvent> eventInterface, Class<IDhApiEvent> eventHandlerClass)	Unregisters the given event handler for this event if one has been registered.
static DhApiResult<Void>	on(Class<? extends IDhApiEvent> eventInterface, IDhApiEvent eventHandlerImplementation)	Registers the given event handler.

Methods inherited from class java.lang.Object

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

Constructor Details

DhApiEventRegister

public DhApiEventRegister()

Method Details

on

public static DhApiResult<Void> on(Class<? extends IDhApiEvent> eventInterface,
 IDhApiEvent eventHandlerImplementation)

Registers the given event handler.
Only one eventHandler of a specific class can be registered at a time. If multiple of the same eventHandler are added DhApiResult will return the name of the already added handler and success = false.

off

public static DhApiResult<Void> off(Class<? extends IDhApiEvent> eventInterface,
 Class<IDhApiEvent> eventHandlerClass)

Unregisters the given event handler for this event if one has been registered.
If no eventHandler of the given class has been registered the result will return success = false.