Operation (GemFire XD Java API Documentation)

java.lang.Object
- tx.Operation

All Implemented Interfaces:

java.io.Serializable
```
public class Operation
extends java.lang.Object
implements java.io.Serializable
```
A class that holds information about an operation on a region or entry, which indicates the current transactional state.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CACHE_CLOSE`
`static java.util.List`	`clientRepeatableReadOps`
`static java.lang.String`	`ENTRY_CONTAINS_KEY`
`static java.lang.String`	`ENTRY_CONTAINS_VALUE`
`static java.lang.String`	`ENTRY_CONTAINS_VALUE_FOR_KEY`
`static java.lang.String`	`ENTRY_CREATE`
`static java.lang.String`	`ENTRY_DESTROY`
`static java.lang.String`	`ENTRY_GET_ENTRY_EXIST_KEY`
`static java.lang.String`	`ENTRY_GET_EXIST_KEY`
`static java.lang.String`	`ENTRY_GET_NEW_KEY`
`static java.lang.String`	`ENTRY_GET_PREV_KEY`
`static java.lang.String`	`ENTRY_GETALL`
`static java.lang.String`	`ENTRY_INVAL`
`static java.lang.String`	`ENTRY_LOCAL_DESTROY`
`static java.lang.String`	`ENTRY_LOCAL_INVAL`
`static java.lang.String`	`ENTRY_PUTALL`
`static java.lang.String`	`ENTRY_REMOVE`
`static java.lang.String`	`ENTRY_UPDATE`
`static java.util.List`	`nonrepeatableReadOps`
`static java.lang.String`	`REGION_CREATE`
`static java.lang.String`	`REGION_DESTROY`
`static java.lang.String`	`REGION_ENTRIES`
`static java.lang.String`	`REGION_ENTRY_SET`
`static java.lang.String`	`REGION_INVAL`
`static java.lang.String`	`REGION_KEY_SET`
`static java.lang.String`	`REGION_KEYS`
`static java.lang.String`	`REGION_LOCAL_DESTROY`
`static java.lang.String`	`REGION_LOCAL_INVAL`
`static java.lang.String`	`REGION_VALUES`
`static java.util.List`	`repeatableReadOps`

Constructor Summary

Constructors
Constructor and Description
`Operation(java.lang.String regionName, java.lang.Object key, java.lang.String opName, java.lang.Object oldValue, java.lang.Object newValue)` Constructor to create an operation: By default, repeatable read is false.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`affectedBy(Operation op)`
`boolean`	`entryOpAffectedBy(Operation op)`
`boolean`	`equals(java.lang.Object anObj)` Returns true if the argument equals the receiver, false otherwise
`boolean`	`equalsEventOp(java.lang.Object anObj)` Returns true if the argument equals the receiver, false otherwise Differs from equals() in that the original operation may have an oldValue or newValue of INVALID which must appear equal to the event's oldValue/newValue == null.
`java.lang.Object`	`getKey()` Get the key for the operation
`java.lang.Object`	`getNewValue()` Get the new value
`java.lang.Object`	`getOldValue()` Get the old value
`java.lang.String`	`getOpName()` Get the operation name
`java.lang.String`	`getRegionName()` Get the region name for the operation
`boolean`	`isDoubleInvalidate()` Returns true if the operation is the result of two invalidates (which implies the 2nd invalidate is a noop), false otherwise.
`boolean`	`isEntryCreate()` Returns true if the operation is an entryCreate operation, false otherwise.
`boolean`	`isEntryDestroy()` Returns true if the operation is an entryDestroy or entryLocalDestroy operation, false otherwise.
`boolean`	`isEntryGet()` Returns true if the operation is a any type of get (Existing, Prev, New) operation, false otherwise.
`boolean`	`isEntryInvalidate()` Returns true if the operation is an entryInval or entryLocalInval operation, false otherwise.
`boolean`	`isEntryOperation()` Returns true if the operation is an entry operation, false otherwise.
`boolean`	`isEntryUpdate()` Returns true if the operation is an entryInval or entryLocalInval operation, false otherwise.
`boolean`	`isGetOperation()` Returns true if the operation is a get operation, false otherwise.
`boolean`	`isGetWithLoad()` Returns true if the operation is a get and oldValue was null or invalid, false otherwise.
`boolean`	`isInvalidate()` Returns true if the operation is an entry operation, false otherwise.
`boolean`	`isLocalOperation()` Returns true if the operation is a local operation, false otherwise.
`boolean`	`isPreviouslyInvalid()` Returns true if the operation's oldValue is any form of invalid
`boolean`	`isRegionCreate()` Returns true if the operation is a regionCreate operation, false otherwise.
`boolean`	`isRegionDestroy()` Returns true if the operation is a regionDestroy or regionLocalDestroy operation, false otherwise.
`boolean`	`isRegionInvalidate()` Returns true if the operation is a regionInval or regionLocalInval operation, false otherwise.
`boolean`	`isRegionOperation()` Returns true if the operation is a region operation, false otherwise.
`boolean`	`isRegionSetOperation()` Returns true if the operation is an operation that involves the entire region keys and/or values as a set.
`boolean`	`isRepeatableRead()` Returns true if the operation is a write operation, false otherwise
`boolean`	`isWriteOperation()` Returns true if the operation is a write operation, false otherwise
`void`	`setNewValue(java.lang.Object newValue)` Set the new value
`void`	`setOldValue(java.lang.Object oldValue)` Set the old value
`void`	`setOpName(java.lang.String opName)` Set the operation name
`void`	`setRepeatableRead(boolean abool)` Set the repeatable read value
`java.lang.String`	`toString()` Return a string description of the operation
`boolean`	`usesSameRegion(Operation anOp)` Returns true if the operation uses the same region as anOp.
`boolean`	`usesSameRegionAndKey(Operation anOp)` Returns true if the operation uses the same region and key as anOp.

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

- Field Detail
  - ENTRY_CREATE
```
public static final java.lang.String ENTRY_CREATE
```
    See Also:
    
    Constant Field Values
  - ENTRY_UPDATE
```
public static final java.lang.String ENTRY_UPDATE
```
    See Also:
    
    Constant Field Values
  - ENTRY_PUTALL
```
public static final java.lang.String ENTRY_PUTALL
```
    See Also:
    
    Constant Field Values
  - ENTRY_DESTROY
```
public static final java.lang.String ENTRY_DESTROY
```
    See Also:
    
    Constant Field Values
  - ENTRY_LOCAL_DESTROY
```
public static final java.lang.String ENTRY_LOCAL_DESTROY
```
    See Also:
    
    Constant Field Values
  - ENTRY_INVAL
```
public static final java.lang.String ENTRY_INVAL
```
    See Also:
    
    Constant Field Values
  - ENTRY_LOCAL_INVAL
```
public static final java.lang.String ENTRY_LOCAL_INVAL
```
    See Also:
    
    Constant Field Values
  - ENTRY_GET_NEW_KEY
```
public static final java.lang.String ENTRY_GET_NEW_KEY
```
    See Also:
    
    Constant Field Values
  - ENTRY_GET_EXIST_KEY
```
public static final java.lang.String ENTRY_GET_EXIST_KEY
```
    See Also:
    
    Constant Field Values
  - ENTRY_GET_PREV_KEY
```
public static final java.lang.String ENTRY_GET_PREV_KEY
```
    See Also:
    
    Constant Field Values
  - ENTRY_GET_ENTRY_EXIST_KEY
```
public static final java.lang.String ENTRY_GET_ENTRY_EXIST_KEY
```
    See Also:
    
    Constant Field Values
  - ENTRY_GETALL
```
public static final java.lang.String ENTRY_GETALL
```
    See Also:
    
    Constant Field Values
  - ENTRY_CONTAINS_KEY
```
public static final java.lang.String ENTRY_CONTAINS_KEY
```
    See Also:
    
    Constant Field Values
  - ENTRY_CONTAINS_VALUE_FOR_KEY
```
public static final java.lang.String ENTRY_CONTAINS_VALUE_FOR_KEY
```
    See Also:
    
    Constant Field Values
  - ENTRY_CONTAINS_VALUE
```
public static final java.lang.String ENTRY_CONTAINS_VALUE
```
    See Also:
    
    Constant Field Values
  - ENTRY_REMOVE
```
public static final java.lang.String ENTRY_REMOVE
```
    See Also:
    
    Constant Field Values
  - REGION_CREATE
```
public static final java.lang.String REGION_CREATE
```
    See Also:
    
    Constant Field Values
  - REGION_DESTROY
```
public static final java.lang.String REGION_DESTROY
```
    See Also:
    
    Constant Field Values
  - REGION_LOCAL_DESTROY
```
public static final java.lang.String REGION_LOCAL_DESTROY
```
    See Also:
    
    Constant Field Values
  - REGION_INVAL
```
public static final java.lang.String REGION_INVAL
```
    See Also:
    
    Constant Field Values
  - REGION_LOCAL_INVAL
```
public static final java.lang.String REGION_LOCAL_INVAL
```
    See Also:
    
    Constant Field Values
  - REGION_KEYS
```
public static final java.lang.String REGION_KEYS
```
    See Also:
    
    Constant Field Values
  - REGION_KEY_SET
```
public static final java.lang.String REGION_KEY_SET
```
    See Also:
    
    Constant Field Values
  - REGION_VALUES
```
public static final java.lang.String REGION_VALUES
```
    See Also:
    
    Constant Field Values
  - REGION_ENTRIES
```
public static final java.lang.String REGION_ENTRIES
```
    See Also:
    
    Constant Field Values
  - REGION_ENTRY_SET
```
public static final java.lang.String REGION_ENTRY_SET
```
    See Also:
    
    Constant Field Values
  - CACHE_CLOSE
```
public static final java.lang.String CACHE_CLOSE
```
    See Also:
    
    Constant Field Values
  - repeatableReadOps
```
public static java.util.List repeatableReadOps
```
  - nonrepeatableReadOps
```
public static java.util.List nonrepeatableReadOps
```
  - clientRepeatableReadOps
```
public static java.util.List clientRepeatableReadOps
```
- Constructor Detail
  - Operation
```
public Operation(java.lang.String regionName,
                 java.lang.Object key,
                 java.lang.String opName,
                 java.lang.Object oldValue,
                 java.lang.Object newValue)
```
    Constructor to create an operation: By default, repeatable read is false.
    
    Parameters:
    
    regionName - The name of the region involved in the operation.
    
    key - The key in the region involved in the operation.
    
    opName - Which operation was done.
    
    oldValue - The old value (before the operation), if applicable.
    
    newValue - The new value (after the operation), if applicable.
- Method Detail
  - getRegionName
```
public java.lang.String getRegionName()
```
    Get the region name for the operation
  - getKey
```
public java.lang.Object getKey()
```
    Get the key for the operation
  - getOpName
```
public java.lang.String getOpName()
```
    Get the operation name
  - getOldValue
```
public java.lang.Object getOldValue()
```
    Get the old value
  - getNewValue
```
public java.lang.Object getNewValue()
```
    Get the new value
  - setOpName
```
public void setOpName(java.lang.String opName)
```
    Set the operation name
  - setOldValue
```
public void setOldValue(java.lang.Object oldValue)
```
    Set the old value
  - setNewValue
```
public void setNewValue(java.lang.Object newValue)
```
    Set the new value
  - setRepeatableRead
```
public void setRepeatableRead(boolean abool)
```
    Set the repeatable read value
  - usesSameRegionAndKey
```
public boolean usesSameRegionAndKey(Operation anOp)
```
    Returns true if the operation uses the same region and key as anOp.
    
    Parameters:
    
    anOp - The operation used to test its region and key.
  - usesSameRegion
```
public boolean usesSameRegion(Operation anOp)
```
    Returns true if the operation uses the same region as anOp.
    
    Parameters:
    
    anOp - The operation used to test its region.
  - isRepeatableRead
```
public boolean isRepeatableRead()
```
    Returns true if the operation is a write operation, false otherwise
  - isRegionSetOperation
```
public boolean isRegionSetOperation()
```
    Returns true if the operation is an operation that involves the entire region keys and/or values as a set.
  - isWriteOperation
```
public boolean isWriteOperation()
```
    Returns true if the operation is a write operation, false otherwise
  - isGetOperation
```
public boolean isGetOperation()
```
    Returns true if the operation is a get operation, false otherwise.
  - isGetWithLoad
```
public boolean isGetWithLoad()
```
    Returns true if the operation is a get and oldValue was null or invalid, false otherwise.
  - isRegionOperation
```
public boolean isRegionOperation()
```
    Returns true if the operation is a region operation, false otherwise.
  - isEntryOperation
```
public boolean isEntryOperation()
```
    Returns true if the operation is an entry operation, false otherwise.
  - isInvalidate
```
public boolean isInvalidate()
```
    Returns true if the operation is an entry operation, false otherwise.
  - isPreviouslyInvalid
```
public boolean isPreviouslyInvalid()
```
    Returns true if the operation's oldValue is any form of invalid
  - isLocalOperation
```
public boolean isLocalOperation()
```
    Returns true if the operation is a local operation, false otherwise.
  - isRegionCreate
```
public boolean isRegionCreate()
```
    Returns true if the operation is a regionCreate operation, false otherwise.
  - isRegionDestroy
```
public boolean isRegionDestroy()
```
    Returns true if the operation is a regionDestroy or regionLocalDestroy operation, false otherwise.
  - isRegionInvalidate
```
public boolean isRegionInvalidate()
```
    Returns true if the operation is a regionInval or regionLocalInval operation, false otherwise.
  - isEntryUpdate
```
public boolean isEntryUpdate()
```
    Returns true if the operation is an entryInval or entryLocalInval operation, false otherwise.
  - isEntryInvalidate
```
public boolean isEntryInvalidate()
```
    Returns true if the operation is an entryInval or entryLocalInval operation, false otherwise.
  - isEntryCreate
```
public boolean isEntryCreate()
```
    Returns true if the operation is an entryCreate operation, false otherwise.
  - isEntryDestroy
```
public boolean isEntryDestroy()
```
    Returns true if the operation is an entryDestroy or entryLocalDestroy operation, false otherwise.
  - isDoubleInvalidate
```
public boolean isDoubleInvalidate()
```
    Returns true if the operation is the result of two invalidates (which implies the 2nd invalidate is a noop), false otherwise.
  - isEntryGet
```
public boolean isEntryGet()
```
    Returns true if the operation is a any type of get (Existing, Prev, New) operation, false otherwise.
  - equalsEventOp
```
public boolean equalsEventOp(java.lang.Object anObj)
```
    Returns true if the argument equals the receiver, false otherwise Differs from equals() in that the original operation may have an oldValue or newValue of INVALID which must appear equal to the event's oldValue/newValue == null. This allows comparisons of operations re-generated from Events to be compared to the original operation list.
    
    Parameters:
    
    anObj - an Operation re-generated from an Event
  - equals
```
public boolean equals(java.lang.Object anObj)
```
    Returns true if the argument equals the receiver, false otherwise
    
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Return a string description of the operation
    
    Overrides:
    
    toString in class java.lang.Object
  - entryOpAffectedBy
```
public boolean entryOpAffectedBy(Operation op)
```
  - affectedBy
```
public boolean affectedBy(Operation op)
```

Class Operation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ENTRY_CREATE

ENTRY_UPDATE

ENTRY_PUTALL

ENTRY_DESTROY

ENTRY_LOCAL_DESTROY

ENTRY_INVAL

ENTRY_LOCAL_INVAL

ENTRY_GET_NEW_KEY

ENTRY_GET_EXIST_KEY

ENTRY_GET_PREV_KEY

ENTRY_GET_ENTRY_EXIST_KEY

ENTRY_GETALL

ENTRY_CONTAINS_KEY

ENTRY_CONTAINS_VALUE_FOR_KEY

ENTRY_CONTAINS_VALUE

ENTRY_REMOVE

REGION_CREATE

REGION_DESTROY

REGION_LOCAL_DESTROY

REGION_INVAL

REGION_LOCAL_INVAL

REGION_KEYS

REGION_KEY_SET

REGION_VALUES

REGION_ENTRIES

REGION_ENTRY_SET

CACHE_CLOSE

repeatableReadOps

nonrepeatableReadOps

clientRepeatableReadOps

Constructor Detail

Operation

Method Detail

getRegionName

getKey

getOpName

getOldValue

getNewValue

setOpName

setOldValue

setNewValue

setRepeatableRead

usesSameRegionAndKey

usesSameRegion

isRepeatableRead

isRegionSetOperation

isWriteOperation

isGetOperation

isGetWithLoad

isRegionOperation

isEntryOperation

isInvalidate

isPreviouslyInvalid

isLocalOperation

isRegionCreate

isRegionDestroy

isRegionInvalidate

isEntryUpdate

isEntryInvalidate

isEntryCreate

isEntryDestroy

isDoubleInvalidate

isEntryGet

equalsEventOp

equals

toString

entryOpAffectedBy

affectedBy