tx

Class EntryValidator

java.lang.Object

tx.EntryValidator

public class EntryValidator
extends java.lang.Object

A class that holds information to aid in entry validation and supplies methods to get the expected behavior (based on operation and whether or not the tx operation should be visible in the calling thread) as well as the actual values. A compare() method is also suppled to provide a check of expected data values / actual data values. Each instance holds: - regionName - key - operation (for better logging when comparisons fail) - keyExists (boolean) - hasValue (boolean) - cacheValue (Object) In order to support the expected values on a per operation basis, Maps holding templates of EntryValidators are established at class initialization (one for the checks required if the tx should be visible by the calling thread and another if the tx should NOT be visible. A calling application will get the expected behavior by invoking: getExpected(Operation op, boolean isVisible). - keyExists (whether or not the key should exist for this operation) - hasValue (whether or not the key should contain a value for this operation) - cacheValue (what value we should expect in the VM, this can be DONT_CARE, OLDVAL or NEWVAL). The template provides these enumerated types and then uses them to fill in the appropriate value from the Operation when the expected EntryValidator is created. Applications also invoke the getActual(Operation op) method to get the actual values from the VMs cache: keyExists (uses regionName/key to check region.containsKey()) hasValue (uses regionName/key to check region.containsValueForKey()) cacheValue (holds the value obtained via DiskRegUtil.getValueInVM() Once both EntryValidator instances have been constructed, the application can invoke the instance method .compare( ) If the expected values/state are not found, a Test Exception is thrown.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	DONT_CARE
static java.lang.Integer	NEWVAL
static java.lang.Integer	OLDVAL

Constructor Summary

Constructors

Constructor and Description
EntryValidator(boolean keyExists, boolean hasValue, java.lang.Object cacheValue) Constructor to create a EntryValidator used internally by this class to create templates based on expected values maps.
EntryValidator(Operation op) noArg constructor
EntryValidator(Operation op, java.lang.String regionName, java.lang.String key, boolean keyExists, boolean hasValue, java.lang.Object cacheValue) Constructor to create a EntryValidator

Method Summary

Modifier and Type	Method and Description
void	compare(EntryValidator vc) Compare two validator controls, throw an exception if not a match
static EntryValidator	getActual(Operation op)
static EntryValidator	getExpected(Operation op, boolean isVisible)
java.lang.Object	getKey()
Operation	getOperation()
java.lang.String	getRegionName()
void	setCacheValue(java.lang.Object value)
void	setHasValue(boolean b)
void	setKey(java.lang.String key)
void	setKeyExists(boolean b)
void	setOperation(Operation op)
void	setRegionName(java.lang.String regionName)
java.lang.String	toString() Return a string description of the EntryValidator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DONT_CARE

public static final java.lang.Integer DONT_CARE

OLDVAL

public static final java.lang.Integer OLDVAL

NEWVAL

public static final java.lang.Integer NEWVAL

Constructor Detail

EntryValidator

public EntryValidator(Operation op)

noArg constructor

EntryValidator

public EntryValidator(boolean keyExists,
                      boolean hasValue,
                      java.lang.Object cacheValue)

Constructor to create a EntryValidator used internally by this class to create templates based on expected values maps. (See static initializer above)

Parameters:

keyExists - boolean (true => expect region.containsKey() == true)

hasValue - boolean (true => expect region.containsValueForKey() == true)

cacheValue - The expected value of this entry when retrieved from cache

EntryValidator

public EntryValidator(Operation op,
                      java.lang.String regionName,
                      java.lang.String key,
                      boolean keyExists,
                      boolean hasValue,
                      java.lang.Object cacheValue)

Constructor to create a EntryValidator

Parameters:

regionName - The name of the region involved in the operation.

key - The key in the region involved in the operation.

keyExists - boolean (true => expect region.containsKey() == true)

hasValue - boolean (true => expect region.containsValueForKey() == true)

cacheValue - The expected value of this entry when retrieved from cache

Method Detail

getRegionName

public java.lang.String getRegionName()

setRegionName

public void setRegionName(java.lang.String regionName)

getKey

public java.lang.Object getKey()

setKey

public void setKey(java.lang.String key)

setKeyExists

public void setKeyExists(boolean b)

setHasValue

public void setHasValue(boolean b)

setCacheValue

public void setCacheValue(java.lang.Object value)

getOperation

public Operation getOperation()

setOperation

public void setOperation(Operation op)

getExpected

public static EntryValidator getExpected(Operation op,
                                         boolean isVisible)

getActual

public static EntryValidator getActual(Operation op)

compare

public void compare(EntryValidator vc)

Compare two validator controls, throw an exception if not a match

toString

public java.lang.String toString()

Return a string description of the EntryValidator

Overrides:

toString in class java.lang.Object