Package org.spongepowered.api.event

Enum Order

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Order>
    public enum Order
extends java.lang.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

    • 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

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Order valueOf​(java.lang.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.

      • 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 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​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null