com.comphenix.protocol.events

Class ListeningWhitelist

java.lang.Object

com.comphenix.protocol.events.ListeningWhitelist

public class ListeningWhitelist
extends Object

Determines which packets will be observed by a listener, and with what priority.

Author:

Kristian

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListeningWhitelist.Builder Represents a builder of whitelists.

Field Summary

Fields

Modifier and Type	Field and Description
static ListeningWhitelist	EMPTY_WHITELIST A whitelist with no packets - indicates that the listener shouldn't observe any packets.

Constructor Summary

Constructors

Constructor and Description
ListeningWhitelist(ListenerPriority priority, Integer... whitelist) Deprecated.
ListeningWhitelist(ListenerPriority priority, Integer[] whitelist, GamePhase gamePhase) Deprecated.
ListeningWhitelist(ListenerPriority priority, Integer[] whitelist, GamePhase gamePhase, ListenerOptions... options) Deprecated.
ListeningWhitelist(ListenerPriority priority, Set<Integer> whitelist) Deprecated.
ListeningWhitelist(ListenerPriority priority, Set<Integer> whitelist, GamePhase gamePhase) Deprecated.

Method Summary

Modifier and Type	Method and Description
static boolean	containsAny(ListeningWhitelist whitelist, int... idList) Determine if any of the given IDs can be found in the whitelist.
boolean	equals(Object obj)
GamePhase	getGamePhase() Retrieve which game phase this listener is active under.
Set<ListenerOptions>	getOptions() Retrieve every special option associated with this whitelist.
ListenerPriority	getPriority() Retrieve the priority in the execution order of the packet listener.
Set<PacketType>	getTypes() Retrieves a set of the packets that will be observed by the listeners.
Set<Integer>	getWhitelist() Deprecated.
int	hashCode()
static boolean	isEmpty(ListeningWhitelist whitelist) Determine if the given whitelist is empty or not.
boolean	isEnabled() Whether or not this whitelist has any enabled packets.
static ListeningWhitelist.Builder	newBuilder() Construct a new builder of whitelists.
static ListeningWhitelist.Builder	newBuilder(ListeningWhitelist template) Construct a new builder of whitelists initialized to the same values as the template.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_WHITELIST

public static final ListeningWhitelist EMPTY_WHITELIST

A whitelist with no packets - indicates that the listener shouldn't observe any packets.

Constructor Detail

ListeningWhitelist

@Deprecated
public ListeningWhitelist(ListenerPriority priority,
                                       Set<Integer> whitelist)

Deprecated.

Creates a packet whitelist for a given priority with a set of packet IDs.

Deprecated: Use newBuilder() instead.

Parameters:

priority - - the listener priority.

whitelist - - set of IDs to observe/enable.

ListeningWhitelist

@Deprecated
public ListeningWhitelist(ListenerPriority priority,
                                       Set<Integer> whitelist,
                                       GamePhase gamePhase)

Deprecated.

Creates a packet whitelist for a given priority with a set of packet IDs.

Deprecated: Use newBuilder() instead.

Parameters:

priority - - the listener priority.

whitelist - - set of IDs to observe/enable.

gamePhase - - which game phase to receieve notifications on.

ListeningWhitelist

@Deprecated
public ListeningWhitelist(ListenerPriority priority,
                                       Integer... whitelist)

Deprecated.

Creates a packet whitelist of a given priority for a list of packets.

Deprecated: Use newBuilder() instead.

Parameters:

priority - - the listener priority.

whitelist - - list of packet IDs to observe/enable.

ListeningWhitelist

@Deprecated
public ListeningWhitelist(ListenerPriority priority,
                                       Integer[] whitelist,
                                       GamePhase gamePhase)

Deprecated.

Creates a packet whitelist for a given priority with a set of packet IDs.

Deprecated: Use newBuilder() instead.

Parameters:

priority - - the listener priority.

whitelist - - list of packet IDs to observe/enable.

gamePhase - - which game phase to receieve notifications on.

ListeningWhitelist

@Deprecated
public ListeningWhitelist(ListenerPriority priority,
                                       Integer[] whitelist,
                                       GamePhase gamePhase,
                                       ListenerOptions... options)

Deprecated.

Creates a packet whitelist for a given priority with a set of packet IDs and options.

Deprecated: Use newBuilder() instead.

Parameters:

priority - - the listener priority.

whitelist - - list of packet IDs to observe/enable.

gamePhase - - which game phase to receieve notifications on.

options - - every special option associated with this whitelist.

Method Detail

isEnabled

public boolean isEnabled()

Whether or not this whitelist has any enabled packets.

Returns:

TRUE if there are any packets, FALSE otherwise.

getPriority

public ListenerPriority getPriority()

Retrieve the priority in the execution order of the packet listener. Highest priority will be executed last.

Returns:

Execution order in terms of priority.

getWhitelist

@Deprecated
public Set<Integer> getWhitelist()

Deprecated.

Retrieves the list of packets that will be observed by the listeners.

Deprecated: Use getTypes() instead.

Returns:

Packet whitelist.

getTypes

public Set<PacketType> getTypes()

Retrieves a set of the packets that will be observed by the listeners.

Returns:

Packet whitelist.

getGamePhase

public GamePhase getGamePhase()

Retrieve which game phase this listener is active under.

Returns:

The active game phase.

getOptions

public Set<ListenerOptions> getOptions()

Retrieve every special option associated with this whitelist.

Returns:

Every special option.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

containsAny

public static boolean containsAny(ListeningWhitelist whitelist,
                                  int... idList)

Determine if any of the given IDs can be found in the whitelist.

Parameters:

whitelist - - whitelist to test.

idList - - list of packet IDs to find.

Returns:

TRUE if any of the packets in the list can be found in the whitelist, FALSE otherwise.

isEmpty

public static boolean isEmpty(ListeningWhitelist whitelist)

Determine if the given whitelist is empty or not.

Parameters:

whitelist - - the whitelist to test.

Returns:

TRUE if the whitelist is empty, FALSE otherwise.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

newBuilder

public static ListeningWhitelist.Builder newBuilder()

Construct a new builder of whitelists.

Returns:

New whitelist builder.

newBuilder

public static ListeningWhitelist.Builder newBuilder(ListeningWhitelist template)

Construct a new builder of whitelists initialized to the same values as the template.

Parameters:

template - - the template object.

Returns:

New whitelist builder.