org.infinispan.container.entries.metadata

Class MetadataTransientMortalCacheEntry

java.lang.Object

org.infinispan.container.entries.AbstractInternalCacheEntry

org.infinispan.container.entries.metadata.MetadataTransientMortalCacheEntry

All Implemented Interfaces:

Cloneable, Map.Entry<Object,Object>, CacheEntry, InternalCacheEntry, MetadataAware

public class MetadataTransientMortalCacheEntry
extends AbstractInternalCacheEntry
implements MetadataAware

A form of TransientMortalCacheEntry that is Versioned

Since:

5.1

Author:

Manik Surtani

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetadataTransientMortalCacheEntry.Externalizer

Field Summary

Fields inherited from class org.infinispan.container.entries.AbstractInternalCacheEntry

key

Constructor Summary

Constructors

Constructor and Description
MetadataTransientMortalCacheEntry(Object key, Object value, Metadata metadata, long now)
MetadataTransientMortalCacheEntry(Object key, Object value, Metadata metadata, long lastUsed, long created)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canExpire()
long	getCreated()
long	getExpiryTime() Only used with entries that have a lifespan, this determines when an entry is due to expire.
long	getLastUsed()
long	getLifespan()
long	getMaxIdle()
Metadata	getMetadata() Get metadata of this cache entry.
Object	getValue() Retrieves the value of this entry
boolean	isExpired()
boolean	isExpired(long now)
void	reincarnate() "Reincarnates" an entry.
void	reincarnate(long now) "Reincarnates" an entry.
void	setMetadata(Metadata metadata) Set the metadata in the cache entry.
Object	setValue(Object value) Sets the value of the entry, returning the previous value
InternalCacheValue	toInternalCacheValue() Creates a representation of this entry as an InternalCacheValue.
void	touch() Updates access timestamps on this instance
void	touch(long currentTimeMillis) Updates access timestamps on this instance to a specified time

Methods inherited from class org.infinispan.container.entries.AbstractInternalCacheEntry

clone, commit, getKey, isChanged, isCreated, isEvicted, isLoaded, isNull, isRemoved, isValid, rollback, setChanged, setCreated, setEvicted, setLoaded, setRemoved, setSkipLookup, setValid, skipLookup, toString, undelete

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map.Entry

equals, hashCode

Constructor Detail

MetadataTransientMortalCacheEntry

public MetadataTransientMortalCacheEntry(Object key,
                                 Object value,
                                 Metadata metadata,
                                 long now)

MetadataTransientMortalCacheEntry

public MetadataTransientMortalCacheEntry(Object key,
                                 Object value,
                                 Metadata metadata,
                                 long lastUsed,
                                 long created)

Method Detail

getValue

public Object getValue()

Description copied from interface: CacheEntry

Retrieves the value of this entry

Specified by:

getValue in interface Map.Entry<Object,Object>

Specified by:

getValue in interface CacheEntry

Returns:

the value of the entry

getLifespan

public long getLifespan()

Specified by:

getLifespan in interface CacheEntry

Returns:

retrieves the lifespan of this entry. -1 means an unlimited lifespan.

canExpire

public final boolean canExpire()

Specified by:

canExpire in interface InternalCacheEntry

Returns:

true if the entry can expire, false otherwise

getCreated

public long getCreated()

Specified by:

getCreated in interface InternalCacheEntry

Returns:

timestamp when the entry was created

isExpired

public boolean isExpired(long now)

Specified by:

isExpired in interface InternalCacheEntry

Parameters:

now - the current time as defined by System.currentTimeMillis() or TimeService.wallClockTime()

Returns:

true if the entry has expired; false otherwise

isExpired

public boolean isExpired()

Specified by:

isExpired in interface InternalCacheEntry

Returns:

true if the entry has expired; false otherwise

getExpiryTime

public final long getExpiryTime()

Description copied from interface: InternalCacheEntry

Only used with entries that have a lifespan, this determines when an entry is due to expire.

Specified by:

getExpiryTime in interface InternalCacheEntry

Returns:

timestamp when the entry is due to expire, or -1 if it doesn't have a lifespan

toInternalCacheValue

public InternalCacheValue toInternalCacheValue()

Description copied from interface: InternalCacheEntry

Creates a representation of this entry as an InternalCacheValue. The main purpose of this is to provide a representation that does not have a reference to the key. This is useful in situations where the key is already known or stored elsewhere, making serialization and deserialization more efficient.

Note that this should not be used to optimize memory overhead, since the saving of an additional reference to a key (a single object reference) does not warrant the cost of constructing an InternalCacheValue. This only makes sense when marshalling is involved, since the cost of marshalling the key again can be sidestepped using an InternalCacheValue if the key is already known/marshalled.

Specified by:

toInternalCacheValue in interface InternalCacheEntry

Returns:

a new InternalCacheValue encapsulating this InternalCacheEntry's value and expiration information.

getLastUsed

public long getLastUsed()

Specified by:

getLastUsed in interface InternalCacheEntry

Returns:

timestamp when the entry was last used

touch

public final void touch()

Description copied from interface: InternalCacheEntry

Updates access timestamps on this instance

Specified by:

touch in interface InternalCacheEntry

touch

public final void touch(long currentTimeMillis)

Description copied from interface: InternalCacheEntry

Updates access timestamps on this instance to a specified time

Specified by:

touch in interface InternalCacheEntry

Parameters:

currentTimeMillis - the current time as defined by System.currentTimeMillis() or TimeService.wallClockTime()

reincarnate

public final void reincarnate()

Description copied from interface: InternalCacheEntry

"Reincarnates" an entry. Essentially, resets the 'created' timestamp of the entry to the current time.

Specified by:

reincarnate in interface InternalCacheEntry

reincarnate

public void reincarnate(long now)

Description copied from interface: InternalCacheEntry

"Reincarnates" an entry. Essentially, resets the 'created' timestamp of the entry to the current time.

Specified by:

reincarnate in interface InternalCacheEntry

Parameters:

now - the current time as defined by System.currentTimeMillis() or TimeService.wallClockTime()

getMaxIdle

public long getMaxIdle()

Specified by:

getMaxIdle in interface CacheEntry

Returns:

the maximum allowed time for which this entry can be idle, after which it is considered expired.

setValue

public Object setValue(Object value)

Description copied from interface: CacheEntry

Sets the value of the entry, returning the previous value

Specified by:

setValue in interface Map.Entry<Object,Object>

Specified by:

setValue in interface CacheEntry

Parameters:

value - value to set

Returns:

previous value

getMetadata

public Metadata getMetadata()

Description copied from interface: MetadataAware

Get metadata of this cache entry.

Specified by:

getMetadata in interface MetadataAware

Overrides:

getMetadata in class AbstractInternalCacheEntry

Returns:

a Metadata instance

setMetadata

public void setMetadata(Metadata metadata)

Description copied from interface: MetadataAware

Set the metadata in the cache entry.

Specified by:

setMetadata in interface MetadataAware

Overrides:

setMetadata in class AbstractInternalCacheEntry

Parameters:

metadata - to apply to the cache entry