Package org.spongepowered.api.event

Enum Class Order

java.lang.Object
java.lang.Enum<Order>
org.spongepowered.api.event.Order
All Implemented Interfaces:
Serializable, Comparable<Order>, Constable
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 Recommendations
Order Recommendation
PRE Initialisation and registration actions
AFTER_PRE Immediate responses to actions in PRE
FIRST Cancellation by protection plugins for informational purposes
EARLY Standard actions that should happen before other plugins react to the event
DEFAULT The default action order
LATE Standard actions that should happen after other plugins react to the event
LAST Final cancellation by protection plugins
BEFORE_POST Actions that need to respond to cancelled events before POST
POST Actions that need to react to the final and stable effects of event

  • 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
    AFTER_PRE
    The order point of AFTER_PRE handles things that need to be done after PRE.
    BEFORE_POST
    The order point of BEFORE_POST handles preparation for things needing to be done in post.
    DEFAULT
    The order point of DEFAULT handles just standard event handlings, you should use this unless you know you need otherwise.
    EARLY
    The order point of EARLY handles standard actions that need to be done before other plugins.
    FIRST
    The order point of FIRST handles cancellation by protection plugins for informational responses.
    LAST
    The order point of LAST handles last minute cancellations by protection plugins.
    LATE
    The order point of LATE handles standard actions that need to be done after other plugins.
    POST
    The order point of POST handles last minute things and monitoring of events for rollback or logging.
    PRE
    The order point of PRE handles setting up things that need to be done before other things are handled.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Order
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static Order[]
    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

    • 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.

    • AFTER_PRE

      public static final Order AFTER_PRE
      The order point of AFTER_PRE handles things that need to be done after PRE.

    • FIRST

      public static final Order FIRST
      The order point of FIRST handles cancellation by protection plugins for informational responses.

    • EARLY

      public static final Order EARLY
      The order point of EARLY handles standard actions that need to be done before other plugins.

    • 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.

    • LATE

      public static final Order LATE
      The order point of LATE handles standard actions that need to be done after other plugins.

    • LAST

      public static final Order LAST
      The order point of LAST handles last minute cancellations by protection plugins.

    • BEFORE_POST

      public static final Order BEFORE_POST
      The order point of BEFORE_POST handles preparation for things needing to be done in post.

    • POST

      public static final Order POST
      The order point of POST handles last minute things and monitoring of events for rollback or logging.

  • Method Details

    • values

      public static Order[] 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 Order 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