com.comphenix.protocol.events

Enum ConnectionSide

java.lang.Object

java.lang.Enum<ConnectionSide>

com.comphenix.protocol.events.ConnectionSide

All Implemented Interfaces:

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

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

Used to set a packet filter.

Author:

Kristian

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTH Listen for both client and server side packets.
CLIENT_SIDE Listen for client side packets that will invoke onPacketReceiving().
SERVER_SIDE Listen for server side packets that will invoke onPacketSending().

Method Summary

Methods

Modifier and Type	Method and Description
static ConnectionSide	add(ConnectionSide a, ConnectionSide b) If both connection sides are present, return BOTH - otherwise, return the one valud connection side.
PacketType.Sender	getSender() Retrieve the sender of this connection side.
boolean	isForClient()
boolean	isForServer()
static ConnectionSide	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ConnectionSide[]	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

SERVER_SIDE

public static final ConnectionSide SERVER_SIDE

Listen for server side packets that will invoke onPacketSending().

CLIENT_SIDE

public static final ConnectionSide CLIENT_SIDE

Listen for client side packets that will invoke onPacketReceiving().

BOTH

public static final ConnectionSide BOTH

Listen for both client and server side packets.

Method Detail

values

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

Returns:

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

valueOf

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

isForClient

public boolean isForClient()

isForServer

public boolean isForServer()

getSender

public PacketType.Sender getSender()

Retrieve the sender of this connection side.

This is NULL for BOTH.

Returns:

The sender.

add

public static ConnectionSide add(ConnectionSide a,
                 ConnectionSide b)

If both connection sides are present, return BOTH - otherwise, return the one valud connection side.

NULL is not a valid connection side.

Parameters:

a - - the first connection side.

b - - the second connection side.

Returns:

BOTH or the one valid side, or NULL.