CollectionsTest (GemFire XD Java API Documentation)

java.lang.Object
- tx.CollectionsTest

```
public class CollectionsTest
extends Object
```
A test to validate behavior of region collections Region collections (keys, values, entries, subRegions) and getEntry all have a common set of behaviors. === Old (pre 6.5 behavior) === When obtained outside of a transaction, Collections will reflect committed state (note that the Collection is always backed up by the true region contents). When the iterator is obtained is important however ... it reflects the collection at the time the iterator was created. If a collection is obtained between begin() & commit/rollback, it reflects transactional state (though at least for now, the contents of the Collection will not change dynamically while the transacation state changes). If the collection or iterator is accessed outside the transaction, an IllegalStateException is thrown. Entries obtained via Region.getEntry() work the same way -- if obtained outside the transaction, it reflects committed state. If obtained within the transaction, transactional state. If subsequently accessed outside of the transaction, it will throw an IllegalStateException == New (6.5 behavior) == Collections obtained outside of a transaction cannot be used within it. Collections obtained within a transaction may not be used outside it. In both cases above, an IllegalStateException will be thrown. Note that region operations are not transactional and Region.subregions() is not subject to the limitations above. To see IllegalStateExceptions being logged, enable 'fine' logging.

Field Summary

Fields
Modifier and Type Field and Description

protected static CollectionsTest collectionsTest

Fields
Modifier and Type	Field and Description
`protected static CollectionsTest`	`collectionsTest`

Constructor Summary

Constructors
Constructor and Description

CollectionsTest()

Constructors
Constructor and Description
`CollectionsTest()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object[]`	`createRegionWithPath(String regionName)` Given a region name, return the region instance for it.
`Operation`	`executeCreateEntry(Operation op)` Creates a new key/value in the given region by creating a new (never-used-before) key and a random value.
`Operation`	`executeCreateRegion(Operation op)` Creates a region that was previously destroyed.
`Operation`	`executeDestroyEntry(Operation op)` Destroys an entry in aRegion.
`Operation`	`executeDestroyRegion(Operation op)` Destroys the given region.
`Operation`	`executeGetEntryWithExistingKey(Operation op)` Gets a value in aRegion with a key existing in aRegion.
`Operation`	`executeGetEntryWithNewKey(Operation op)` Gets a value in aRegion with a the next new (never-before_used) key.
`Operation`	`executeGetEntryWithPreviousKey(Operation op)` Gets a value in aRegion with a random key that was previously used in the test.
`Operation`	`executeInvalEntry(Operation op)` Invalidates an entry in aRegion.
`Operation`	`executeInvalRegion(Operation op)` Invalidates the given region.
`Operation`	`executeOperation(Operation operation)`
`Operation`	`executeUpdateEntry(Operation op)` Updates an existing entry in aRegion.
`Operation`	`getCreateEntryOp(com.gemstone.gemfire.cache.Region aRegion)` getCreateEntryOp()
`Operation`	`getCreateRegionOp()` getCreateRegionOp()
`Operation`	`getDestroyEntryOp(boolean isLocalDestroy, com.gemstone.gemfire.cache.Region aRegion, Object key)` getDestroyEntryOp()
`Operation`	`getDestroyRegionOp(boolean isLocalDestroy, com.gemstone.gemfire.cache.Region aRegion)` getDestroyRegionOp()
`Operation`	`getGetEntryWithExistingKeyOp(com.gemstone.gemfire.cache.Region aRegion)` getGetEntryWithExistingKeyOp()
`Operation`	`getGetEntryWithNewKeyOp(com.gemstone.gemfire.cache.Region aRegion)` getGetEntryWithNewKey()
`Operation`	`getGetEntryWithPreviousKeyOp(com.gemstone.gemfire.cache.Region aRegion)` getGetEntryWithPreviousKey()
`Operation`	`getInvalEntryOp(boolean isLocalInval, com.gemstone.gemfire.cache.Region aRegion, Object key)` getInvalEntryOp()
`Operation`	`getInvalRegionOp(boolean isLocalInval, com.gemstone.gemfire.cache.Region aRegion)` getInvalRegionOp()
`Operation`	`getUpdateEntryOp(com.gemstone.gemfire.cache.Region aRegion, Object key)` getUpdateEntryOp()
`Object`	`getValueInVM(com.gemstone.gemfire.cache.Region aRegion, Object key)` Call getValueInVM on the given region and key.
`static void`	`HydraTask_doTransactions()`
`static void`	`HydraTask_initialize()`
`void`	`initialize()`

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

- Field Detail
  - collectionsTest
```
protected static CollectionsTest collectionsTest
```
- Constructor Detail
  - CollectionsTest
```
public CollectionsTest()
```
- Method Detail
  - HydraTask_initialize
```
public static void HydraTask_initialize()
```
  - initialize
```
public void initialize()
```
  - HydraTask_doTransactions
```
public static void HydraTask_doTransactions()
```
  - getCreateEntryOp
```
public Operation getCreateEntryOp(com.gemstone.gemfire.cache.Region aRegion)
```
    getCreateEntryOp()
    
    Parameters:
    
    aRegion - - entry op describes a create-entry op in the given region
    
    Returns:
    
    Operation op - a createEntry Operation
  - getUpdateEntryOp
```
public Operation getUpdateEntryOp(com.gemstone.gemfire.cache.Region aRegion,
                                  Object key)
```
    getUpdateEntryOp()
    
    Parameters:
    
    aRegion - The region to modify a key in.
    
    key - The key to modify.
    
    Returns:
    
    An instance of Operation describing the update operation.
  - getDestroyEntryOp
```
public Operation getDestroyEntryOp(boolean isLocalDestroy,
                                   com.gemstone.gemfire.cache.Region aRegion,
                                   Object key)
```
    getDestroyEntryOp()
    
    Parameters:
    
    isLocalDestroy - True if the opertion is a local destroy, false otherwise.
    
    aRegion - The region to destroy the entry in.
    
    key - The key to destroy.
    
    Returns:
    
    An instance of Operation describing the destroy operation.
  - getInvalEntryOp
```
public Operation getInvalEntryOp(boolean isLocalInval,
                                 com.gemstone.gemfire.cache.Region aRegion,
                                 Object key)
```
    getInvalEntryOp()
    
    Parameters:
    
    isLocalInval - True if the opertion is a local invalidate, false otherwise.
    
    aRegion - The region to invalidate the entry in.
    
    key - The key to invalidate.
    
    Returns:
    
    An instance of Operation describing the invalidate operation.
  - getGetEntryWithExistingKeyOp
```
public Operation getGetEntryWithExistingKeyOp(com.gemstone.gemfire.cache.Region aRegion)
```
    getGetEntryWithExistingKeyOp()
    
    Parameters:
    
    aRegion - The region to get from.
    
    Returns:
    
    An instance of Operation describing the get operation. Note: operation.newVal = null upon return
  - getGetEntryWithPreviousKeyOp
```
public Operation getGetEntryWithPreviousKeyOp(com.gemstone.gemfire.cache.Region aRegion)
```
    getGetEntryWithPreviousKey()
    
    Parameters:
    
    aRegion - The region to get from.
    
    Returns:
    
    An instance of Operation describing the get operation. Note: operation.newVal = null upon return
  - getGetEntryWithNewKeyOp
```
public Operation getGetEntryWithNewKeyOp(com.gemstone.gemfire.cache.Region aRegion)
```
    getGetEntryWithNewKey()
    
    Parameters:
    
    aRegion - The region to get from.
    
    Returns:
    
    An instance of Operation describing the get operation. Note: operation.newVal = null upon return
  - getInvalRegionOp
```
public Operation getInvalRegionOp(boolean isLocalInval,
                                  com.gemstone.gemfire.cache.Region aRegion)
```
    getInvalRegionOp()
    
    Parameters:
    
    isLocalInval - True if the opertion is a local invalidate, false otherwise.
    
    aRegion - The region to invalidate.
    
    Returns:
    
    An instance of Operation describing the invalidate operation.
  - getDestroyRegionOp
```
public Operation getDestroyRegionOp(boolean isLocalDestroy,
                                    com.gemstone.gemfire.cache.Region aRegion)
```
    getDestroyRegionOp()
    
    Parameters:
    
    isLocalDestroy - True if the opertion is a local destroy, false otherwise.
    
    aRegion - The region to destroy.
    
    Returns:
    
    An instance of Operation describing the destroy operation.
  - getCreateRegionOp
```
public Operation getCreateRegionOp()
```
    getCreateRegionOp()
    
    Returns:
    
    An instance of Operation describing the create operation. returns 'null' if no regions previously destroyed
  - executeOperation
```
public Operation executeOperation(Operation operation)
```
  - executeCreateEntry
```
public Operation executeCreateEntry(Operation op)
```
    Creates a new key/value in the given region by creating a new (never-used-before) key and a random value.
    
    Parameters:
    
    Operation - op - describes operation to be performed
    
    Returns:
    
    Operation op - completed op
  - executeUpdateEntry
```
public Operation executeUpdateEntry(Operation op)
```
    Updates an existing entry in aRegion. The value in the key is increment by 1.
    
    Parameters:
    
    Operation - op - describes operation to be performed
    
    Returns:
    
    An instance of Operation describing the update operation.
  - executeDestroyEntry
```
public Operation executeDestroyEntry(Operation op)
```
    Destroys an entry in aRegion.
    
    Parameters:
    
    Operation - op - describes operation to be performed
    
    Returns:
    
    An instance of Operation describing the destroy operation.
  - executeInvalEntry
```
public Operation executeInvalEntry(Operation op)
```
    Invalidates an entry in aRegion.
    
    Parameters:
    
    Operation - op - describes operation to be performed
    
    Returns:
    
    An instance of Operation describing the invalidate operation.
  - executeGetEntryWithExistingKey
```
public Operation executeGetEntryWithExistingKey(Operation op)
```
    Gets a value in aRegion with a key existing in aRegion.
    
    Parameters:
    
    Operation - op - describes operation to be performed
    
    Returns:
    
    Operation op - updated operation
  - executeGetEntryWithPreviousKey
```
public Operation executeGetEntryWithPreviousKey(Operation op)
```
    Gets a value in aRegion with a random key that was previously used in the test.
    
    Parameters:
    
    Operation - op - describes operation to be performed
    
    Returns:
    
    An instance of Operation describing the get operation.
  - executeGetEntryWithNewKey
```
public Operation executeGetEntryWithNewKey(Operation op)
```
    Gets a value in aRegion with a the next new (never-before_used) key.
    
    Parameters:
    
    Operation - op - describes operation to be performed
    
    Returns:
    
    An instance of Operation describing the get operation.
  - executeInvalRegion
```
public Operation executeInvalRegion(Operation op)
```
    Invalidates the given region.
    
    Parameters:
    
    Operation - op - describes operation to be performed
    
    Returns:
    
    An instance of Operation describing the invalidate operation.
  - executeDestroyRegion
```
public Operation executeDestroyRegion(Operation op)
```
    Destroys the given region.
    
    Parameters:
    
    Operation - op - describes operation to be performed
    
    Returns:
    
    An instance of Operation describing the destroy operation.
  - executeCreateRegion
```
public Operation executeCreateRegion(Operation op)
```
    Creates a region that was previously destroyed.
    
    Returns:
    
    An instance of Operation describing the destroy operation.
  - createRegionWithPath
```
public Object[] createRegionWithPath(String regionName)
```
    Given a region name, return the region instance for it. If the region with regionName currently does not exist, create it (and any parents required to create it).
    
    Parameters:
    
    regionName - - The full path name of a region.
  - getValueInVM
```
public Object getValueInVM(com.gemstone.gemfire.cache.Region aRegion,
                           Object key)
```
    Call getValueInVM on the given region and key. For PartitionedRegions, this calls Region.getEntry and adjusts value returned for Token.INVALID. For replicated regions, this invokes diskReg.DiskRegUtil.getValueInVM().
    
    Parameters:
    
    aRegion - - The region to use for the call.
    
    key - - The key to use for the call.

Class CollectionsTest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

collectionsTest

Constructor Detail

CollectionsTest

Method Detail

HydraTask_initialize

initialize

HydraTask_doTransactions

getCreateEntryOp

getUpdateEntryOp

getDestroyEntryOp

getInvalEntryOp

getGetEntryWithExistingKeyOp

getGetEntryWithPreviousKeyOp

getGetEntryWithNewKeyOp

getInvalRegionOp

getDestroyRegionOp

getCreateRegionOp

executeOperation

executeCreateEntry

executeUpdateEntry

executeDestroyEntry

executeInvalEntry

executeGetEntryWithExistingKey

executeGetEntryWithPreviousKey

executeGetEntryWithNewKey

executeInvalRegion

executeDestroyRegion

executeCreateRegion

createRegionWithPath

getValueInVM