IBM WebSphere® DataPower® XC10 Appliance
Release 2.0 Client API Specification

com.ibm.websphere.objectgrid.plugins
Interface CacheEntry

All Superinterfaces:
java.io.Serializable

public interface CacheEntry
extends java.io.Serializable

This interface represents a cache entry in an ObjectGrid map.

Since:
WAS XD 6.0, XC10

Method Summary
 java.lang.Object getCommittedValue()
          Returns the committed value for this entry.
 java.lang.Object getKey()
          Returns the key for this entry.
 java.util.Collection getKeywords()
          Returns the list of keywords associated with this entry.
 long getLastAccessTime()
          Returns the last time this entry was accessed.
 long getTTL()
          Returns the time-to-live value for this entry.
 boolean isInBackingMap()
          Indicates whether this entry is in the BackingMap
 

Method Detail

isInBackingMap

boolean isInBackingMap()
Indicates whether this entry is in the BackingMap

Returns:
Returns true if this element is in the BackingMap

getKey

java.lang.Object getKey()
Returns the key for this entry.

For a CacheEntry on an ObjectMap that is configured to use a KeySerializerPlugin, the value will be a SerializedKey object. If required, you can use the SerializedEntry.getObject() method to retrieve (possibly inflating the serialized object) the original key object.

Returns:
the key

getCommittedValue

java.lang.Object getCommittedValue()
Returns the committed value for this entry.

The type of the object returned from the getCommittedValue() method depends on various configuration and storage options used by the ObjectMap that holds the CacheEntry. In the default case, getCommittedValue() returns the Java object of the same type that was put into the map. For an ObjectMap that is configured to use a ValueSerializerPlugin, the committed value depends on the underlying storage mechanism, typically represented as an array of bytes.

Returns:
the committed value

getTTL

long getTTL()
Returns the time-to-live value for this entry.

Returns:
the time-to-live value

getLastAccessTime

long getLastAccessTime()
Returns the last time this entry was accessed.

Returns:
last access time.

getKeywords

java.util.Collection getKeywords()
Returns the list of keywords associated with this entry.

Returns:
a list of keywords

IBM WebSphere® DataPower® XC10 Appliance
Release 2.0 Client API Specification

© Copyright International Business Machines Corp 2005,2011. All rights reserved.