net.sf.ehcache.config

Enum TimeoutBehaviorConfiguration.TimeoutBehaviorType

java.lang.Object

java.lang.Enum<TimeoutBehaviorConfiguration.TimeoutBehaviorType>

net.sf.ehcache.config.TimeoutBehaviorConfiguration.TimeoutBehaviorType

All Implemented Interfaces:

Serializable, Comparable<TimeoutBehaviorConfiguration.TimeoutBehaviorType>

Enclosing class:

TimeoutBehaviorConfiguration

public static enum TimeoutBehaviorConfiguration.TimeoutBehaviorType
extends Enum<TimeoutBehaviorConfiguration.TimeoutBehaviorType>

Enum encapsulating type of TimeoutBehavior

Author:

Abhishek Sanoujam

Enum Constant Summary

Enum Constants

Enum Constant and Description
CUSTOM Timeout behavior type that uses a custom factory to create the actual timeout behavior on timeout.
EXCEPTION Timeout behavior type that throws exception on timeout
LOCAL_READS Timeout behavior type that returns local values present in the VM or otherwise null on timeout
NOOP Timeout behavior type that returns null and does nothing on timeout

Method Summary

Modifier and Type	Method and Description
abstract NonstopTimeoutBehaviorFactory	getTimeoutBehaviorFactory(Properties properties) Get the NonstopTimeoutBehaviorFactory for this type
static TimeoutBehaviorConfiguration.TimeoutBehaviorType	getTimeoutBehaviorTypeFromName(String typeName) Get the TimeoutBehaviorConfiguration.TimeoutBehaviorType corresponding to a name
abstract String	getTypeName() Returns a String signifying this type
static boolean	isValidTimeoutBehaviorType(String type) Find out if a string is a valid timeoutBehavior type or not
static TimeoutBehaviorConfiguration.TimeoutBehaviorType	valueOf(String name) Returns the enum constant of this type with the specified name.
static TimeoutBehaviorConfiguration.TimeoutBehaviorType[]	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

EXCEPTION

public static final TimeoutBehaviorConfiguration.TimeoutBehaviorType EXCEPTION

Timeout behavior type that throws exception on timeout

NOOP

public static final TimeoutBehaviorConfiguration.TimeoutBehaviorType NOOP

Timeout behavior type that returns null and does nothing on timeout

LOCAL_READS

public static final TimeoutBehaviorConfiguration.TimeoutBehaviorType LOCAL_READS

Timeout behavior type that returns local values present in the VM or otherwise null on timeout

CUSTOM

public static final TimeoutBehaviorConfiguration.TimeoutBehaviorType CUSTOM

Timeout behavior type that uses a custom factory to create the actual timeout behavior on timeout. The custom factory has to be configured using properties otherwise an exception will be thrown. There must be a property named TimeoutBehaviorConfiguration.CUSTOM_TYPE_FACTORY_PROPERTY_NAME whose value is the fully qualified name of a class that implements NonstopTimeoutBehaviorFactory having no-args constructor.

Method Detail

values

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

Returns:

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

valueOf

public static TimeoutBehaviorConfiguration.TimeoutBehaviorType 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

getTypeName

public abstract String getTypeName()

Returns a String signifying this type

Returns:

the string name for this type

getTimeoutBehaviorFactory

public abstract NonstopTimeoutBehaviorFactory getTimeoutBehaviorFactory(Properties properties)

Get the NonstopTimeoutBehaviorFactory for this type

Parameters:

properties - The configured properties

Returns:

the factory to create timeout behaviors for this type

isValidTimeoutBehaviorType

public static boolean isValidTimeoutBehaviorType(String type)

Find out if a string is a valid timeoutBehavior type or not

Parameters:

type - the string name

Returns:

true if its valid, otherwise false

getTimeoutBehaviorTypeFromName

public static TimeoutBehaviorConfiguration.TimeoutBehaviorType getTimeoutBehaviorTypeFromName(String typeName)

Get the TimeoutBehaviorConfiguration.TimeoutBehaviorType corresponding to a name

Parameters:

typeName - the type name

Returns:

the TimeoutBehaviorConfiguration.TimeoutBehaviorType