org.apache.jcs.auxiliary.disk
Class PurgatoryElement

java.lang.Object
  extended byorg.apache.jcs.auxiliary.disk.PurgatoryElement
All Implemented Interfaces:
ICacheElement, java.io.Serializable

public class PurgatoryElement
extends java.lang.Object
implements ICacheElement, java.io.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.

Version:
$Id: PurgatoryElement.java 374736 2006-02-03 20:11:22Z asmuts $
See Also:
Serialized Form

Field Summary
protected  ICacheElement cacheElement
          Wrapped cache Element
protected  boolean spoolable
          Is the element ready to be spooled?
 
Constructor Summary
PurgatoryElement(ICacheElement cacheElement)
          Constructor for the PurgatoryElement object
 
Method Summary
 ICacheElement getCacheElement()
          Get the wrapped cache element.
 java.lang.String getCacheName()
          Gets the cacheName attribute of the ICacheElement object.
 IElementAttributes getElementAttributes()
          Gets the attributes attribute of the ICacheElement object
 java.io.Serializable getKey()
          Gets the key attribute of the ICacheElement object
 java.io.Serializable getVal()
          Gets the val attribute of the ICacheElement object
 boolean isSpoolable()
          Gets the spoolable property.
 void setElementAttributes(IElementAttributes attr)
          Sets the attributes attribute of the ICacheElement object
 void setSpoolable(boolean spoolable)
          Sets the spoolable property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

spoolable

protected boolean spoolable
Is the element ready to be spooled?


cacheElement

protected ICacheElement cacheElement
Wrapped cache Element

Constructor Detail

PurgatoryElement

public PurgatoryElement(ICacheElement cacheElement)
Constructor for the PurgatoryElement object

Parameters:
cacheElement - CacheElement to wrap.
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 getCacheElement()
Get the wrapped cache element.

Returns:
ICacheElement

getCacheName

public java.lang.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
Returns:
The cacheName value
See Also:
ICacheElement.getCacheName()

getKey

public java.io.Serializable getKey()
Description copied from interface: ICacheElement
Gets the key attribute of the ICacheElement object

Specified by:
getKey in interface ICacheElement
Returns:
The key value
See Also:
ICacheElement.getKey()

getVal

public java.io.Serializable getVal()
Description copied from interface: ICacheElement
Gets the val attribute of the ICacheElement object

Specified by:
getVal in interface ICacheElement
Returns:
The val value
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
Returns:
The attributes value
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
Parameters:
attr -
See Also:
ICacheElement.setElementAttributes(org.apache.jcs.engine.behavior.IElementAttributes)


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