Modifiers (GigaSpaces 16.2.1 API)

java.lang.Object
- com.j_spaces.core.client.Modifiers

```
public class Modifiers
extends Object
```
The Modifier class provides static methods and constants to decode available GigaSpaces types modifiers. The sets of modifiers are represented as integers with distinct bit positions representing different modifiers.

Since:

5.1

Version:

1.0

Author:

Igor Goldenberg

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BACKUP_ONLY` Internal API Determines if an update operation should be replicated only to backup (only write and take supported, only write and clear tested) used in horizontal scale feature
`static int`	`DIRTY_READ` If set, the Dirty read option allows you to retrieve the latest state of the object before it has been committed.
`static int`	`DRY_RUN` Allows the query to fill the Explain plan without returning results and scanning the indexes
`static int`	`EVICT_ONLY` A modifier passed to take operations.
`static int`	`EXCLUSIVE_READ_LOCK` Provides an Exclusive Read lock.
`static int`	`EXPLAIN_PLAN` Determines if an update operation notification should return the previous entry.
`static int`	`FIFO` An internal usage to get indication whether the desired operation represents FIFO.
`static int`	`FIFO_GROUPING_POLL` A modifier passed to take & read operations.
`static int`	`IF_EXISTS` Read any matching object from the space, returning `null` if there currently is none.
`static int`	`IGNORE_PARTIAL_FAILURE` A modifier passed to read multiple and take multiple operations.
`static int`	`LOG_SCANNED_ENTRIES_COUNT`
`static int`	`MATCH_BY_ID` The `int` value required matching to be done only by UID if provided (not in POJO) modifier.
`static int`	`MEMORY_ONLY_SEARCH` Search for proper entries in cache memory only (dont use the underlying EDS).
`static int`	`NO_RETURN_VALUE` Deprecated. Since 9.0.0
`static int`	`NO_WRITE_LEASE` Deprecated.
`static int`	`NONE` This modifier represents NONE modifier without any bit flag.
`static int`	`ONE_WAY` This modifier is relevant only for remote space.
`static int`	`OVERRIDE_VERSION` For internal use.
`static int`	`PARTIAL_UPDATE` If set, null values in the updated entry are treated as "leave as it is".
`static int`	`READ_COMMITTED` If set, provides read_committed isolation per the SPECIFIC read operation read_committed can also set , in the traditional way, per created transactions using the proxy level setTransactionIsolationLevel() API effected operations: Operations: Read, readIfExists, readMultiple
`static int`	`RESERVED_EXTERNALIZABLE_TRANSPORT` An indication whether the desired operation received from `java.io.Externalizable` operations.
`static int`	`RESERVED_RETURN_ONLY_UID` If set, The match Collection will contain an instance of Entry UID of read or take operations.
`static int`	`RETURN_DETAILED_CHANGE_RESULT` Determines if a change operation should return detailed results.
`static int`	`RETURN_DOCUMENT_PROPERTIES` Internal property.
`static int`	`RETURN_PREV_ON_UPDATE` Determines if an update operation should return the previous entry in the lease.
`static int`	`RETURN_PREV_ON_UPDATE_NOTIFY` Determines if an update operation notification should return the previous entry.
`static int`	`RETURN_STRING_PROPERTIES` Internal property.
`static int`	`RUN_ON_IO_THREAD` Indicates operation should run directly on i/o thread, instead of being submitted to the operations thread pool.
`static int`	`THROW_PARTIAL_FAILURE` Deprecated. This is the default behavior, for old behavior use `IGNORE_PARTIAL_FAILURE`
`static int`	`UPDATE` If set, performs a regular update operation.
`static int`	`UPDATE_OR_WRITE` The `int` value representing the `UPDATE_OR_WRITE` modifier.
`static int`	`WRITE` Performs a regular write operation.

Constructor Summary

Constructors
Constructor and Description

Modifiers()

Constructors
Constructor and Description
`Modifiers()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`add(int modifiers, int setting)`
`static boolean`	`contains(int modifiers, int setting)`
`static int`	`remove(int modifiers, int setting)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NONE
```
public static final int NONE
```
    This modifier represents NONE modifier without any bit flag.
    
    See Also:
    
    Constant Field Values
  - ONE_WAY
```
public static final int ONE_WAY
```
    This modifier is relevant only for remote space. If set, using this modifier the client side will not be blocked while space' operation will be processed. The client thread will be released right away when the method request-call is transfered to the server. Notice: The return value is always null. Operations: Any
    
    See Also:
    
    Constant Field Values
  - NO_RETURN_VALUE
```
@Deprecated
public static final int NO_RETURN_VALUE
```
    Deprecated. Since 9.0.0
    
    If set, the write or update operations will return null instead of the lease object (write) or previous value (update). Using this option will improve application write operation performance - null return value yields less network traffic and less memory consumption. Note: This modifier does not replace ONE_WAY modifier
    
    See Also:
    
    Constant Field Values
  - WRITE
```
public static final int WRITE
```
    Performs a regular write operation. Operations: Write
    
    See Also:
    
    Constant Field Values
  - UPDATE
```
public static final int UPDATE
```
    If set, performs a regular update operation. In case the Entry UID doesn't exists in the space use the following modifier combination: UPDATE | WRITE | update the entry if exists or write if absent. Operations: Update
    
    See Also:
    
    Constant Field Values
  - PARTIAL_UPDATE
```
public static final int PARTIAL_UPDATE
```
    If set, null values in the updated entry are treated as "leave as it is". Operations: Update
    
    See Also:
    
    Constant Field Values
  - DIRTY_READ
```
public static final int DIRTY_READ
```
    If set, the Dirty read option allows you to retrieve the latest state of the object before it has been committed. Operations: Read, Take, Update
    
    See Also:
    
    Constant Field Values
  - RUN_ON_IO_THREAD
```
public static final int RUN_ON_IO_THREAD
```
    Indicates operation should run directly on i/o thread, instead of being submitted to the operations thread pool. This is useful for short, non-blocking operations (e.g. readById), but risky for long or non-blocking operations. NOTE: This is an experimental API, subject to breaking changes in future releases.
    
    Since:
    
    16.0
    
    See Also:
    
    Constant Field Values
  - RESERVED_RETURN_ONLY_UID
```
public static final int RESERVED_RETURN_ONLY_UID
```
    If set, The match Collection will contain an instance of Entry UID of read or take operations. If set for write operation, the return value will be the written UID and not the Lease instance. Operations: Write, Read, Take
    
    See Also:
    
    Constant Field Values
  - IF_EXISTS
```
public static final int IF_EXISTS
```
    Read any matching object from the space, returning null if there currently is none. Matching and timeouts are done as in read, except that blocking in this call is done only if necessary to wait for transactional state to settle. Operations: Read, Take
    
    Since:
    
    10.0
    
    See Also:
    
    Constant Field Values
  - EXCLUSIVE_READ_LOCK
```
public static final int EXCLUSIVE_READ_LOCK
```
    Provides an Exclusive Read lock.
    
    See Also:
    
    Constant Field Values
  - RESERVED_EXTERNALIZABLE_TRANSPORT
```
public static final int RESERVED_EXTERNALIZABLE_TRANSPORT
```
    An indication whether the desired operation received from java.io.Externalizable operations. Operations: Any
    
    See Also:
    
    Constant Field Values
  - FIFO
```
public static final int FIFO
```
    An internal usage to get indication whether the desired operation represents FIFO. Operations: Any
    
    See Also:
    
    Constant Field Values
  - UPDATE_OR_WRITE
```
public static final int UPDATE_OR_WRITE
```
    The int value representing the UPDATE_OR_WRITE modifier. When set: if the entry to be updated does not reside in the space, a new entry is written
    
    See Also:
    
    Constant Field Values
  - READ_COMMITTED
```
public static final int READ_COMMITTED
```
    If set, provides read_committed isolation per the SPECIFIC read operation read_committed can also set , in the traditional way, per created transactions using the proxy level setTransactionIsolationLevel() API effected operations: Operations: Read, readIfExists, readMultiple
    
    See Also:
    
    Constant Field Values
  - MATCH_BY_ID
```
public static final int MATCH_BY_ID
```
    The int value required matching to be done only by UID if provided (not in POJO) modifier.
    
    See Also:
    
    Constant Field Values
  - THROW_PARTIAL_FAILURE
```
@Deprecated
public static final int THROW_PARTIAL_FAILURE
```
    Deprecated. This is the default behavior, for old behavior use IGNORE_PARTIAL_FAILURE
    
    A modifier passed to read multiple and take multiple operations. The modifier will cause an operation specific exception ReadMultipleException,TakeMultipleException to be thrown 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
  - 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 ReadMultipleException,TakeMultipleException when not all of the requested number of entries are returned and one or more cluster members are not available.
    
    Since:
    
    7.1
    
    See Also:
    
    Constant Field Values
  - EVICT_ONLY
```
public static final int EVICT_ONLY
```
    A modifier passed to take operations. The modifier will cause eviction from cache of the selected entries- relevant for LRU cache policy only
    
    Since:
    
    8.0
    
    See Also:
    
    Constant Field Values
  - NO_WRITE_LEASE
```
@Deprecated
public static final int NO_WRITE_LEASE
```
    Deprecated.
    
    Deprecated since 9.0.0.
    
    See Also:
    
    Constant Field Values
  - OVERRIDE_VERSION
```
public static final int OVERRIDE_VERSION
```
    For internal use.
    
    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
  - RETURN_STRING_PROPERTIES
```
public static final int RETURN_STRING_PROPERTIES
```
    Internal property. Used mostly by the data console to fetch data without loading the data classes.
    
    Since:
    
    9.0.0
    
    See Also:
    
    Constant Field Values
  - RETURN_DOCUMENT_PROPERTIES
```
public static final int RETURN_DOCUMENT_PROPERTIES
```
    Internal property. Used mostly by the data console to fetch data as SpaceDocument, without loading the data classes.
    
    Since:
    
    9.0.0
    
    See Also:
    
    Constant Field Values
  - RETURN_PREV_ON_UPDATE
```
public static final int RETURN_PREV_ON_UPDATE
```
    Determines if an update operation should return the previous entry in the lease.
    
    Since:
    
    9.0.1
    
    See Also:
    
    Constant Field Values
  - MEMORY_ONLY_SEARCH
```
public static final int MEMORY_ONLY_SEARCH
```
    Search for proper entries in cache memory only (dont use the underlying EDS).
    
    Since:
    
    9.0.1
    
    See Also:
    
    Constant Field Values
  - RETURN_DETAILED_CHANGE_RESULT
```
public static final int RETURN_DETAILED_CHANGE_RESULT
```
    Determines if a change operation should return detailed results.
    
    Since:
    
    9.1
    
    See Also:
    
    Constant Field Values
  - LOG_SCANNED_ENTRIES_COUNT
```
public static final int LOG_SCANNED_ENTRIES_COUNT
```
    See Also:
    
    Constant Field Values
  - RETURN_PREV_ON_UPDATE_NOTIFY
```
public static final int RETURN_PREV_ON_UPDATE_NOTIFY
```
    Determines if an update operation notification should return the previous entry.
    
    Since:
    
    10.1
    
    See Also:
    
    Constant Field Values
  - EXPLAIN_PLAN
```
public static final int EXPLAIN_PLAN
```
    Determines if an update operation notification should return the previous entry.
    
    Since:
    
    12.0.1
    
    See Also:
    
    Constant Field Values
  - BACKUP_ONLY
```
public static final int BACKUP_ONLY
```
    Internal API Determines if an update operation should be replicated only to backup (only write and take supported, only write and clear tested) used in horizontal scale feature
    
    Since:
    
    15.5.0
    
    See Also:
    
    Constant Field Values
  - DRY_RUN
```
public static final int DRY_RUN
```
    Allows the query to fill the Explain plan without returning results and scanning the indexes
    
    Since:
    
    16.0
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Modifiers
```
public Modifiers()
```
- Method Detail
  - contains
```
public static boolean contains(int modifiers,
                               int setting)
```
  - add
```
public static int add(int modifiers,
                      int setting)
```
  - remove
```
public static int remove(int modifiers,
                         int setting)
```

Class Modifiers

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NONE

ONE_WAY

NO_RETURN_VALUE

WRITE

UPDATE

PARTIAL_UPDATE

DIRTY_READ

RUN_ON_IO_THREAD

RESERVED_RETURN_ONLY_UID

IF_EXISTS

EXCLUSIVE_READ_LOCK

RESERVED_EXTERNALIZABLE_TRANSPORT

FIFO

UPDATE_OR_WRITE

READ_COMMITTED

MATCH_BY_ID

THROW_PARTIAL_FAILURE

IGNORE_PARTIAL_FAILURE

EVICT_ONLY

NO_WRITE_LEASE

OVERRIDE_VERSION

FIFO_GROUPING_POLL

RETURN_STRING_PROPERTIES

RETURN_DOCUMENT_PROPERTIES

RETURN_PREV_ON_UPDATE

MEMORY_ONLY_SEARCH

RETURN_DETAILED_CHANGE_RESULT

LOG_SCANNED_ENTRIES_COUNT

RETURN_PREV_ON_UPDATE_NOTIFY

EXPLAIN_PLAN

BACKUP_ONLY

DRY_RUN

Constructor Detail

Modifiers

Method Detail

contains

add

remove