com.gigaspaces.client
Class ChangeModifiers

java.lang.Object
  com.gigaspaces.client.SpaceProxyOperationModifiers
      com.gigaspaces.client.ChangeModifiers

All Implemented Interfaces:

Externalizable, Serializable

public class ChangeModifiers
extends SpaceProxyOperationModifiers

Provides modifiers to customize the behavior of change operations.

Since:

9.1

Author:

Niv Ingberg

See Also:

Serialized Form

Field Summary

static ChangeModifiers	MEMORY_ONLY_SEARCH Search for matching entries in cache memory only (do not use the underlying external data source).
static ChangeModifiers	NONE Empty - use operation default behavior.
static ChangeModifiers	ONE_WAY Operation is executed in one way mode, meaning no return value will be provided.
static ChangeModifiers	RETURN_DETAILED_RESULTS Return details results meaning the ChangeResult.getResults() should contain data, otherwise only the number of changed entries will be returned as a result which can be accessed via the ChangeResult.getNumberOfChangedEntries().

Constructor Summary

ChangeModifiers()

ChangeModifiers(ChangeModifiers... modifiers)
Creates a new modifiers from the specified modifiers.

ChangeModifiers(ChangeModifiers modifiers1, ChangeModifiers modifiers2)
Creates a new modifiers from the specified modifiers.

ChangeModifiers(ChangeModifiers modifiers1, ChangeModifiers modifiers2, ChangeModifiers modifiers3)
Creates a new modifiers from the specified modifiers.

Method Summary

ChangeModifiers	add(ChangeModifiers modifiers) Creates a new modifiers instance which is a union of the specified modifiers and this instance.
boolean	contains(ChangeModifiers modifiers) Checks if the specified modifier is set.
protected ChangeModifiers	create(int modifiers)
protected Map<Integer,SpaceProxyOperationModifiers>	getCache()
ChangeModifiers	remove(ChangeModifiers modifiers) Creates a new modifiers instance which excludes the specified modifiers from this instance.

Methods inherited from class com.gigaspaces.client.SpaceProxyOperationModifiers

add, contains, createIfNeeded, equals, getCode, hashCode, readExternal, remove, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final ChangeModifiers NONE

Empty - use operation default behavior.

ONE_WAY

public static final ChangeModifiers ONE_WAY

Operation is executed in one way mode, meaning no return value will be provided. Using this mode provides no guarantee whether the operation succeeded or not, the only guarantee is that the operation was successfully written to the local network buffer. As a result, using this modifier will cause the operation not to guarantee automatic fail-over if the primary space instance failed, and it cannot be done under a transaction.

MEMORY_ONLY_SEARCH

public static final ChangeModifiers MEMORY_ONLY_SEARCH

Search for matching entries in cache memory only (do not use the underlying external data source). However, any changes done on the matches entries will propagate to the underlying external data source.

RETURN_DETAILED_RESULTS

public static final ChangeModifiers RETURN_DETAILED_RESULTS

Return details results meaning the ChangeResult.getResults() should contain data, otherwise only the number of changed entries will be returned as a result which can be accessed via the ChangeResult.getNumberOfChangedEntries().

Constructor Detail

ChangeModifiers

public ChangeModifiers()

ChangeModifiers

public ChangeModifiers(ChangeModifiers modifiers1,
                       ChangeModifiers modifiers2)

Creates a new modifiers from the specified modifiers.

Parameters:

modifiers1 -

modifiers2 -

ChangeModifiers

public ChangeModifiers(ChangeModifiers modifiers1,
                       ChangeModifiers modifiers2,
                       ChangeModifiers modifiers3)

Creates a new modifiers from the specified modifiers.

Parameters:

modifiers1 -

modifiers2 -

modifiers3 -

ChangeModifiers

public ChangeModifiers(ChangeModifiers... modifiers)

Creates a new modifiers from the specified modifiers.

Parameters:

modifiers -

Method Detail

contains

public boolean contains(ChangeModifiers modifiers)

Checks if the specified modifier is set.

Parameters:

modifiers -

Returns:

true if the specified modifier is set, false otherwise.

add

public ChangeModifiers add(ChangeModifiers modifiers)

Creates a new modifiers instance which is a union of the specified modifiers and this instance.

Parameters:

modifiers - Modifiers to add.

Returns:

A union of the current modifiers and the specified modifiers.

remove

public ChangeModifiers remove(ChangeModifiers modifiers)

Creates a new modifiers instance which excludes the specified modifiers from this instance.

Parameters:

modifiers - Modifiers to remove.

Returns:

The modifiers from this instance without the modifiers from the specified instance.

create

protected ChangeModifiers create(int modifiers)

Specified by:

create in class SpaceProxyOperationModifiers

getCache

protected Map<Integer,SpaceProxyOperationModifiers> getCache()

Specified by:

getCache in class SpaceProxyOperationModifiers