Enum Command.Type

java.lang.Object

java.lang.Enum<Command.Type>

Command.Type

All Implemented Interfaces:

Serializable, Comparable<Command.Type>

Enclosing class:

Command

public static enum Command.Type
extends Enum<Command.Type>

This enumeration defines the various types of commands that the clients and server operate with. Note that several of these can only be generated by the server and will never be sent by a conforming client.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONNECT
CREATE
ERROR
INVITE
JOIN
KICK
LEAVE
MESG
NAMES
NICK
QUIT

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	allowsPayload(Command.Type type)
static int	getNumParams(Command.Type type)
static boolean	requiresPayload(Command.Type type)
static Command.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static Command.Type[]	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

CONNECT

public static final Command.Type CONNECT

NICK

public static final Command.Type NICK

CREATE

public static final Command.Type CREATE

JOIN

public static final Command.Type JOIN

NAMES

public static final Command.Type NAMES

MESG

public static final Command.Type MESG

LEAVE

public static final Command.Type LEAVE

KICK

public static final Command.Type KICK

QUIT

public static final Command.Type QUIT

INVITE

public static final Command.Type INVITE

ERROR

public static final Command.Type ERROR

Method Detail

values

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

Returns:

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

valueOf

public static Command.Type valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNumParams

public static int getNumParams(Command.Type type)

allowsPayload

public static boolean allowsPayload(Command.Type type)

requiresPayload

public static boolean requiresPayload(Command.Type type)