org.infinispan.context
Enum Flag

java.lang.Object
  java.lang.Enum<Flag>
      org.infinispan.context.Flag

All Implemented Interfaces:

Serializable, Comparable<Flag>

public enum Flag
extends Enum<Flag>

Available flags, which may be set on a per-invocation basis. These are provided using the AdvancedCache interface, using some of the overloaded methods that allow passing in of a variable number of Flags.

• ZERO_LOCK_ACQUISITION_TIMEOUT - overrides the Configuration.setLockAcquisitionTimeout(long) configuration setting by ensuring lock managers use a 0 lock acquisition timeout.
• CACHE_MODE_LOCAL - forces local mode even if the cache is configured to use a clustered mode like replication, invalidation or distribution
• SKIP_LOCKING - bypasses lock acquisition altogether
• FORCE_WRITE_LOCK - forces a write lock, even if the call is a read. Useful when reading an entry to later update it within the same transaction
• SKIP_CACHE_STATUS_CHECK - skips checking whether a cache is in a receptive state, i.e. is ComponentStatus.RUNNING. May break operation in weird ways!
• FORCE_ASYNCHRONOUS - forces asynchronous network calls where possible
• FORCE_SYNCHRONOUS - forces synchronous network calls where possible
• SKIP_CACHE_STORE - skips storing an entry to any configured CacheStores
• FAIL_SILENTLY - swallows any exceptions, logging them instead at a low log level
• SKIP_REMOTE_LOOKUP - when used with DIST cache mode, will skip retrieving a remote value either when doing a get() or exists(), or to provide an overwritten value with a put() or remove(). This could render return values for some operations (such as Map.put(Object, Object) or Map.remove(Object) unusable.
• PUT_FOR_EXTERNAL_READ - flags the invocation as a Cache.putForExternalRead(Object, Object) call.

Since:

4.0

Author:

Manik Surtani, Galder Zamarreño

Enum Constant Summary

CACHE_MODE_LOCAL

FAIL_SILENTLY

FORCE_ASYNCHRONOUS

FORCE_SYNCHRONOUS

FORCE_WRITE_LOCK

PUT_FOR_EXTERNAL_READ

SKIP_CACHE_STATUS_CHECK

SKIP_CACHE_STORE

SKIP_LOCKING

SKIP_REMOTE_LOOKUP

ZERO_LOCK_ACQUISITION_TIMEOUT

Method Summary

static Flag	valueOf(String name) Returns the enum constant of this type with the specified name.
static Flag[]	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

ZERO_LOCK_ACQUISITION_TIMEOUT

public static final Flag ZERO_LOCK_ACQUISITION_TIMEOUT

CACHE_MODE_LOCAL

public static final Flag CACHE_MODE_LOCAL

SKIP_LOCKING

public static final Flag SKIP_LOCKING

FORCE_WRITE_LOCK

public static final Flag FORCE_WRITE_LOCK

SKIP_CACHE_STATUS_CHECK

public static final Flag SKIP_CACHE_STATUS_CHECK

FORCE_ASYNCHRONOUS

public static final Flag FORCE_ASYNCHRONOUS

FORCE_SYNCHRONOUS

public static final Flag FORCE_SYNCHRONOUS

SKIP_CACHE_STORE

public static final Flag SKIP_CACHE_STORE

FAIL_SILENTLY

public static final Flag FAIL_SILENTLY

SKIP_REMOTE_LOOKUP

public static final Flag SKIP_REMOTE_LOOKUP

PUT_FOR_EXTERNAL_READ

public static final Flag PUT_FOR_EXTERNAL_READ

Method Detail

values

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

Returns:

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

valueOf

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