org.infinispan.container.entries

Class AbstractInternalCacheEntry

java.lang.Object

org.infinispan.container.entries.AbstractInternalCacheEntry

All Implemented Interfaces:

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

Direct Known Subclasses:

ImmortalCacheEntry, MetadataMortalCacheEntry, MetadataTransientCacheEntry, MetadataTransientMortalCacheEntry, MortalCacheEntry, TransientCacheEntry, TransientMortalCacheEntry

public abstract class AbstractInternalCacheEntry
extends Object
implements InternalCacheEntry

An abstract internal cache entry that is typically stored in the data container

Since:

4.0

Author:

Manik Surtani

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	key

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractInternalCacheEntry()
protected	AbstractInternalCacheEntry(Object key)

Method Summary

Methods

Modifier and Type	Method and Description
AbstractInternalCacheEntry	clone()
void	commit(DataContainer container, Metadata metadata) Commits changes
Object	getKey() Retrieves the key to this entry
Metadata	getMetadata() Get metadata of this cache entry.
boolean	isChanged()
boolean	isCreated()
boolean	isEvicted()
boolean	isLoaded()
boolean	isNull() Tests whether the entry represents a null value, typically used for repeatable read.
boolean	isRemoved()
boolean	isValid()
void	rollback() Rolls back changes
void	setChanged(boolean changed)
void	setCreated(boolean created)
void	setEvicted(boolean evicted)
void	setLoaded(boolean loaded)
void	setMetadata(Metadata metadata) Set the metadata in the cache entry.
void	setRemoved(boolean removed)
void	setSkipLookup(boolean skipLookup) See CacheEntry.skipLookup().
void	setValid(boolean valid)
boolean	skipLookup()
String	toString()
boolean	undelete(boolean doUndelete) If the entry is marked as removed and doUndelete==true then the "valid" flag is set to true and "removed" flag is set to false.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.container.entries.InternalCacheEntry

canExpire, getCreated, getExpiryTime, getLastUsed, isExpired, isExpired, reincarnate, reincarnate, toInternalCacheValue, touch, touch

Methods inherited from interface org.infinispan.container.entries.CacheEntry

getLifespan, getMaxIdle, getValue, setValue

Methods inherited from interface java.util.Map.Entry

equals, hashCode

Field Detail

key

protected Object key

Constructor Detail

AbstractInternalCacheEntry

protected AbstractInternalCacheEntry()

AbstractInternalCacheEntry

protected AbstractInternalCacheEntry(Object key)

Method Detail

commit

public final void commit(DataContainer container,
          Metadata metadata)

Description copied from interface: CacheEntry

Commits changes

Specified by:

commit in interface CacheEntry

Parameters:

container - data container to commit to

rollback

public final void rollback()

Description copied from interface: CacheEntry

Rolls back changes

Specified by:

rollback in interface CacheEntry

setChanged

public void setChanged(boolean changed)

Specified by:

setChanged in interface CacheEntry

setCreated

public final void setCreated(boolean created)

Specified by:

setCreated in interface CacheEntry

setRemoved

public final void setRemoved(boolean removed)

Specified by:

setRemoved in interface CacheEntry

setEvicted

public final void setEvicted(boolean evicted)

Specified by:

setEvicted in interface CacheEntry

setValid

public final void setValid(boolean valid)

Specified by:

setValid in interface CacheEntry

setLoaded

public void setLoaded(boolean loaded)

Specified by:

setLoaded in interface CacheEntry

setSkipLookup

public void setSkipLookup(boolean skipLookup)

Description copied from interface: CacheEntry

See CacheEntry.skipLookup().

Specified by:

setSkipLookup in interface CacheEntry

isNull

public final boolean isNull()

Description copied from interface: CacheEntry

Tests whether the entry represents a null value, typically used for repeatable read.

Specified by:

isNull in interface CacheEntry

Returns:

true if this represents a null, false otherwise.

isChanged

public final boolean isChanged()

Specified by:

isChanged in interface CacheEntry

Returns:

true if this entry has changed since being read from the container, false otherwise.

isCreated

public final boolean isCreated()

Specified by:

isCreated in interface CacheEntry

Returns:

true if this entry has been newly created, false otherwise.

isRemoved

public final boolean isRemoved()

Specified by:

isRemoved in interface CacheEntry

Returns:

true if this entry has been removed since being read from the container, false otherwise.

isEvicted

public final boolean isEvicted()

Specified by:

isEvicted in interface CacheEntry

Returns:

true if this entry has been evicted since being read from the container, false otherwise.

isValid

public final boolean isValid()

Specified by:

isValid in interface CacheEntry

Returns:

true if this entry is still valid, false otherwise.

isLoaded

public boolean isLoaded()

Specified by:

isLoaded in interface CacheEntry

Returns:

true if the entry was loaded from a cache store.

skipLookup

public boolean skipLookup()

Specified by:

skipLookup in interface CacheEntry

Returns:

true if the value must not be fetch from an external source

undelete

public boolean undelete(boolean doUndelete)

Description copied from interface: CacheEntry

If the entry is marked as removed and doUndelete==true then the "valid" flag is set to true and "removed" flag is set to false.

Specified by:

undelete in interface CacheEntry

getMetadata

public Metadata getMetadata()

Description copied from interface: MetadataAware

Get metadata of this cache entry.

Specified by:

getMetadata in interface MetadataAware

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

Parameters:

metadata - to apply to the cache entry

getKey

public final Object getKey()

Description copied from interface: CacheEntry

Retrieves the key to this entry

Specified by:

getKey in interface Map.Entry<Object,Object>

Specified by:

getKey in interface CacheEntry

Returns:

a key

toString

public String toString()

Overrides:

toString in class Object

clone

public AbstractInternalCacheEntry clone()

Specified by:

clone in interface InternalCacheEntry

Overrides:

clone in class Object