org.gridgain.grid.cache

Enum GridCachePreloadMode

java.lang.Object

java.lang.Enum<GridCachePreloadMode>

org.gridgain.grid.cache.GridCachePreloadMode

All Implemented Interfaces:

Serializable, Comparable<GridCachePreloadMode>

public enum GridCachePreloadMode
extends Enum<GridCachePreloadMode>

Cache preload mode. When preloading is enabled (i.e. has value other than NONE), distributed caches will attempt to preload all necessary values from other grid nodes. This enumeration is used to configure preloading via GridCacheConfiguration.getPreloadMode() configuration property. If not configured explicitly, then GridCacheConfiguration.DFLT_PRELOAD_MODE is used.

Replicated caches will try to load the full set of cache entries from other nodes (or as defined by pluggable GridCacheAffinityFunction), while partitioned caches will only load the entries for which current node is primary or back up.

Note that preload mode only makes sense for GridCacheMode.REPLICATED and GridCacheMode.PARTITIONED caches. Caches with GridCacheMode.LOCAL mode are local by definition and therefore cannot preload any values from neighboring nodes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASYNC Asynchronous preload mode.
NONE In this mode no preloading will take place which means that caches will be either loaded on demand from persistent store whenever data is accessed, or will be populated explicitly.
SYNC Synchronous preload mode.

Method Summary

Methods

Modifier and Type	Method and Description
static GridCachePreloadMode	fromOrdinal(int ord) Efficiently gets enumerated value from its ordinal.
static GridCachePreloadMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static GridCachePreloadMode[]	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

SYNC

public static final GridCachePreloadMode SYNC

Synchronous preload mode. Distributed caches will not start until all necessary data is loaded from other available grid nodes.

ASYNC

public static final GridCachePreloadMode ASYNC

Asynchronous preload mode. Distributed caches will start immediately and will load all necessary data from other available grid nodes in the background.

NONE

public static final GridCachePreloadMode NONE

In this mode no preloading will take place which means that caches will be either loaded on demand from persistent store whenever data is accessed, or will be populated explicitly.

Method Detail

values

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

Returns:

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

valueOf

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

fromOrdinal

@Nullable
public static GridCachePreloadMode fromOrdinal(int ord)

Efficiently gets enumerated value from its ordinal.

Parameters:

ord - Ordinal value.

Returns:

Enumerated value or null if ordinal out of range.