com.mooapi.common.command.client
Enum ClientCommandType

java.lang.Object
  extended by java.lang.Enum<ClientCommandType>
      extended by com.mooapi.common.command.client.ClientCommandType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ClientCommandType>

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

MooAPI server client command type.

Author:
Steve Taylor

Enum Constant Summary
CHANNEL_JOIN
           
CHANNEL_LEAVE
           
MESSAGE_TO_CHANNEL
           
MESSAGE_TO_CONNECTION
           
MESSAGE_TO_SERVER
           
NAME_CHANGE
           
NAME_SET
           
UNKNOWN
           
 
Method Summary
static ClientCommandType decode(byte encoding)
          Decode the specified byte, returning the associated ClientCommandType.
 byte encode()
          Get the command type's encoded value.
static ClientCommandType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ClientCommandType[] 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

UNKNOWN

public static final ClientCommandType UNKNOWN

MESSAGE_TO_CHANNEL

public static final ClientCommandType MESSAGE_TO_CHANNEL

MESSAGE_TO_SERVER

public static final ClientCommandType MESSAGE_TO_SERVER

MESSAGE_TO_CONNECTION

public static final ClientCommandType MESSAGE_TO_CONNECTION

CHANNEL_JOIN

public static final ClientCommandType CHANNEL_JOIN

CHANNEL_LEAVE

public static final ClientCommandType CHANNEL_LEAVE

NAME_CHANGE

public static final ClientCommandType NAME_CHANGE

NAME_SET

public static final ClientCommandType NAME_SET
Method Detail

values

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

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

valueOf

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

encode

public byte encode()
Get the command type's encoded value.

Returns:

decode

public static ClientCommandType decode(byte encoding)
Decode the specified byte, returning the associated ClientCommandType.

Parameters:
encoding - A byte.
Returns:
The decoded ClientCommandType.


Copyright © 2009. All Rights Reserved.