Package com.alachisoft.ncache.runtime.caching.expiration

Enum ExpirationType

java.lang.Object

java.lang.Enum<ExpirationType>

com.alachisoft.ncache.runtime.caching.expiration.ExpirationType

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

The type of expiration to be used while expiring items in the cache. The value of this type varies from item to item in the cache.

Enum Constant Summary

Enum Constants

Enum Constant	Description
Absolute	Indicates that item expiration in the cache is to follow fixed expiration.
DefaultAbsolute	Indicates that item expiration in the cache is to follow fixed expiration and value should be taken from 'DefaultAbsolute' field in the NCache Manager.
DefaultAbsoluteLonger	Indicates that item expiration in the cache is to follow fixed expiration and value should be taken from 'DefaultAbsoluteLonger' field in the NCache Manager.
DefaultSliding	Indicates that item expiration in the cache is to follow fixed expiration and value should be taken from 'DefaultSliding' field in the NCache Manager.
DefaultSlidingLonger	Indicates that item expiration in cache is to follow fixed expiration and value should be taken from 'DefaultSlidingLonger' field in the NCache Manager.
None	Indicates that no expiration is to take place.
Sliding	Indicates that item expiration in the cache is to follow idle expiration.

Method Summary

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

None

public static final ExpirationType None

Indicates that no expiration is to take place.

Sliding

public static final ExpirationType Sliding

Indicates that item expiration in the cache is to follow idle expiration.

Absolute

public static final ExpirationType Absolute

Indicates that item expiration in the cache is to follow fixed expiration.

DefaultAbsolute

public static final ExpirationType DefaultAbsolute

Indicates that item expiration in the cache is to follow fixed expiration and value should be taken from 'DefaultAbsolute' field in the NCache Manager.

DefaultAbsoluteLonger

public static final ExpirationType DefaultAbsoluteLonger

Indicates that item expiration in the cache is to follow fixed expiration and value should be taken from 'DefaultAbsoluteLonger' field in the NCache Manager.

DefaultSliding

public static final ExpirationType DefaultSliding

Indicates that item expiration in the cache is to follow fixed expiration and value should be taken from 'DefaultSliding' field in the NCache Manager.

DefaultSlidingLonger

public static final ExpirationType DefaultSlidingLonger

Indicates that item expiration in cache is to follow fixed expiration and value should be taken from 'DefaultSlidingLonger' field in the NCache Manager.

Method Detail

values

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

Returns:

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

valueOf

public static ExpirationType 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 ExpirationType forValue(int value)

Retreives 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.