com.comphenix.protocol.events

Enum ListenerPriority

java.lang.Object

java.lang.Enum<ListenerPriority>

com.comphenix.protocol.events.ListenerPriority

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ListenerPriority>

public enum ListenerPriority
extends java.lang.Enum<ListenerPriority>

Represents a packet event priority, similar to the Bukkit EventPriority.

Author:

Kristian

Enum Constant Summary

Enum Constants

Enum Constant and Description
HIGH Event call is of high importance.
HIGHEST Event call is critical and must have the final say in what happens to the event.
LOW Event call is of low importance.
LOWEST Event call is of very low importance and should be ran first, to allow other plugins to further customise the outcome.
MONITOR Event is listened to purely for monitoring the outcome of an event.
NORMAL Event call is neither important or unimportant, and may be ran normally.

Method Summary

Methods

Modifier and Type	Method and Description
int	getSlot() A low slot represents a low priority.
static ListenerPriority	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ListenerPriority[]	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

LOWEST

public static final ListenerPriority LOWEST

Event call is of very low importance and should be ran first, to allow other plugins to further customise the outcome.

LOW

public static final ListenerPriority LOW

Event call is of low importance.

NORMAL

public static final ListenerPriority NORMAL

Event call is neither important or unimportant, and may be ran normally.

HIGH

public static final ListenerPriority HIGH

Event call is of high importance.

HIGHEST

public static final ListenerPriority HIGHEST

Event call is critical and must have the final say in what happens to the event.

MONITOR

public static final ListenerPriority MONITOR

Event is listened to purely for monitoring the outcome of an event.

No modifications to the event should be made under this priority.

Method Detail

values

public static ListenerPriority[] 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 (ListenerPriority c : ListenerPriority.values())
    System.out.println(c);

Returns:

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

valueOf

public static ListenerPriority 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

getSlot

public int getSlot()

A low slot represents a low priority.

Returns:

Integer representation of this priorty.