com.j_spaces.core.client
Class TakeModifiers

java.lang.Object
  com.j_spaces.core.client.TakeModifiers

public class TakeModifiers
extends Object

The TakeModifiers class provides static methods and constants to decode Take type modifiers. The sets of modifiers are represented as integers with distinct bit positions representing different modifiers.

These modifiers can be set only at the operation level (e.g. using one of IJSpace take/takeIfExists/takeMultiple/clear methods with a modifiers parameter )

Since:

8.0

Author:

Yechiel

Field Summary

static int	EVICT_ONLY A modifier passed to take/clear operations.
static int	FIFO Indicates the operation should comply with First-In-First-Out order.
static int	FIFO_GROUPING_POLL A modifier passed to take & read operations.
static int	IGNORE_PARTIAL_FAILURE A modifier passed to read multiple and take multiple operations.
static int	MEMORY_ONLY_SEARCH Search for matching entries in cache memory only (do not use the underlying EDS).

Method Summary

static boolean	isEvictOnly(int mod) Checks if the EVICT_ONLY bit was set for this modifier.
static boolean	isFifo(int mod) Checks if the FIFO bit was set for this modifier.
static boolean	isFifoGroupingPoll(int mod) Checks if the FIFO_GROUPING_POLL bit was set for this modifier.
static boolean	isIgnorePartialFailure(int mod) Checks if the IGNORE_PARTIAL_FAILURE bit was set for this modifier.
static boolean	isMemoryOnlySearch(int mod) Checks if the MEMORY_ONLY_SEARCH bit was set for this modifier.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EVICT_ONLY

public static final int EVICT_ONLY

A modifier passed to take/clear operations.
The modifier will cause the eviction of entries matching the given template from cache.
The entries will not be removed from the persistent layer.
Relevant for LRU cache policy only.
If a timeout parameter is specified it will be ignored with this modifier.

See Also:

Constant Field Values

IGNORE_PARTIAL_FAILURE

public static final int IGNORE_PARTIAL_FAILURE

A modifier passed to read multiple and take multiple operations. The modifier will cause partial results to be returned instead of throwing operation specific exception TakeMultipleException when not all of the requested number of entries are returned and one or more cluster members are not available.

See Also:

Constant Field Values

FIFO

public static final int FIFO

Indicates the operation should comply with First-In-First-Out order.

See Also:

Constant Field Values

FIFO_GROUPING_POLL

public static final int FIFO_GROUPING_POLL

A modifier passed to take & read operations. The modifier will cause a group fifo poll based on the passed template. The template must have a property marked with the SpaceFifoGroupingProperty

Since:

9.0.0

See Also:

Constant Field Values

MEMORY_ONLY_SEARCH

public static final int MEMORY_ONLY_SEARCH

Search for matching entries in cache memory only (do not use the underlying EDS).

Since:

9.0.1

See Also:

Constant Field Values

Method Detail

isEvictOnly

public static boolean isEvictOnly(int mod)

Checks if the EVICT_ONLY bit was set for this modifier.

Parameters:

mod - a set of modifiers

Returns:

true if mod includes the EVICT_ONLY bit is set.

isIgnorePartialFailure

public static boolean isIgnorePartialFailure(int mod)

Checks if the IGNORE_PARTIAL_FAILURE bit was set for this modifier.

Parameters:

mod - a set of modifiers

Returns:

true if mod includes the IGNORE_PARTIAL_FAILURE bit is set.

isFifo

public static boolean isFifo(int mod)

Checks if the FIFO bit was set for this modifier.

Parameters:

mod - a set of modifiers

Returns:

true if mod includes the MATCH_BY_UID modifier; false otherwise.

isFifoGroupingPoll

public static boolean isFifoGroupingPoll(int mod)

Checks if the FIFO_GROUPING_POLL bit was set for this modifier.

Parameters:

mod - a set of modifiers

Returns:

true if mod includes the FIFO_GROUPING_POLL modifier; false otherwise.

isMemoryOnlySearch

public static boolean isMemoryOnlySearch(int mod)

Checks if the MEMORY_ONLY_SEARCH bit was set for this modifier.

Parameters:

mod - a set of modifiers

Returns:

true if mod includes the MEMORY_ONLY_SEARCH modifier; false otherwise.

Since:

9.0.1