org.schwering.irc.lib.util

Enum CTCPCommand

java.lang.Object

java.lang.Enum<CTCPCommand>

org.schwering.irc.lib.util.CTCPCommand

All Implemented Interfaces:

Serializable, Comparable<CTCPCommand>

public enum CTCPCommand
extends Enum<CTCPCommand>

An enum of Client-to-client protocol (CTCP) commands. See http://www.irchelp.org/irchelp/rfc/ctcpspec.html

Author:

Peter Palaga

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTION
CLIENTINFO
DCC
ERRMSG
FINGER
PING
SED
SOURCE
TIME
USERINFO
VERSION

Field Summary

Fields

Modifier and Type	Field and Description
static char	QUOTE_CHAR
static int	SHORTEST_COMMAND_LENGTH

Method Summary

Modifier and Type	Method and Description
static CTCPCommand	fastValueOf(String command) A HashMap-backed and null-tolerant alternative to valueOf(String).
static CTCPCommand	valueOf(String name) Returns the enum constant of this type with the specified name.
static CTCPCommand[]	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

ACTION

public static final CTCPCommand ACTION

DCC

public static final CTCPCommand DCC

SED

public static final CTCPCommand SED

FINGER

public static final CTCPCommand FINGER

VERSION

public static final CTCPCommand VERSION

SOURCE

public static final CTCPCommand SOURCE

USERINFO

public static final CTCPCommand USERINFO

CLIENTINFO

public static final CTCPCommand CLIENTINFO

ERRMSG

public static final CTCPCommand ERRMSG

PING

public static final CTCPCommand PING

TIME

public static final CTCPCommand TIME

Field Detail

SHORTEST_COMMAND_LENGTH

public static final int SHORTEST_COMMAND_LENGTH

QUOTE_CHAR

public static final char QUOTE_CHAR

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

fastValueOf

public static CTCPCommand fastValueOf(String command)

A HashMap-backed and null-tolerant alternative to valueOf(String). The lookup is case-sensitive.

Parameters:

command - the command as a String

Returns:

the CTCPCommand that corresponds to the given string command or null if no such command exists