GigaSpaces XAP 9.7.2 API

com.gigaspaces.client
Class ClearModifiers

java.lang.Object
  extended by com.gigaspaces.client.SpaceProxyOperationModifiers
      extended by com.gigaspaces.client.ClearModifiers
All Implemented Interfaces:
Externalizable, Serializable

public class ClearModifiers
extends SpaceProxyOperationModifiers

Provides modifiers to customize the behavior of clear operations.

Since:
9.0.1
Author:
Niv Ingberg
See Also:
Serialized Form

Field Summary
static ClearModifiers EVICT_ONLY
          Remove matching entries from memory only (do not remove from the underlying EDS).
static ClearModifiers MEMORY_ONLY_SEARCH
          Search for matching entries in cache memory only (do not use the underlying EDS).
static ClearModifiers NONE
          Empty - use operation default behavior.
 
Constructor Summary
ClearModifiers()
           
ClearModifiers(ClearModifiers... modifiers)
          Creates a new modifiers from the specified modifiers.
ClearModifiers(ClearModifiers modifiers1, ClearModifiers modifiers2)
          Creates a new modifiers from the specified modifiers.
ClearModifiers(ClearModifiers modifiers1, ClearModifiers modifiers2, ClearModifiers modifiers3)
          Creates a new modifiers from the specified modifiers.
 
Method Summary
 ClearModifiers add(ClearModifiers modifiers)
          Creates a new modifiers instance which is a union of the specified modifiers and this instance.
 boolean contains(ClearModifiers modifiers)
          Checks if the specified modifier is set.
protected  ClearModifiers create(int modifiers)
           
protected  Map<Integer,SpaceProxyOperationModifiers> getCache()
           
 boolean isEvictOnly()
          Checks if this instance contains the EVICT_ONLY setting.
 boolean isMemoryOnlySearch()
          Checks if this instance contains the MEMORY_ONLY_SEARCH setting.
 ClearModifiers remove(ClearModifiers 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 ClearModifiers NONE
Empty - use operation default behavior.


EVICT_ONLY

public static final ClearModifiers EVICT_ONLY
Remove matching entries from memory only (do not remove from the underlying EDS). Ignored if there's no underlying EDS or if the caching policy is ALL_IN_CACHE.


MEMORY_ONLY_SEARCH

public static final ClearModifiers MEMORY_ONLY_SEARCH
Search for matching entries in cache memory only (do not use the underlying EDS).

Constructor Detail

ClearModifiers

public ClearModifiers()

ClearModifiers

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

Parameters:
modifiers1 -
modifiers2 -

ClearModifiers

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

Parameters:
modifiers1 -
modifiers2 -
modifiers3 -

ClearModifiers

public ClearModifiers(ClearModifiers... modifiers)
Creates a new modifiers from the specified modifiers.

Parameters:
modifiers -
Method Detail

contains

public boolean contains(ClearModifiers modifiers)
Checks if the specified modifier is set.

Parameters:
modifiers -
Returns:
true if the specified modifier is set, false otherwise.

add

public ClearModifiers add(ClearModifiers 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 ClearModifiers remove(ClearModifiers 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.

isEvictOnly

public boolean isEvictOnly()
Checks if this instance contains the EVICT_ONLY setting.

Returns:
true if this instance contains the EVICT_ONLY setting, false otherwise.

isMemoryOnlySearch

public boolean isMemoryOnlySearch()
Checks if this instance contains the MEMORY_ONLY_SEARCH setting.

Returns:
true if this instance contains the MEMORY_ONLY_SEARCH setting, false otherwise.

create

protected ClearModifiers create(int modifiers)
Specified by:
create in class SpaceProxyOperationModifiers

getCache

protected Map<Integer,SpaceProxyOperationModifiers> getCache()
Specified by:
getCache in class SpaceProxyOperationModifiers

GigaSpaces XAP 9.7.2 API

Copyright © GigaSpaces.