Package org.apache.commons.jcs3.engine
Class CompositeCacheAttributes
java.lang.Object
org.apache.commons.jcs3.engine.CompositeCacheAttributes
- All Implemented Interfaces:
- Serializable,- Cloneable,- ICompositeCacheAttributes
The CompositeCacheAttributes defines the general cache region settings. If a region is not
 explicitly defined in the cache.ccf then it inherits the cache default settings.
 
If all the default attributes are not defined in the default region definition in the cache.ccf, the hard coded defaults will be used.
- See Also:
- 
Nested Class SummaryNested classes/interfaces inherited from interface org.apache.commons.jcs3.engine.behavior.ICompositeCacheAttributesICompositeCacheAttributes.DiskUsagePattern
- 
Constructor SummaryConstructorsConstructorDescriptionConstructor for the CompositeCacheAttributes object
- 
Method SummaryModifier and TypeMethodDescriptionclone()Clone objectGets the cacheName attribute of the CompositeCacheAttributes objectlongIf UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.intGets the maxObjects attribute of the CompositeCacheAttributes objectintIf UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.Gets the memoryCacheName attribute of the CompositeCacheAttributes objectlongIf UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.intNumber to send to disk at the time when memory is full.booleanGets the useDisk attribute of the CompositeCacheAttributes objectbooleanGets the useLateral attribute of the CompositeCacheAttributes objectbooleanWhether the memory cache should perform background memory shrinkage.booleanGets the useRemote attribute of the CompositeCacheAttributes objectvoidSets the cacheName attribute of the CompositeCacheAttributes objectvoidsetDiskUsagePattern(ICompositeCacheAttributes.DiskUsagePattern diskUsagePattern) By default this is SWAP_ONLY.voidsetDiskUsagePatternName(String diskUsagePatternName) Translates the name to the disk usage pattern short value.voidsetMaxMemoryIdleTimeSeconds(long seconds) If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.voidsetMaxObjects(int maxObjs) Sets the maxObjects attribute of the CompositeCacheAttributes objectvoidsetMaxSpoolPerRun(int maxSpoolPerRun) If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.voidSets the memoryCacheName attribute of the CompositeCacheAttributes objectvoidsetShrinkerIntervalSeconds(long seconds) If UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.voidsetSpoolChunkSize(int spoolChunkSize) Number to send to disk at a time.voidsetUseDisk(boolean useDisk) Sets the useDisk attribute of the CompositeCacheAttributes objectvoidsetUseLateral(boolean b) Sets the useLateral attribute of the CompositeCacheAttributes objectvoidsetUseMemoryShrinker(boolean useShrinker) Whether the memory cache should perform background memory shrinkage.voidsetUseRemote(boolean useRemote) Sets the useRemote attribute of the CompositeCacheAttributes objecttoString()Dumps the core attributes.
- 
Constructor Details- 
CompositeCacheAttributespublic CompositeCacheAttributes()Constructor for the CompositeCacheAttributes object
 
- 
- 
Method Details- 
setMaxObjectsSets the maxObjects attribute of the CompositeCacheAttributes object- Specified by:
- setMaxObjectsin interface- ICompositeCacheAttributes
- Parameters:
- maxObjs- The new maxObjects value
 
- 
getMaxObjectsGets the maxObjects attribute of the CompositeCacheAttributes object- Specified by:
- getMaxObjectsin interface- ICompositeCacheAttributes
- Returns:
- The maxObjects value
 
- 
setUseDiskSets the useDisk attribute of the CompositeCacheAttributes object- Specified by:
- setUseDiskin interface- ICompositeCacheAttributes
- Parameters:
- useDisk- The new useDisk value
 
- 
isUseDiskGets the useDisk attribute of the CompositeCacheAttributes object- Specified by:
- isUseDiskin interface- ICompositeCacheAttributes
- Returns:
- The useDisk value
 
- 
setUseLateralSets the useLateral attribute of the CompositeCacheAttributes object- Specified by:
- setUseLateralin interface- ICompositeCacheAttributes
- Parameters:
- b- The new useLateral value
 
- 
isUseLateralGets the useLateral attribute of the CompositeCacheAttributes object- Specified by:
- isUseLateralin interface- ICompositeCacheAttributes
- Returns:
- The useLateral value
 
- 
setUseRemoteSets the useRemote attribute of the CompositeCacheAttributes object- Specified by:
- setUseRemotein interface- ICompositeCacheAttributes
- Parameters:
- useRemote- The new useRemote value
 
- 
isUseRemoteGets the useRemote attribute of the CompositeCacheAttributes object- Specified by:
- isUseRemotein interface- ICompositeCacheAttributes
- Returns:
- The useRemote value
 
- 
setCacheNameSets the cacheName attribute of the CompositeCacheAttributes object- Specified by:
- setCacheNamein interface- ICompositeCacheAttributes
- Parameters:
- s- The new cacheName value
 
- 
getCacheNameGets the cacheName attribute of the CompositeCacheAttributes object- Specified by:
- getCacheNamein interface- ICompositeCacheAttributes
- Returns:
- The cacheName value
 
- 
setMemoryCacheNameSets the memoryCacheName attribute of the CompositeCacheAttributes object- Specified by:
- setMemoryCacheNamein interface- ICompositeCacheAttributes
- Parameters:
- s- The new memoryCacheName value
 
- 
getMemoryCacheNameGets the memoryCacheName attribute of the CompositeCacheAttributes object- Specified by:
- getMemoryCacheNamein interface- ICompositeCacheAttributes
- Returns:
- The memoryCacheName value
 
- 
setUseMemoryShrinkerWhether the memory cache should perform background memory shrinkage.- Specified by:
- setUseMemoryShrinkerin interface- ICompositeCacheAttributes
- Parameters:
- useShrinker- The new UseMemoryShrinker value
 
- 
isUseMemoryShrinkerWhether the memory cache should perform background memory shrinkage.- Specified by:
- isUseMemoryShrinkerin interface- ICompositeCacheAttributes
- Returns:
- The UseMemoryShrinker value
 
- 
setMaxMemoryIdleTimeSecondsIf UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.- Specified by:
- setMaxMemoryIdleTimeSecondsin interface- ICompositeCacheAttributes
- Parameters:
- seconds- The new MaxMemoryIdleTimeSeconds value
 
- 
getMaxMemoryIdleTimeSecondsIf UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space.- Specified by:
- getMaxMemoryIdleTimeSecondsin interface- ICompositeCacheAttributes
- Returns:
- The MaxMemoryIdleTimeSeconds value
 
- 
setShrinkerIntervalSecondsIf UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space. This sets the shrinker interval.- Specified by:
- setShrinkerIntervalSecondsin interface- ICompositeCacheAttributes
- Parameters:
- seconds- The new ShrinkerIntervalSeconds value
 
- 
getShrinkerIntervalSecondsIf UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space. This gets the shrinker interval.- Specified by:
- getShrinkerIntervalSecondsin interface- ICompositeCacheAttributes
- Returns:
- The ShrinkerIntervalSeconds value
 
- 
setMaxSpoolPerRunIf UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space. This sets the maximum number of items to spool per run.If the value is -1, then there is no limit to the number of items to be spooled. - Specified by:
- setMaxSpoolPerRunin interface- ICompositeCacheAttributes
- Parameters:
- maxSpoolPerRun- The new maxSpoolPerRun value
 
- 
getMaxSpoolPerRunIf UseMemoryShrinker is true the memory cache should auto-expire elements to reclaim space. This gets the maximum number of items to spool per run.- Specified by:
- getMaxSpoolPerRunin interface- ICompositeCacheAttributes
- Returns:
- The maxSpoolPerRun value
 
- 
setDiskUsagePatternBy default this is SWAP_ONLY.- Specified by:
- setDiskUsagePatternin interface- ICompositeCacheAttributes
- Parameters:
- diskUsagePattern- The diskUsagePattern to set.
 
- 
setDiskUsagePatternNameTranslates the name to the disk usage pattern short value.The allowed values are SWAP and UPDATE. - Specified by:
- setDiskUsagePatternNamein interface- ICompositeCacheAttributes
- Parameters:
- diskUsagePatternName- The diskUsagePattern to set.
 
- 
getSpoolChunkSizeNumber to send to disk at the time when memory is full.- Specified by:
- getSpoolChunkSizein interface- ICompositeCacheAttributes
- Returns:
- int
 
- 
setSpoolChunkSizeNumber to send to disk at a time.- Specified by:
- setSpoolChunkSizein interface- ICompositeCacheAttributes
- Parameters:
- spoolChunkSize-
 
- 
getDiskUsagePattern- Specified by:
- getDiskUsagePatternin interface- ICompositeCacheAttributes
- Returns:
- Returns the diskUsagePattern.
 
- 
toStringDumps the core attributes.
- 
cloneDescription copied from interface:ICompositeCacheAttributesClone object- Specified by:
- clonein interface- ICompositeCacheAttributes
- Overrides:
- clonein class- Object
- See Also:
 
 
-