com.ibm.tivoli.imi.spi

Enum IMException.Code

java.lang.Object

java.lang.Enum<IMException.Code>

com.ibm.tivoli.imi.spi.IMException.Code

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IMException.Code>

Enclosing class:

IMException

public static enum IMException.Code
extends java.lang.Enum<IMException.Code>

Every IMException must have a code which identifies a generic reason or cause that generated the exception. This feature has two advantages:
1- Avoids the IM API to have a lot of different IMException subclasses
2- Allows the programmer to use internationalization techniques using IMException code instead of its message (String).

Note: the Exception.getMessage() method returns the default description of the code assigned to this IM exception (in English) and the message, (if set)

Author:

fabiosc

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONNECTION_TIMEOUT
IM_EXCEPTION
IM_SESSION_CLOSED
INVALID_ACCOUNT
INVALID_CON_TIMEOUT
INVALID_DRIVER
INVALID_IM_SERVER
INVALID_IM_SERVER_PORT
INVALID_IM_SERVICE_NAME
INVALID_RESOLVE_TIMEOUT
MESSAGE_TOO_LONG
NOT_IMPLEMENTED_YET
RESOLVE_EXCEPTION
SERVER_EXCEPTION

Method Summary

Modifier and Type	Method and Description
static IMException.Code	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IMException.Code[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

IM_EXCEPTION

public static final IMException.Code IM_EXCEPTION

INVALID_DRIVER

public static final IMException.Code INVALID_DRIVER

IM_SESSION_CLOSED

public static final IMException.Code IM_SESSION_CLOSED

RESOLVE_EXCEPTION

public static final IMException.Code RESOLVE_EXCEPTION

INVALID_IM_SERVER

public static final IMException.Code INVALID_IM_SERVER

CONNECTION_TIMEOUT

public static final IMException.Code CONNECTION_TIMEOUT

INVALID_ACCOUNT

public static final IMException.Code INVALID_ACCOUNT

INVALID_CON_TIMEOUT

public static final IMException.Code INVALID_CON_TIMEOUT

INVALID_RESOLVE_TIMEOUT

public static final IMException.Code INVALID_RESOLVE_TIMEOUT

MESSAGE_TOO_LONG

public static final IMException.Code MESSAGE_TOO_LONG

INVALID_IM_SERVER_PORT

public static final IMException.Code INVALID_IM_SERVER_PORT

INVALID_IM_SERVICE_NAME

public static final IMException.Code INVALID_IM_SERVICE_NAME

NOT_IMPLEMENTED_YET

public static final IMException.Code NOT_IMPLEMENTED_YET

SERVER_EXCEPTION

public static final IMException.Code SERVER_EXCEPTION

Method Detail

values

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

Returns:

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

valueOf

public static IMException.Code valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null