Package civitas.celestis.event

Enum Class HandlerPriority

java.lang.Object

java.lang.Enum<HandlerPriority>

civitas.celestis.event.HandlerPriority

All Implemented Interfaces:

Serializable, Comparable<HandlerPriority>, Constable

public enum HandlerPriority
extends Enum<HandlerPriority>

The execution priority of an event handler. Lower enum ordinals are guaranteed to be executed earlier than higher enum ordinals.

See Also:

• Handleable
• Event
• EventHandler
• Listener

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EARLY
INITIALIZATION	A reserved priority for application critical tasks.
LATE
MEDIUM	The default priority when no priority is specified.
PERMISSIVE	The highest priority trivial tasks should have.
POST_EARLY
POST_LATE
PRE_EARLY
PRE_LATE
PREEMPTIVE	The lowest priority trivial tasks should have.
TERMINAL	A reserved priority for application critical tasks.

Method Summary

Modifier and Type	Method	Description
static HandlerPriority	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HandlerPriority[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INITIALIZATION

@ApplicationCritical(created="0.4",
                     lastUpdated="0.4")
public static final HandlerPriority INITIALIZATION

A reserved priority for application critical tasks.

This priority should only be used by event handlers which alter the control flow of the main thread.

PREEMPTIVE

public static final HandlerPriority PREEMPTIVE

The lowest priority trivial tasks should have.

PRE_EARLY

public static final HandlerPriority PRE_EARLY

EARLY

public static final HandlerPriority EARLY

POST_EARLY

public static final HandlerPriority POST_EARLY

MEDIUM

public static final HandlerPriority MEDIUM

The default priority when no priority is specified.

PRE_LATE

public static final HandlerPriority PRE_LATE

LATE

public static final HandlerPriority LATE

POST_LATE

public static final HandlerPriority POST_LATE

PERMISSIVE

public static final HandlerPriority PERMISSIVE

The highest priority trivial tasks should have.

TERMINAL

@ApplicationCritical(created="0.4",
                     lastUpdated="0.4")
public static final HandlerPriority TERMINAL

A reserved priority for application critical tasks.

This priority should only be used for event handlers which alter the control flow of the main thread.

Method Details

values

public static HandlerPriority[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static HandlerPriority valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null