org.apache.jcs.engine
Class CacheElement

java.lang.Object
  extended byorg.apache.jcs.engine.CacheElement
All Implemented Interfaces:
ICacheElement, java.io.Serializable

public class CacheElement
extends java.lang.Object
implements ICacheElement, java.io.Serializable

Generic element wrapper. Often stuffed inside another.

Author:
asmuts
See Also:
Serialized Form

Field Summary
 ElementAttributes attr
          Description of the Field
 java.lang.String cacheName
          Description of the Field
 java.io.Serializable key
          Description of the Field
 java.io.Serializable val
          Description of the Field
 
Constructor Summary
CacheElement(java.lang.String cacheName, java.io.Serializable key, java.lang.Object val)
          Constructor for the CacheElement object
CacheElement(java.lang.String cacheName, java.io.Serializable key, java.io.Serializable val)
          Constructor for the CacheElement object
 
Method Summary
 java.lang.String getCacheName()
          Gets the cacheName attribute of the CacheElement object
 IElementAttributes getElementAttributes()
          Gets the IElementAttributes attribute of the CacheElement object
 java.io.Serializable getKey()
          Gets the key attribute of the CacheElement object
 java.io.Serializable getVal()
          Gets the val attribute of the CacheElement object
 int hashCode()
          Description of the Method
 void setElementAttributes(IElementAttributes attr)
          Sets the attributes attribute of the CacheElement object
 java.lang.String toString()
          Description of the Method
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

cacheName

public final java.lang.String cacheName
Description of the Field


key

public final java.io.Serializable key
Description of the Field


val

public final java.io.Serializable val
Description of the Field


attr

public ElementAttributes attr
Description of the Field

Constructor Detail

CacheElement

public CacheElement(java.lang.String cacheName,
                    java.io.Serializable key,
                    java.io.Serializable val)
Constructor for the CacheElement object

Parameters:
cacheName -
key -
val -

CacheElement

public CacheElement(java.lang.String cacheName,
                    java.io.Serializable key,
                    java.lang.Object val)
Constructor for the CacheElement object

Parameters:
cacheName -
key -
val -
Method Detail

getCacheName

public java.lang.String getCacheName()
Gets the cacheName attribute of the CacheElement object

Specified by:
getCacheName in interface ICacheElement
Returns:
The cacheName value

getKey

public java.io.Serializable getKey()
Gets the key attribute of the CacheElement object

Specified by:
getKey in interface ICacheElement
Returns:
The key value

getVal

public java.io.Serializable getVal()
Gets the val attribute of the CacheElement object

Specified by:
getVal in interface ICacheElement
Returns:
The val value

setElementAttributes

public void setElementAttributes(IElementAttributes attr)
Sets the attributes attribute of the CacheElement object

Specified by:
setElementAttributes in interface ICacheElement
Parameters:
attr - The new IElementAttributes value

getElementAttributes

public IElementAttributes getElementAttributes()
Gets the IElementAttributes attribute of the CacheElement object

Specified by:
getElementAttributes in interface ICacheElement
Returns:
The IElementAttributes value

hashCode

public int hashCode()
Description of the Method


toString

public java.lang.String toString()
Description of the Method