org.timothyb89.eventbus

Annotation Type EventHandler

@Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface EventHandler

Defines a flag for a method that allows it to receive events

Author:

timothyb89

See Also:

EventBus.register(Object)

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	priority Defines the priority for this event handler.
boolean	vetoable Specifies whether or not this event handler may be vetoed.

Element Detail

priority

public abstract int priority

Defines the priority for this event handler. Events with a higher priority are executed before events with a lower priority. This value is EventPriority.NORMAL unless otherwise specified.

Returns:

the integer priority; more positive is higher; negative is lower

See Also:

EventPriority

Default:

0

vetoable

public abstract boolean vetoable

Specifies whether or not this event handler may be vetoed. By default, this is true, and setting this to false should be used with extreme caution. Handlers that are not vetoable will still be run after a more important event has specifically requested that they not, and as such may cause some logical errors.

Specifically, true status should be reserved either for event handlers vital to the operation of the event bus host, or completely passive events (such as loggers) that can't have an effect on the greater system.

Returns:

true if this handler may be vetoed; false otherwise

Default:

true