org.apache.commons.jcs3.auxiliary.disk

Class PurgatoryElement<K,V>

java.lang.Object

org.apache.commons.jcs3.engine.CacheElement<K,V>

org.apache.commons.jcs3.auxiliary.disk.PurgatoryElement<K,V>

All Implemented Interfaces:

Serializable, ICacheElement<K,V>

public class PurgatoryElement<K,V>
extends CacheElement<K,V>

Implementation of cache elements in purgatory. Elements are stored in purgatory when they are spooled to the auxiliary cache, but have not yet been written to disk.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PurgatoryElement(ICacheElement<K,V> cacheElement) Constructor for the PurgatoryElement<K, V> object

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
ICacheElement<K,V>	getCacheElement() Get the wrapped cache element.
String	getCacheName() Gets the cacheName attribute of the CacheElement object
IElementAttributes	getElementAttributes() Gets the IElementAttributes attribute of the CacheElement object
K	getKey() Gets the key attribute of the CacheElement object
V	getVal() Gets the val attribute of the CacheElement object
int	hashCode()
boolean	isSpoolable() Gets the spoolable property.
void	setElementAttributes(IElementAttributes attr) Sets the attributes attribute of the CacheElement object
void	setSpoolable(boolean spoolable) Sets the spoolable property.
String	toString() For debugging only.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PurgatoryElement

public PurgatoryElement(ICacheElement<K,V> cacheElement)

Constructor for the PurgatoryElement<K, V> object

Parameters:

cacheElement - CacheElement

Method Detail

isSpoolable

public boolean isSpoolable()

Gets the spoolable property.

Returns:

The spoolable value

setSpoolable

public void setSpoolable(boolean spoolable)

Sets the spoolable property.

Parameters:

spoolable - The new spoolable value

getCacheElement

public ICacheElement<K,V> getCacheElement()

Get the wrapped cache element.

Returns:

ICacheElement

getCacheName

public String getCacheName()

Description copied from class: CacheElement

Gets the cacheName attribute of the CacheElement object

Specified by:

getCacheName in interface ICacheElement<K,V>

Overrides:

getCacheName in class CacheElement<K,V>

Returns:

cacheElement.getCacheName();

See Also:

ICacheElement.getCacheName()

getKey

public K getKey()

Description copied from class: CacheElement

Gets the key attribute of the CacheElement object

Specified by:

getKey in interface ICacheElement<K,V>

Overrides:

getKey in class CacheElement<K,V>

Returns:

cacheElement.getKey();

See Also:

ICacheElement.getKey()

getVal

public V getVal()

Description copied from class: CacheElement

Gets the val attribute of the CacheElement object

Specified by:

getVal in interface ICacheElement<K,V>

Overrides:

getVal in class CacheElement<K,V>

Returns:

cacheElement.getVal();

See Also:

ICacheElement.getVal()

getElementAttributes

public IElementAttributes getElementAttributes()

Description copied from class: CacheElement

Gets the IElementAttributes attribute of the CacheElement object

Specified by:

getElementAttributes in interface ICacheElement<K,V>

Overrides:

getElementAttributes in class CacheElement<K,V>

Returns:

cacheElement.getElementAttributes();

See Also:

ICacheElement.getElementAttributes()

setElementAttributes

public void setElementAttributes(IElementAttributes attr)

Description copied from class: CacheElement

Sets the attributes attribute of the CacheElement object

Specified by:

setElementAttributes in interface ICacheElement<K,V>

Overrides:

setElementAttributes in class CacheElement<K,V>

Parameters:

attr -

See Also:

ICacheElement.setElementAttributes(org.apache.commons.jcs3.engine.behavior.IElementAttributes)

equals

public boolean equals(Object obj)

Overrides:

equals in class CacheElement<K,V>

Parameters:

obj - other object

Returns:

true if this object key equals the key of obj

hashCode

public int hashCode()

Overrides:

hashCode in class CacheElement<K,V>

Returns:

a hash of the key only

toString

public String toString()

Description copied from class: CacheElement

For debugging only.

Overrides:

toString in class CacheElement<K,V>

Returns:

debug string