- Direct Known Subclasses:
public abstract class Event extends Object
Represents an event. All events require a static method named getHandlerList() which returns the same
Nested Class SummaryModifier and TypeClassDescription
()The default constructor is defined for cleaner code.
(boolean isAsync)This constructor is used to explicitly declare an event as synchronous or asynchronous.
Method SummaryModifier and TypeMethodDescription
()Calls the event and tests if cancelled.
()Convenience method for providing a user-friendly identifier.
()Any custom event that should not by synchronized with other events must use the specific constructor.
Eventpublic Event()The default constructor is defined for cleaner code. This constructor assumes the event is synchronous.
Eventpublic Event(boolean isAsync)This constructor is used to explicitly declare an event as synchronous or asynchronous.
isAsync- true indicates the event will fire asynchronously, false by default from default constructor
callEventpublic boolean callEvent()Calls the event and tests if cancelled.
- false if event was cancelled, if cancellable. otherwise true.
getEventNameConvenience method for providing a user-friendly identifier. By default, it is the event's class's simple name.
- name of this event
isAsynchronouspublic final boolean isAsynchronous()Any custom event that should not by synchronized with other events must use the specific constructor. These are the caveats of using an asynchronous event:
- The event is never fired from inside code triggered by a
synchronous event. Attempting to do so results in an
- However, asynchronous event handlers may fire synchronous or asynchronous events
- The event may be fired multiple times simultaneously and in any order.
- Any newly registered or unregistered handler is ignored after an event starts execution.
- The handlers for this event may block for any length of time.
- Some implementations may selectively declare a specific event use as asynchronous. This behavior should be clearly defined.
- Asynchronous calls are not calculated in the plugin timing system.
- false by default, true if the event fires asynchronously
- The event is never fired from inside code triggered by a synchronous event. Attempting to do so results in an