org.kitteh.irc.client.library.command

Enum MonitorCommand.Action

java.lang.Object

java.lang.Enum<MonitorCommand.Action>

org.kitteh.irc.client.library.command.MonitorCommand.Action

All Implemented Interfaces:

Serializable, Comparable<MonitorCommand.Action>

Enclosing class:

MonitorCommand

public static enum MonitorCommand.Action
extends Enum<MonitorCommand.Action>

Describes an action to take with the MONITOR command.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADD_TARGET Add specified target(s).
CLEAR_ALL_TARGETS Clear the entire target list.
LIST_TARGETS List all targeted nicknames.
REMOVE_TARGET Remove specified target(s).
STATUS_OUTPUT_ALL Output status of all targets.

Method Summary

Modifier and Type	Method and Description
char	getCharacter() Gets the character for this action.
static MonitorCommand.Action	valueOf(String name) Returns the enum constant of this type with the specified name.
static MonitorCommand.Action[]	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

ADD_TARGET

public static final MonitorCommand.Action ADD_TARGET

Add specified target(s).

CLEAR_ALL_TARGETS

public static final MonitorCommand.Action CLEAR_ALL_TARGETS

Clear the entire target list.

LIST_TARGETS

public static final MonitorCommand.Action LIST_TARGETS

List all targeted nicknames.

REMOVE_TARGET

public static final MonitorCommand.Action REMOVE_TARGET

Remove specified target(s).

STATUS_OUTPUT_ALL

public static final MonitorCommand.Action STATUS_OUTPUT_ALL

Output status of all targets.

Method Detail

values

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

Returns:

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

valueOf

public static MonitorCommand.Action 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

getCharacter

public char getCharacter()

Gets the character for this action.

Returns:

the action's character