org.infinispan.configuration.cache

Enum CacheMode

java.lang.Object

java.lang.Enum<CacheMode>

org.infinispan.configuration.cache.CacheMode

All Implemented Interfaces:

Serializable, Comparable<CacheMode>

public enum CacheMode
extends Enum<CacheMode>

Cache replication mode.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DIST_ASYNC Async DIST
DIST_SYNC Synchronous DIST
INVALIDATION_ASYNC Data invalidated asynchronously.
INVALIDATION_SYNC Data invalidated synchronously.
LOCAL Data is not replicated.
REPL_ASYNC Data replicated asynchronously.
REPL_SYNC Data replicated synchronously.
SCATTERED_SYNC Synchronous scattered cache

Method Summary

Modifier and Type	Method and Description
String	friendlyCacheModeString()
static CacheMode	fromParts(String distribution, String synchronicity)
boolean	isClustered()
boolean	isDistributed()
boolean	isInvalidation() Returns true if the mode is invalidation, either sync or async.
boolean	isReplicated()
boolean	isScattered()
boolean	isSynchronous()
static boolean	isValidCacheMode(String serializedCacheMode)
boolean	needsStateTransfer()
CacheMode	toAsync()
String	toCacheType()
CacheMode	toSync()
CacheMode	toSync(boolean sync)
static CacheMode	valueOf(int order)
static CacheMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static CacheMode[]	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

LOCAL

@ProtoEnumValue(number=0)
public static final CacheMode LOCAL

Data is not replicated.

REPL_SYNC

@ProtoEnumValue(number=1)
public static final CacheMode REPL_SYNC

Data replicated synchronously.

REPL_ASYNC

@ProtoEnumValue(number=2)
public static final CacheMode REPL_ASYNC

Data replicated asynchronously.

INVALIDATION_SYNC

@ProtoEnumValue(number=3)
public static final CacheMode INVALIDATION_SYNC

Data invalidated synchronously.

INVALIDATION_ASYNC

@ProtoEnumValue(number=4)
public static final CacheMode INVALIDATION_ASYNC

Data invalidated asynchronously.

DIST_SYNC

@ProtoEnumValue(number=5)
public static final CacheMode DIST_SYNC

Synchronous DIST

DIST_ASYNC

@ProtoEnumValue(number=6)
public static final CacheMode DIST_ASYNC

Async DIST

SCATTERED_SYNC

@ProtoEnumValue(number=7)
public static final CacheMode SCATTERED_SYNC

Synchronous scattered cache

Method Detail

values

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

Returns:

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

valueOf

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

valueOf

public static CacheMode valueOf(int order)

isInvalidation

public boolean isInvalidation()

Returns true if the mode is invalidation, either sync or async.

isSynchronous

public boolean isSynchronous()

isClustered

public boolean isClustered()

isDistributed

public boolean isDistributed()

isReplicated

public boolean isReplicated()

isScattered

public boolean isScattered()

needsStateTransfer

public boolean needsStateTransfer()

toSync

public CacheMode toSync()

toSync

public CacheMode toSync(boolean sync)

toAsync

public CacheMode toAsync()

friendlyCacheModeString

public String friendlyCacheModeString()

toCacheType

public String toCacheType()

isValidCacheMode

public static boolean isValidCacheMode(String serializedCacheMode)

fromParts

public static CacheMode fromParts(String distribution,
                                  String synchronicity)