org.infinispan.container.entries

Class DeltaAwareCacheEntry<K>

java.lang.Object

org.infinispan.container.entries.DeltaAwareCacheEntry<K>

All Implemented Interfaces:

Cloneable, Map.Entry<K,DeltaAware>, CacheEntry<K,DeltaAware>, MetadataAware, StateChangingEntry

public class DeltaAwareCacheEntry<K>
extends Object
implements CacheEntry<K,DeltaAware>, StateChangingEntry

A wrapper around a cached entry that encapsulates DeltaAware and Delta semantics when writes are initiated, committed or rolled back.

Since:

5.1

Author:

Manik Surtani (manik@jboss.org)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DeltaAwareCacheEntry.Flags

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Delta>	deltas
protected byte	flags
protected K	key
protected DeltaAware	oldValue
protected AtomicHashMap<K,?>	uncommittedChanges
protected DeltaAware	value
protected CacheEntry<K,DeltaAware>	wrappedEntry

Constructor Summary

Constructors

Constructor and Description
DeltaAwareCacheEntry(K key, DeltaAware value, CacheEntry<K,DeltaAware> wrappedEntry)

Method Summary

Modifier and Type	Method and Description
void	appendDelta(Delta d)
DeltaAwareCacheEntry<K>	clone()
void	commit(DataContainer<K,DeltaAware> container, Metadata metadata) Commits changes
void	copyStateFlagsFrom(StateChangingEntry other)
K	getKey() Retrieves the key to this entry
long	getLifespan()
long	getMaxIdle()
Metadata	getMetadata() Get metadata of this cache entry.
byte	getStateFlags()
AtomicHashMap<?,?>	getUncommittedChages()
DeltaAware	getValue() Retrieves the value of this entry
boolean	isChanged()
boolean	isCreated()
boolean	isEvicted()
protected boolean	isFlagSet(DeltaAwareCacheEntry.Flags flag) Tests whether a flag is set.
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)
protected void	setFlag(DeltaAwareCacheEntry.Flags flag) Utility method that sets the value of the given flag to true.
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)
DeltaAware	setValue(DeltaAware value) Sets the value of the entry, returning the previous value
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.
protected void	unsetFlag(DeltaAwareCacheEntry.Flags flag) Utility method that sets the value of the flag to false.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map.Entry

comparingByKey, comparingByKey, comparingByValue, comparingByValue, equals, hashCode

Field Detail

key

protected K key

wrappedEntry

protected CacheEntry<K,DeltaAware> wrappedEntry

value

protected DeltaAware value

oldValue

protected DeltaAware oldValue

deltas

protected final List<Delta> deltas

flags

protected byte flags

uncommittedChanges

protected AtomicHashMap<K,?> uncommittedChanges

Constructor Detail

DeltaAwareCacheEntry

public DeltaAwareCacheEntry(K key,
                            DeltaAware value,
                            CacheEntry<K,DeltaAware> wrappedEntry)

Method Detail

getStateFlags

public byte getStateFlags()

Specified by:

getStateFlags in interface StateChangingEntry

copyStateFlagsFrom

public void copyStateFlagsFrom(StateChangingEntry other)

Specified by:

copyStateFlagsFrom in interface StateChangingEntry

appendDelta

public void appendDelta(Delta d)

getUncommittedChages

public AtomicHashMap<?,?> getUncommittedChages()

isFlagSet

protected final boolean isFlagSet(DeltaAwareCacheEntry.Flags flag)

Tests whether a flag is set.

Parameters:

flag - flag to test

Returns:

true if set, false otherwise.

setFlag

protected final void setFlag(DeltaAwareCacheEntry.Flags flag)

Utility method that sets the value of the given flag to true.

Parameters:

flag - flag to set

unsetFlag

protected final void unsetFlag(DeltaAwareCacheEntry.Flags flag)

Utility method that sets the value of the flag to false.

Parameters:

flag - flag to unset

getLifespan

public final long getLifespan()

Specified by:

getLifespan in interface CacheEntry<K,DeltaAware>

Returns:

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

getMaxIdle

public final long getMaxIdle()

Specified by:

getMaxIdle in interface CacheEntry<K,DeltaAware>

Returns:

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

skipLookup

public boolean skipLookup()

Specified by:

skipLookup in interface CacheEntry<K,DeltaAware>

Returns:

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

getKey

public final K getKey()

Description copied from interface: CacheEntry

Retrieves the key to this entry

Specified by:

getKey in interface Map.Entry<K,DeltaAware>

Specified by:

getKey in interface CacheEntry<K,DeltaAware>

Returns:

a key

getValue

public final DeltaAware getValue()

Description copied from interface: CacheEntry

Retrieves the value of this entry

Specified by:

getValue in interface Map.Entry<K,DeltaAware>

Specified by:

getValue in interface CacheEntry<K,DeltaAware>

Returns:

the value of the entry

setValue

public final DeltaAware setValue(DeltaAware value)

Description copied from interface: CacheEntry

Sets the value of the entry, returning the previous value

Specified by:

setValue in interface Map.Entry<K,DeltaAware>

Specified by:

setValue in interface CacheEntry<K,DeltaAware>

Parameters:

value - value to set

Returns:

previous value

isNull

public 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<K,DeltaAware>

Returns:

true if this represents a null, false otherwise.

commit

public final void commit(DataContainer<K,DeltaAware> container,
                         Metadata metadata)

Description copied from interface: CacheEntry

Commits changes

Specified by:

commit in interface CacheEntry<K,DeltaAware>

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<K,DeltaAware>

isChanged

public final boolean isChanged()

Specified by:

isChanged in interface CacheEntry<K,DeltaAware>

Returns:

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

setChanged

public final void setChanged(boolean changed)

Specified by:

setChanged in interface CacheEntry<K,DeltaAware>

isValid

public boolean isValid()

Specified by:

isValid in interface CacheEntry<K,DeltaAware>

Returns:

true if this entry is still valid, false otherwise.

setValid

public final void setValid(boolean valid)

Specified by:

setValid in interface CacheEntry<K,DeltaAware>

isCreated

public final boolean isCreated()

Specified by:

isCreated in interface CacheEntry<K,DeltaAware>

Returns:

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

setCreated

public final void setCreated(boolean created)

Specified by:

setCreated in interface CacheEntry<K,DeltaAware>

isRemoved

public boolean isRemoved()

Specified by:

isRemoved in interface CacheEntry<K,DeltaAware>

Returns:

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

isEvicted

public boolean isEvicted()

Specified by:

isEvicted in interface CacheEntry<K,DeltaAware>

Returns:

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

setRemoved

public final void setRemoved(boolean removed)

Specified by:

setRemoved in interface CacheEntry<K,DeltaAware>

setEvicted

public void setEvicted(boolean evicted)

Specified by:

setEvicted in interface CacheEntry<K,DeltaAware>

isLoaded

public boolean isLoaded()

Specified by:

isLoaded in interface CacheEntry<K,DeltaAware>

setLoaded

public void setLoaded(boolean loaded)

Specified by:

setLoaded in interface CacheEntry<K,DeltaAware>

setSkipLookup

public void setSkipLookup(boolean skipLookup)

Description copied from interface: CacheEntry

See CacheEntry.skipLookup().

Specified by:

setSkipLookup in interface CacheEntry<K,DeltaAware>

toString

public String toString()

Overrides:

toString in class Object

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<K,DeltaAware>

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

clone

public DeltaAwareCacheEntry<K> clone()

Specified by:

clone in interface CacheEntry<K,DeltaAware>

Overrides:

clone in class Object