org.apache.jcs.auxiliary.disk
Class PurgatoryElement<K extends Serializable,V extends Serializable>

java.lang.Object
  org.apache.jcs.auxiliary.disk.PurgatoryElement<K,V>

All Implemented Interfaces:

Serializable, ICacheElement<K,V>

public class PurgatoryElement<K extends Serializable,V extends Serializable>
extends Object
implements ICacheElement<K,V>, Serializable

Wrapper for cache elements in purgatory.

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

See Also:

Serialized Form

spoolable

protected boolean spoolable

Is the element ready to be spooled?

cacheElement

protected ICacheElement<K extends Serializable,V extends Serializable> cacheElement

Wrapped cache Element

PurgatoryElement

public PurgatoryElement(ICacheElement<K,V> cacheElement)

Constructor for the PurgatoryElement object

Parameters:

cacheElement - CacheElement to wrap.

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 interface: ICacheElement

Gets the cacheName attribute of the ICacheElement object. The cacheName is also known as the region name.

Specified by:

getCacheName in interface ICacheElement<K extends Serializable,V extends Serializable>

Returns:

cacheElement.getCacheName();

See Also:

ICacheElement.getCacheName()

getKey

public K getKey()

Description copied from interface: ICacheElement

Gets the key attribute of the ICacheElement object

Specified by:

getKey in interface ICacheElement<K extends Serializable,V extends Serializable>

Returns:

cacheElement.getKey();

See Also:

ICacheElement.getKey()

getVal

public V getVal()

Description copied from interface: ICacheElement

Gets the val attribute of the ICacheElement object

Specified by:

getVal in interface ICacheElement<K extends Serializable,V extends Serializable>

Returns:

cacheElement.getVal();

See Also:

ICacheElement.getVal()

getElementAttributes

public IElementAttributes getElementAttributes()

Description copied from interface: ICacheElement

Gets the attributes attribute of the ICacheElement object

Specified by:

getElementAttributes in interface ICacheElement<K extends Serializable,V extends Serializable>

Returns:

cacheElement.getElementAttributes();

See Also:

ICacheElement.getElementAttributes()

setElementAttributes

public void setElementAttributes(IElementAttributes attr)

Description copied from interface: ICacheElement

Sets the attributes attribute of the ICacheElement object

Specified by:

setElementAttributes in interface ICacheElement<K extends Serializable,V extends Serializable>

Parameters:

attr -

See Also:

ICacheElement.setElementAttributes(org.apache.jcs.engine.behavior.IElementAttributes)

toString

public String toString()

Overrides:

toString in class Object

Returns:

debug string