org.apache.jcs.auxiliary.disk.indexed
Class IndexedDiskCacheAttributes

java.lang.Object
  extended by org.apache.jcs.auxiliary.AbstractAuxiliaryCacheAttributes
      extended by org.apache.jcs.auxiliary.disk.AbstractDiskCacheAttributes
          extended by org.apache.jcs.auxiliary.disk.indexed.IndexedDiskCacheAttributes
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, AuxiliaryCacheAttributes, IDiskCacheAttributes

public class IndexedDiskCacheAttributes
extends AbstractDiskCacheAttributes

Configuration class for the Indexed Disk Cache

See Also:
Serialized Form

Field Summary
static boolean DEFAULT_OPTIMIZE_ON_SHUTDOWN
          Should we optimize on shutdown.
 
Fields inherited from class org.apache.jcs.auxiliary.disk.AbstractDiskCacheAttributes
diskPath, maxPurgatorySize, shutdownSpoolTimeLimit
 
Fields inherited from class org.apache.jcs.auxiliary.AbstractAuxiliaryCacheAttributes
cacheName, eventQueuePoolName, eventQueueType, name
 
Fields inherited from interface org.apache.jcs.auxiliary.disk.behavior.IDiskCacheAttributes
MAX_PURGATORY_SIZE_DEFUALT
 
Fields inherited from interface org.apache.jcs.auxiliary.AuxiliaryCacheAttributes
POOLED_QUEUE_TYPE, SINGLE_QUEUE_TYPE
 
Constructor Summary
IndexedDiskCacheAttributes()
          Constructor for the DiskCacheAttributes object
 
Method Summary
 AuxiliaryCacheAttributes copy()
          Returns a copy of the attributes.
 int getMaxKeySize()
          Gets the maxKeySize attribute of the DiskCacheAttributes object
 int getMaxRecycleBinSize()
           
 int getOptimizeAtRemoveCount()
          Gets the optimizeAtRemoveCount attribute of the DiskCacheAttributes object
 boolean isOptimizeOnShutdown()
           
 void setMaxKeySize(int maxKeySize)
          Sets the maxKeySize attribute of the DiskCacheAttributes object
 void setMaxRecycleBinSize(int maxRecycleBinSize)
          This cannot be larger than the maxKeySize.
 void setOptimizeAtRemoveCount(int cnt)
          Sets the optimizeAtRemoveCount attribute of the DiskCacheAttributes object This number determines how often the disk cache should run real time optimizations.
 void setOptimizeOnShutdown(boolean optimizeOnShutdown)
           
 java.lang.String toString()
          Write out the values for debugging purposes.
 
Methods inherited from class org.apache.jcs.auxiliary.disk.AbstractDiskCacheAttributes
getDiskPath, getMaxPurgatorySize, getShutdownSpoolTimeLimit, isAllowRemoveAll, setAllowRemoveAll, setDiskPath, setMaxPurgatorySize, setShutdownSpoolTimeLimit
 
Methods inherited from class org.apache.jcs.auxiliary.AbstractAuxiliaryCacheAttributes
getCacheName, getEventQueuePoolName, getEventQueueType, getName, setCacheName, setEventQueuePoolName, setEventQueueType, setName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.jcs.auxiliary.AuxiliaryCacheAttributes
getCacheName, getEventQueuePoolName, getEventQueueType, getName, setCacheName, setEventQueuePoolName, setEventQueueType, setName
 

Field Detail

DEFAULT_OPTIMIZE_ON_SHUTDOWN

public static final boolean DEFAULT_OPTIMIZE_ON_SHUTDOWN
Should we optimize on shutdown.

See Also:
Constant Field Values
Constructor Detail

IndexedDiskCacheAttributes

public IndexedDiskCacheAttributes()
Constructor for the DiskCacheAttributes object

Method Detail

getMaxKeySize

public int getMaxKeySize()
Gets the maxKeySize attribute of the DiskCacheAttributes object

Returns:
The maxKeySize value

setMaxKeySize

public void setMaxKeySize(int maxKeySize)
Sets the maxKeySize attribute of the DiskCacheAttributes object

Parameters:
maxKeySize - The new maxKeySize value

getOptimizeAtRemoveCount

public int getOptimizeAtRemoveCount()
Gets the optimizeAtRemoveCount attribute of the DiskCacheAttributes object

Returns:
The optimizeAtRemoveCount value

setOptimizeAtRemoveCount

public void setOptimizeAtRemoveCount(int cnt)
Sets the optimizeAtRemoveCount attribute of the DiskCacheAttributes object This number determines how often the disk cache should run real time optimizations.

Parameters:
cnt - The new optimizeAtRemoveCount value

setMaxRecycleBinSize

public void setMaxRecycleBinSize(int maxRecycleBinSize)
This cannot be larger than the maxKeySize. It wouldn't hurt anything, but it makes the config necessary. The recycle bin entry willbe at least as large as a key.

If the maxKeySize is -1 this will be set tot he default, which is 5000.

Parameters:
maxRecycleBinSize - The maxRecycleBinSize to set.

getMaxRecycleBinSize

public int getMaxRecycleBinSize()
Returns:
Returns the maxRecycleBinSize.

setOptimizeOnShutdown

public void setOptimizeOnShutdown(boolean optimizeOnShutdown)
Parameters:
optimizeOnShutdown - The optimizeOnShutdown to set.

isOptimizeOnShutdown

public boolean isOptimizeOnShutdown()
Returns:
Returns the optimizeOnShutdown.

copy

public AuxiliaryCacheAttributes copy()
Returns a copy of the attributes.

Specified by:
copy in interface AuxiliaryCacheAttributes
Overrides:
copy in class AbstractDiskCacheAttributes
Returns:
AuxiliaryCacheAttributes

toString

public java.lang.String toString()
Write out the values for debugging purposes.

Overrides:
toString in class AbstractDiskCacheAttributes
Returns:
String


Copyright © 2002-2009 Apache Software Foundation. All Rights Reserved.