org.apache.james.imap.message.request

Enum SystemMessage

java.lang.Object

java.lang.Enum<SystemMessage>

org.apache.james.imap.message.request.SystemMessage

All Implemented Interfaces:

Serializable, Comparable<SystemMessage>, ImapMessage

public enum SystemMessage
extends Enum<SystemMessage>
implements ImapMessage

System messages do not correspond to IMAP commands.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FORCE_LOGOUT Indicate that an premature termination has forced a logout without a LOGOUT command

Method Summary

Methods

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

FORCE_LOGOUT

public static final SystemMessage FORCE_LOGOUT

Indicate that an premature termination has forced a logout without a LOGOUT command

Method Detail

values

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

Returns:

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

valueOf

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