Package com.alachisoft.ncache.runtime.caching

Enum MessageFailureReason

java.lang.Object

java.lang.Enum<MessageFailureReason>

com.alachisoft.ncache.runtime.caching.MessageFailureReason

public enum MessageFailureReason
extends java.lang.Enum<MessageFailureReason>

The reason for failed message delivery.

Enum Constant Summary

Enum Constants

Enum Constant	Description
Evicted	Failed, because it got evicted before delivery.
Expired	Failed, because it could not be delivered within expiration time.

Method Summary

Modifier and Type	Method	Description
static MessageFailureReason	forValue(int value)	Retrieves the enum constant of the specified value, if exists.
int	getValue()	Order is important in enums.
static MessageFailureReason	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static MessageFailureReason[]	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

Expired

public static final MessageFailureReason Expired

Failed, because it could not be delivered within expiration time.

Evicted

public static final MessageFailureReason Evicted

Failed, because it got evicted before delivery.

Method Detail

values

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

Returns:

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

valueOf

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

forValue

public static MessageFailureReason forValue(int value)

Retrieves the enum constant of the specified value, if exists.

Parameters:

value - Enum constant index.

Returns:

Enum constant.

getValue

public int getValue()

Order is important in enums. By using getValue() method, each enum constant index can be found, just like array index.

Returns:

Enum constant index.