org.spongepowered.api.event

Enum Order

java.lang.Object

java.lang.Enum<Order>

org.spongepowered.api.event.Order

All Implemented Interfaces:

Serializable, Comparable<Order>

public enum Order
extends Enum<Order>

Order that Listenerd methods may be registered at.

Event handlers are called the order given in the following table.

Order	Read Only	Cancellation Allowed	Recommendation
PRE	YES	NO	Initialisation and registration actions
AFTER_PRE	YES	NO	Immediate responses to actions in PRE
FIRST	YES	YES	Cancellation by protection plugins for informational purposes
EARLY	NO	YES	Standard actions that should happen before other plugins react to the event
DEFAULT	NO	YES	The default action order
LATE	NO	YES	Standard actions that should happen after other plugins react to the event
LAST	YES	YES	Final cancellation by protection plugins
BEFORE_POST	YES	NO	Actions that need to respond to cancelled events before POST
POST	YES	NO	Actions that need to react to the final and stable effects of event

Enum Constant Summary

Enum Constants

Enum Constant and Description
AFTER_PRE The order point of AFTER_PRE handles things that need to be done after PRE AFTER_PRE is read only and cannot cancel the events.
BEFORE_POST The order point of BEFORE_POST handles preparation for things needing to be done in post BEFORE_POST is read only and cannot cancel events.
DEFAULT The order point of DEFAULT handles just standard event handlings, you should use this unless you know you need otherwise DEFAULT is not read only and can cancel events.
EARLY The order point of EARLY handles standard actions that need to be done before other plugins EARLY is not read only and can cancel events.
FIRST The order point of FIRST handles cancellation by protection plugins for informational responses FIRST is read only but can cancel events.
LAST The order point of LAST handles last minute cancellations by protection plugins LAST is read only but can cancel events.
LATE The order point of LATE handles standard actions that need to be done after other plugins LATE is not read only and can cancel the event.
POST The order point of POST handles last minute things and monitoring of events for rollback or logging POST is read only and cannot cancel events.
PRE The order point of PRE handles setting up things that need to be done before other things are handled PRE is read only and cannot cancel the events.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PRE

public static final Order PRE

The order point of PRE handles setting up things that need to be done before other things are handled PRE is read only and cannot cancel the events.

AFTER_PRE

public static final Order AFTER_PRE

The order point of AFTER_PRE handles things that need to be done after PRE AFTER_PRE is read only and cannot cancel the events.

FIRST

public static final Order FIRST

The order point of FIRST handles cancellation by protection plugins for informational responses FIRST is read only but can cancel events.

EARLY

public static final Order EARLY

The order point of EARLY handles standard actions that need to be done before other plugins EARLY is not read only and can cancel events.

DEFAULT

public static final Order DEFAULT

The order point of DEFAULT handles just standard event handlings, you should use this unless you know you need otherwise DEFAULT is not read only and can cancel events.

LATE

public static final Order LATE

The order point of LATE handles standard actions that need to be done after other plugins LATE is not read only and can cancel the event.

LAST

public static final Order LAST

The order point of LAST handles last minute cancellations by protection plugins LAST is read only but can cancel events.

BEFORE_POST

public static final Order BEFORE_POST

The order point of BEFORE_POST handles preparation for things needing to be done in post BEFORE_POST is read only and cannot cancel events.

POST

public static final Order POST

The order point of POST handles last minute things and monitoring of events for rollback or logging POST is read only and cannot cancel events.

Method Detail

values

public static Order[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Order c : Order.values())
    System.out.println(c);

Returns:

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

valueOf

public static Order valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null