Package com.alachisoft.ncache.runtime.cacheloader

Enum RefreshPreference

java.lang.Object

java.lang.Enum<RefreshPreference>

com.alachisoft.ncache.runtime.cacheloader.RefreshPreference

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

This enumeration allow a user to specify when to refresh the corresponding dataset. RefreshOnNextTimeOfDay to refresh the associate data next day.

Enum Constant Summary

Enum Constants

Enum Constant	Description
RefreshNow	Use this option if you need to refresh the dataset in current time.
RefreshOnNextTimeOfDay	Use this option to refresh the dataset on the next refresh interval.

Method Summary

Modifier and Type	Method	Description
static RefreshPreference	forValue(int value)	retreives the enum constant of the specified value, if exists.
int	getValue()	Order is important in enums.By using getValue() method, each enum constant index can be found, just like array index.
static RefreshPreference	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static RefreshPreference[]	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

RefreshNow

public static final RefreshPreference RefreshNow

Use this option if you need to refresh the dataset in current time.

RefreshOnNextTimeOfDay

public static final RefreshPreference RefreshOnNextTimeOfDay

Use this option to refresh the dataset on the next refresh interval.

Method Detail

values

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

Returns:

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

valueOf

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