Validator (GemFire XD Java API Documentation)

java.lang.Object
- util.Validator

Direct Known Subclasses:

EndTaskValidator
```
public class Validator
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALWAYS`
`protected CacheBB`	`blackboard`
`static int`	`BOTH`
`protected int`	`containsKeyCategory`
`protected int`	`containsValueForKeyCategory`
`protected int`	`doGetStrategy`
`static int`	`DONT_CHECK`
`static int`	`IF_HAS_VALUE`
`protected long`	`maxNumberToValidate`
`static int`	`NEGATIVE`
`static int`	`NEVER`
`static int`	`NONE`
`static int`	`POSITIVE`
`static int`	`SOMETIMES`
`protected boolean`	`stableKeys`
`protected boolean`	`throwOnFirstError`
`protected long`	`timeLimitMS`
`static long`	`VALIDATE_ALL`
`protected int`	`valueShouldBeNull`
`protected boolean`	`waitForContainsKey`
`protected boolean`	`waitForContainsValueForKey`

Constructor Summary

Constructors
Constructor and Description

Validator()

Constructors
Constructor and Description
`Validator()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`logMessage(String aStr)`
`void`	`setBlackboard(CacheBB bb)` Set blackboard.
`void`	`setContainsKeyCategory(int containsKeyCategory)` Set containsKeyCategory.
`void`	`setContainsValueForKeyCategory(int containsValueForKeyCategory)` Set containsValueForKeyCategory.
`void`	`setDoGetStrategy(int doGetStrategy)` Set doGetStrategy.
`void`	`setMaxNumberToValidate(long maxNumberToValidate)` Set maxNumberToValidate.
`void`	`setStableKeys(boolean stableKeys)` Set stableKeys.
`void`	`setThrowOnFirstError(boolean throwOnFirstError)` Set throwOnFirstError.
`void`	`setTimeLimitMS(long timeLimitMS)` Set timeLimitMS.
`void`	`setValueShouldBeNull(int valueShouldBeNull)` Set valueShouldBeNull.
`void`	`setWaitForContainsKey(boolean waitForContainsKey)` Set waitForContainsKey.
`void`	`setWaitForContainsValueForKey(boolean waitForContainsValueForKey)` Set waitForContainsValueForKey.
`String`	`toString()`
`Object[]`	`validateRegionContents(com.gemstone.gemfire.cache.Region aRegion)` Given a region and using `NameFactory`'s names and counters, iterate over the expected names in the region, testing each according to this Validator instance.

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

- Field Detail
  - VALIDATE_ALL
```
public static final long VALIDATE_ALL
```
    See Also:
    
    Constant Field Values
  - POSITIVE
```
public static final int POSITIVE
```
    See Also:
    
    Constant Field Values
  - NEGATIVE
```
public static final int NEGATIVE
```
    See Also:
    
    Constant Field Values
  - BOTH
```
public static final int BOTH
```
    See Also:
    
    Constant Field Values
  - NONE
```
public static final int NONE
```
    See Also:
    
    Constant Field Values
  - IF_HAS_VALUE
```
public static final int IF_HAS_VALUE
```
    See Also:
    
    Constant Field Values
  - ALWAYS
```
public static final int ALWAYS
```
    See Also:
    
    Constant Field Values
  - NEVER
```
public static final int NEVER
```
    See Also:
    
    Constant Field Values
  - SOMETIMES
```
public static final int SOMETIMES
```
    See Also:
    
    Constant Field Values
  - DONT_CHECK
```
public static final int DONT_CHECK
```
    See Also:
    
    Constant Field Values
  - containsKeyCategory
```
protected int containsKeyCategory
```
  - containsValueForKeyCategory
```
protected int containsValueForKeyCategory
```
  - doGetStrategy
```
protected int doGetStrategy
```
  - valueShouldBeNull
```
protected int valueShouldBeNull
```
  - stableKeys
```
protected boolean stableKeys
```
  - waitForContainsKey
```
protected boolean waitForContainsKey
```
  - waitForContainsValueForKey
```
protected boolean waitForContainsValueForKey
```
  - throwOnFirstError
```
protected boolean throwOnFirstError
```
  - blackboard
```
protected CacheBB blackboard
```
  - maxNumberToValidate
```
protected long maxNumberToValidate
```
  - timeLimitMS
```
protected long timeLimitMS
```
- Constructor Detail
  - Validator
```
public Validator()
```
- Method Detail
  - setContainsKeyCategory
```
public void setContainsKeyCategory(int containsKeyCategory)
```
    Set containsKeyCategory. Specifies the nature of the keys in the region which should return true for containsKey(...).
  - setContainsValueForKeyCategory
```
public void setContainsValueForKeyCategory(int containsValueForKeyCategory)
```
    Set containsValueForKeyCategory. Specifies the nature of the objects in the region which should return true for containsValueForKey(...).
  - setDoGetStrategy
```
public void setDoGetStrategy(int doGetStrategy)
```
    Set doGetStrategy. Specifies the stategy used to verify the object associated with a key.
  - setValueShouldBeNull
```
public void setValueShouldBeNull(int valueShouldBeNull)
```
    Set valueShouldBeNull. Specifies if values should always, never or sometimes be null.
  - setStableKeys
```
public void setStableKeys(boolean stableKeys)
```
    Set stableKeys. True if the keys can change during execution of the validator (ie concurrent execution test), false otherwise
  - setWaitForContainsKey
```
public void setWaitForContainsKey(boolean waitForContainsKey)
```
    Set waitForContainsKey. True if the validator should wait for containsKey to become true when it is expected to be true but is currently false.
  - setWaitForContainsValueForKey
```
public void setWaitForContainsValueForKey(boolean waitForContainsValueForKey)
```
    Set waitForContainsValueForKey. True if the validator should wait for containsValueForKey to become true when it is expected to be true but is currently false.
  - setThrowOnFirstError
```
public void setThrowOnFirstError(boolean throwOnFirstError)
```
    Set throwOnFirstError. True if the validator should throw an error on the first error encountered, false if it should find all errors before it throws an error.
  - setBlackboard
```
public void setBlackboard(CacheBB bb)
```
    Set blackboard. This is the hydra blackboard to use for gathering limited performance information and error information for ownership timeouts, etc.
  - setMaxNumberToValidate
```
public void setMaxNumberToValidate(long maxNumberToValidate)
```
    Set maxNumberToValidate. This indicates many entries in the region to validate.
  - setTimeLimitMS
```
public void setTimeLimitMS(long timeLimitMS)
```
    Set timeLimitMS. This indicates how long to validate before returning.
  - validateRegionContents
```
public Object[] validateRegionContents(com.gemstone.gemfire.cache.Region aRegion)
```
    Given a region and using NameFactory's names and counters, iterate over the expected names in the region, testing each according to this Validator instance. Throws an error if any problems are detected.
    
    Parameters:
    
    aRegion - The region containing the names generated by NameFactory.
    
    Returns:
    
    Object[0] The number of keys encountered Object[1] The number of values
    
    Throws:
    
    TestException - Throws an error if any of the validation fails.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - logMessage
```
protected void logMessage(String aStr)
```

Class Validator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VALIDATE_ALL

POSITIVE

NEGATIVE

BOTH

NONE

IF_HAS_VALUE

ALWAYS

NEVER

SOMETIMES

DONT_CHECK

containsKeyCategory

containsValueForKeyCategory

doGetStrategy

valueShouldBeNull

stableKeys

waitForContainsKey

waitForContainsValueForKey

throwOnFirstError

blackboard

maxNumberToValidate

timeLimitMS

Constructor Detail

Validator

Method Detail

setContainsKeyCategory

setContainsValueForKeyCategory

setDoGetStrategy

setValueShouldBeNull

setStableKeys

setWaitForContainsKey

setWaitForContainsValueForKey

setThrowOnFirstError

setBlackboard

setMaxNumberToValidate

setTimeLimitMS

validateRegionContents

toString

logMessage