Package org.apache.commons.jcs3.engine

Class CacheElement<K,V>

java.lang.Object

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

All Implemented Interfaces:

Serializable, ICacheElement<K,V>

Direct Known Subclasses:

CacheElementSerialized, PurgatoryElement

public class CacheElement<K,V>
extends Object
implements ICacheElement<K,V>

Generic element wrapper. Often stuffed inside another.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CacheElement(String cacheName, K key, V val)	Constructor for the CacheElement object
CacheElement(String cacheName, K key, V val, IElementAttributes attrArg)	Constructor for the CacheElement object

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
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()
void	setElementAttributes(IElementAttributes attr)	Sets the attributes attribute of the CacheElement object
String	toString()	For debugging only.

Methods inherited from class java.lang.Object

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

Constructor Details

CacheElement

public CacheElement(String cacheName,
 K key,
 V val)

Constructor for the CacheElement object

Parameters:

cacheName -

key -

val -

CacheElement

public CacheElement(String cacheName,
 K key,
 V val,
 IElementAttributes attrArg)

Constructor for the CacheElement object

Parameters:

cacheName -

key -

val -

attrArg -

Method Details

getCacheName

public String getCacheName()

Gets the cacheName attribute of the CacheElement object

Specified by:

getCacheName in interface ICacheElement<K,V>

Returns:

The cacheName value

getKey

public K getKey()

Gets the key attribute of the CacheElement object

Specified by:

getKey in interface ICacheElement<K,V>

Returns:

The key value

getVal

public V getVal()

Gets the val attribute of the CacheElement object

Specified by:

getVal in interface ICacheElement<K,V>

Returns:

The val value

setElementAttributes

public void setElementAttributes(IElementAttributes attr)

Sets the attributes attribute of the CacheElement object

Specified by:

setElementAttributes in interface ICacheElement<K,V>

Parameters:

attr - The new IElementAttributes value

getElementAttributes

public IElementAttributes getElementAttributes()

Gets the IElementAttributes attribute of the CacheElement object

Specified by:

getElementAttributes in interface ICacheElement<K,V>

Returns:

The IElementAttributes value, never null

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Parameters:

obj - other object

Returns:

true if this object key equals the key of obj

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

a hash of the key only

toString

public String toString()

For debugging only.

Overrides:

toString in class Object

Returns:

String representation