org.kitteh.irc.client.library.feature.defaultmessage

Enum DefaultMessageType

java.lang.Object

java.lang.Enum<DefaultMessageType>

org.kitteh.irc.client.library.feature.defaultmessage.DefaultMessageType

All Implemented Interfaces:

Serializable, Comparable<DefaultMessageType>

public enum DefaultMessageType
extends Enum<DefaultMessageType>

An enum that maps out all possible outbound messages between KICL and the server that we wish to provide a custom default message for.

Enum Constant Summary

Enum Constants

Enum Constant and Description
KICK When a KickCommand has no reason supplied.
PART When a channel is parted with no reason supplied.
QUIT An user specified shutdown.
QUIT_INTERNAL_EXCEPTION When KICL experiences an IO exception it will attempt to reconnect to the server with this value.
QUIT_PING_TIMEOUT When KICL thinks it has lost connection with the server, it will attempt to reconnect with this value.
RECONNECT When KICL triggers a reconnect neither due to connection loss with the server, nor due to an exception.
STS_FAILURE STS failure.

Method Summary

Modifier and Type	Method and Description
@Nullable String	getFallback() Gets the value used by the Client, if no default is set.
static DefaultMessageType	valueOf(String name) Returns the enum constant of this type with the specified name.
static DefaultMessageType[]	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

KICK

public static final DefaultMessageType KICK

When a KickCommand has no reason supplied.

PART

public static final DefaultMessageType PART

When a channel is parted with no reason supplied.

QUIT

public static final DefaultMessageType QUIT

An user specified shutdown.

QUIT_PING_TIMEOUT

public static final DefaultMessageType QUIT_PING_TIMEOUT

When KICL thinks it has lost connection with the server, it will attempt to reconnect with this value. Does not work when it is the server that is timing KICL out (e.g. because you lose internet connection)

QUIT_INTERNAL_EXCEPTION

public static final DefaultMessageType QUIT_INTERNAL_EXCEPTION

When KICL experiences an IO exception it will attempt to reconnect to the server with this value.

RECONNECT

public static final DefaultMessageType RECONNECT

When KICL triggers a reconnect neither due to connection loss with the server, nor due to an exception.

STS_FAILURE

public static final DefaultMessageType STS_FAILURE

STS failure.

Method Detail

values

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

Returns:

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

valueOf

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

getFallback

public @Nullable String getFallback()

Gets the value used by the Client, if no default is set.

Returns:

value used