Package org.apache.commons.jcs3.auxiliary.disk.indexed

Class IndexedDiskCacheAttributes

java.lang.Object

org.apache.commons.jcs3.auxiliary.AbstractAuxiliaryCacheAttributes

org.apache.commons.jcs3.auxiliary.disk.AbstractDiskCacheAttributes

org.apache.commons.jcs3.auxiliary.disk.indexed.IndexedDiskCacheAttributes

All Implemented Interfaces:

Serializable, Cloneable, AuxiliaryCacheAttributes, IDiskCacheAttributes

public class IndexedDiskCacheAttributes
extends AbstractDiskCacheAttributes

Configuration class for the Indexed Disk Cache

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.commons.jcs3.auxiliary.disk.behavior.IDiskCacheAttributes

IDiskCacheAttributes.DiskLimitType

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_CLEAR_DISK_ON_STARTUP	Should we clear the disk on startup.
static final boolean	DEFAULT_OPTIMIZE_ON_SHUTDOWN	Should we optimize on shutdown.

Fields inherited from interface org.apache.commons.jcs3.auxiliary.disk.behavior.IDiskCacheAttributes

MAX_PURGATORY_SIZE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
IndexedDiskCacheAttributes()	Constructor for the DiskCacheAttributes object

Method Summary

Modifier and Type	Method	Description
int	getMaxKeySize()	Gets the maxKeySize attribute of the DiskCacheAttributes object
int	getOptimizeAtRemoveCount()	Gets the optimizeAtRemoveCount attribute of the DiskCacheAttributes object
boolean	isClearDiskOnStartup()
boolean	isOptimizeOnShutdown()
void	setClearDiskOnStartup(boolean clearDiskOnStartup)
void	setMaxKeySize(int maxKeySize)	Sets the maxKeySize attribute of the DiskCacheAttributes object
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)
String	toString()	Write out the values for debugging purposes.

Methods inherited from class org.apache.commons.jcs3.auxiliary.disk.AbstractDiskCacheAttributes

getDiskLimitType, getDiskPath, getMaxPurgatorySize, getShutdownSpoolTimeLimit, isAllowRemoveAll, setAllowRemoveAll, setDiskLimitType, setDiskLimitTypeName, setDiskPath, setDiskPath, setMaxPurgatorySize, setShutdownSpoolTimeLimit

Methods inherited from class org.apache.commons.jcs3.auxiliary.AbstractAuxiliaryCacheAttributes

clone, getCacheName, getEventQueuePoolName, getEventQueueType, getName, setCacheName, setEventQueuePoolName, setEventQueueType, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.commons.jcs3.auxiliary.AuxiliaryCacheAttributes

clone, getCacheName, getEventQueuePoolName, getEventQueueType, getName, setCacheName, setEventQueuePoolName, setEventQueueType, setName

Field Details

DEFAULT_OPTIMIZE_ON_SHUTDOWN

public static final boolean DEFAULT_OPTIMIZE_ON_SHUTDOWN

Should we optimize on shutdown.

See Also:

• Constant Field Values

DEFAULT_CLEAR_DISK_ON_STARTUP

public static final boolean DEFAULT_CLEAR_DISK_ON_STARTUP

Should we clear the disk on startup.

See Also:

• Constant Field Values

Constructor Details

IndexedDiskCacheAttributes

public IndexedDiskCacheAttributes()

Constructor for the DiskCacheAttributes object

Method Details

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

setOptimizeOnShutdown

public void setOptimizeOnShutdown(boolean optimizeOnShutdown)

Parameters:

optimizeOnShutdown - The optimizeOnShutdown to set.

isOptimizeOnShutdown

public boolean isOptimizeOnShutdown()

Returns:

Returns the optimizeOnShutdown.

setClearDiskOnStartup

public void setClearDiskOnStartup(boolean clearDiskOnStartup)

Parameters:

clearDiskOnStartup - the clearDiskOnStartup to set

isClearDiskOnStartup

public boolean isClearDiskOnStartup()

Returns:

the clearDiskOnStartup

toString

public String toString()

Write out the values for debugging purposes.

Overrides:

toString in class AbstractDiskCacheAttributes

Returns:

String