org.apache.jcs.engine.behavior
Interface ICacheElementSerialized

All Superinterfaces:

ICacheElement, java.io.Serializable

All Known Implementing Classes:

CacheElementSerialized

public interface ICacheElementSerialized

extends ICacheElement

This interface defines the behavior of the serialized element wrapper.

The value is stored as a byte array. This should allow for a variety of serialization mechanisms.

This currently extends ICacheElement for backward compatibility.

Author:

Aaron Smuts

Method Summary

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 ICacheElementSerialized object.
byte[]	getSerializedValue() Gets the value attribute of the ICacheElementSerialized object.
void	setElementAttributes(IElementAttributes attr) Sets the attributes attribute of the ICacheElement object

Methods inherited from interface org.apache.jcs.engine.behavior.ICacheElement

getVal

Method Detail

getCacheName

public java.lang.String getCacheName()

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

getKey

public java.io.Serializable getKey()

Gets the key attribute of the ICacheElementSerialized object. This is the standard key that the value can be reference by.

Specified by:

getKey in interface ICacheElement

Returns:

The key value

getSerializedValue

public byte[] getSerializedValue()

Gets the value attribute of the ICacheElementSerialized object. This is the value the client cached seriailzed by some mechanism.

Returns:

The serialized value

getElementAttributes

public IElementAttributes getElementAttributes()

Gets the attributes attribute of the ICacheElement object

Specified by:

getElementAttributes in interface ICacheElement

Returns:

The attributes value

setElementAttributes

public void setElementAttributes(IElementAttributes attr)

Sets the attributes attribute of the ICacheElement object

Specified by:

setElementAttributes in interface ICacheElement

Parameters:

attr - The new attributes value