org.kitteh.irc.client.library.element.mode

Enum ChannelMode.Type

java.lang.Object

java.lang.Enum<ChannelMode.Type>

org.kitteh.irc.client.library.element.mode.ChannelMode.Type

All Implemented Interfaces:

Serializable, Comparable<ChannelMode.Type>

Enclosing interface:

ChannelMode

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

Channel mode types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
A_MASK Always has parameter, which is a mask.
B_PARAMETER_ALWAYS Always has parameter.
C_PARAMETER_ON_SET Has parameter when setting.
D_PARAMETER_NEVER Never has parameters.

Method Summary

Modifier and Type	Method and Description
boolean	isParameterRequiredOnRemoval() Gets if a parameter is required when removing the mode.
boolean	isParameterRequiredOnSetting() Gets if a parameter is required when adding the mode.
static ChannelMode.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static ChannelMode.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

A_MASK

public static final ChannelMode.Type A_MASK

Always has parameter, which is a mask.

B_PARAMETER_ALWAYS

public static final ChannelMode.Type B_PARAMETER_ALWAYS

Always has parameter.

C_PARAMETER_ON_SET

public static final ChannelMode.Type C_PARAMETER_ON_SET

Has parameter when setting.

D_PARAMETER_NEVER

public static final ChannelMode.Type D_PARAMETER_NEVER

Never has parameters.

Method Detail

values

public static ChannelMode.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 (ChannelMode.Type c : ChannelMode.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 ChannelMode.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

isParameterRequiredOnRemoval

public boolean isParameterRequiredOnRemoval()

Gets if a parameter is required when removing the mode.

Returns:

true if a parameter is required on removal

isParameterRequiredOnSetting

public boolean isParameterRequiredOnSetting()

Gets if a parameter is required when adding the mode.

Returns:

true if a parameter is required on addition