util

Class CacheDefinition

java.lang.Object

util.Definition

util.CacheDefinition

All Implemented Interfaces:

Serializable

public class CacheDefinition
extends Definition

Class used to define a valid combination of attributes and specifications for a cache.

See Also:

Serialized Form

Field Summary

Fields inherited from class util.Definition

ATTR_DELIM, RegDefRand, SPEC_NAME_DELIM, SPEC_TERMINATOR, specMap, specName, tokenArr, tokenIndex, WHITE_SPACE_DELIM

Method Summary

Modifier and Type	Method and Description
com.gemstone.gemfire.cache.Cache	createCache() Create a cache using this instance of CacheDefinition.
com.gemstone.gemfire.cache.Cache	createCache(String xmlFile) Create a cache using this instance of CacheDefinition.
static CacheDefinition	createCacheDefinition(Long hydraSpecParam, String specName) Creates a cache definition with the specified specName.
Boolean	getCopyOnRead()
Float	getCriticalHeapPercentage()
Float	getEvictionHeapPercentage()
Integer	getLockLease()
Integer	getLockTimeout()
Integer	getSearchTimeout()
protected void	initializeWithSpec(String cacheSpecStr) Initialize this instance with the cache spec given by the String.
void	setCopyOnRead(boolean copyOnReadArg)
void	setCriticalHeapPercentage(float pct)
void	setEvictionHeapPercentage(float pct)
void	setLockLease(int lockLeaseArg)
void	setLockTimeout(int lockTimeoutArg)
void	setSearchTimeout(int searchTimeoutArg)
String	toString() Return this instance as a string.

Methods inherited from class util.Definition

getDefinition, getNextToken, getTokenBoolean, getTokenClass, getTokenEquals, getTokenFloat, getTokenFromList, getTokenInteger, getTokenList, getTokenLong, getTokenString, initializeSpecMap, tokensToString

Methods inherited from class java.lang.Object

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

Method Detail

initializeWithSpec

protected void initializeWithSpec(String cacheSpecStr)

Initialize this instance with the cache spec given by the String.

Specified by:

initializeWithSpec in class Definition

Parameters:

cacheSpecStr - A string containing a cache spec.

toString

public String toString()

Return this instance as a string.

Specified by:

toString in class Definition

createCache

public com.gemstone.gemfire.cache.Cache createCache(String xmlFile)

Create a cache using this instance of CacheDefinition. If a cache has already been created, then throw an error.

Parameters:

xmlFile - The name of an xmlFile to use when the cache is created. This will cause the creation of any regions and/or entries.

Returns:

The instance of Cache.

createCache

public com.gemstone.gemfire.cache.Cache createCache()

Create a cache using this instance of CacheDefinition. If a cache has already been created, then throw an error.

Returns:

The instance of Cache.

createCacheDefinition

public static CacheDefinition createCacheDefinition(Long hydraSpecParam,
                                                    String specName)

Creates a cache definition with the specified specName.

Parameters:

hydraSpecParam - The name of the hydra parameter containing the spec string.

specName - The name of the attribute specification, defined in hydraSpecParam.

Returns:

A CacheDefinition as described above.

Throws:

TestException - if there is no spec named specName

getCopyOnRead

public Boolean getCopyOnRead()

getLockTimeout

public Integer getLockTimeout()

getLockLease

public Integer getLockLease()

getSearchTimeout

public Integer getSearchTimeout()

getEvictionHeapPercentage

public Float getEvictionHeapPercentage()

getCriticalHeapPercentage

public Float getCriticalHeapPercentage()

setCopyOnRead

public void setCopyOnRead(boolean copyOnReadArg)

setLockTimeout

public void setLockTimeout(int lockTimeoutArg)

setLockLease

public void setLockLease(int lockLeaseArg)

setSearchTimeout

public void setSearchTimeout(int searchTimeoutArg)

setEvictionHeapPercentage

public void setEvictionHeapPercentage(float pct)

setCriticalHeapPercentage

public void setCriticalHeapPercentage(float pct)