org.infinispan.container.entries

Class ReadCommittedEntry

java.lang.Object

org.infinispan.container.entries.ReadCommittedEntry

All Implemented Interfaces:

Cloneable, Map.Entry, CacheEntry, MetadataAware, MVCCEntry

Direct Known Subclasses:

RepeatableReadEntry

public class ReadCommittedEntry
extends Object
implements MVCCEntry

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

Since:

4.0

Author:

Manik Surtani (manik@jboss.org)

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected long	created
protected short	flags
protected PrivateMetadata	internalMetadata
protected Object	key
protected long	lastUsed
protected Metadata	metadata
protected Object	value

Constructor Summary

Constructors

Constructor and Description
ReadCommittedEntry(Object key, Object value, Metadata metadata)

Method Summary

Modifier and Type	Method and Description
ReadCommittedEntry	clone()
void	commit(DataContainer container) Commits changes
CompletionStage<Void>	commit(int segment, InternalDataContainer container)
long	getCreated()
PrivateMetadata	getInternalMetadata()
Object	getKey() Retrieves the key to this entry
long	getLastUsed()
long	getLifespan()
long	getMaxIdle()
Metadata	getMetadata() Get metadata of this cache entry.
Object	getValue() Retrieves the value of this entry
boolean	isChanged()
boolean	isCommitted()
boolean	isCreated()
boolean	isEvicted()
boolean	isExpired() Returns whether this entry was marked as being expired or not
boolean	isLoaded()
boolean	isNull() Tests whether the entry represents a null value, typically used for repeatable read.
boolean	isRemoved()
boolean	isSkipSharedStore()
void	resetCurrentValue() Reset the current value of the entry to the value before the commmand was executed the first time.
void	setChanged(boolean changed)
void	setCommitted() Mark this context-entry as already committed to the DataContainer.
void	setCreated(boolean created)
void	setCreated(long created)
void	setEvicted(boolean evicted)
void	setExpired(boolean expired) Marks this entry as being expired.
protected void	setFlag(ReadCommittedEntry.Flags flag) Utility method that sets the value of the given flag to true.
void	setInternalMetadata(PrivateMetadata metadata)
void	setLastUsed(long lastUsed)
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	setSkipSharedStore()
Object	setValue(Object value) Sets the value of the entry, returning the previous value
boolean	skipLookup()
String	toString()
void	updatePreviousValue() Update the previous value of the entry - set it to current value.

Methods inherited from class java.lang.Object

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

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

isRead, setRead

Methods inherited from interface java.util.Map.Entry

comparingByKey, comparingByKey, comparingByValue, comparingByValue, equals, hashCode

Field Detail

key

protected Object key

value

protected Object value

created

protected long created

lastUsed

protected long lastUsed

flags

protected short flags

metadata

protected Metadata metadata

internalMetadata

protected PrivateMetadata internalMetadata

Constructor Detail

ReadCommittedEntry

public ReadCommittedEntry(Object key,
                          Object value,
                          Metadata metadata)

Method Detail

setFlag

protected final void setFlag(ReadCommittedEntry.Flags flag)

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

Parameters:

flag - flag to set

getLifespan

public final long getLifespan()

Specified by:

getLifespan in interface CacheEntry

Returns:

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

getMaxIdle

public final 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.

getKey

public final Object getKey()

Description copied from interface: CacheEntry

Retrieves the key to this entry

Specified by:

getKey in interface Map.Entry

Specified by:

getKey in interface CacheEntry

Returns:

a key

getValue

public final Object getValue()

Description copied from interface: CacheEntry

Retrieves the value of this entry

Specified by:

getValue in interface Map.Entry

Specified by:

getValue in interface CacheEntry

Returns:

the value of the entry

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

Returns:

true if this represents a null, false otherwise.

commit

public final void commit(DataContainer container)

Description copied from interface: CacheEntry

Commits changes

Specified by:

commit in interface CacheEntry

Parameters:

container - data container to commit to

commit

public final CompletionStage<Void> commit(int segment,
                                          InternalDataContainer container)

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.

setChanged

public final void setChanged(boolean changed)

Specified by:

setChanged in interface CacheEntry

Specified by:

setChanged in interface MVCCEntry

setSkipLookup

public void setSkipLookup(boolean skipLookup)

Description copied from interface: CacheEntry

See CacheEntry.skipLookup().

Specified by:

setSkipLookup in interface CacheEntry

skipLookup

public boolean skipLookup()

Specified by:

skipLookup in interface CacheEntry

Returns:

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

getCreated

public long getCreated()

Specified by:

getCreated in interface CacheEntry

Returns:

timestamp when the entry was created

getLastUsed

public long getLastUsed()

Specified by:

getLastUsed in interface CacheEntry

Returns:

timestamp when the entry was last used

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

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

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

isCreated

public final boolean isCreated()

Specified by:

isCreated in interface CacheEntry

Returns:

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

setCreated

public final void setCreated(boolean created)

Specified by:

setCreated in interface CacheEntry

isRemoved

public 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 boolean isEvicted()

Specified by:

isEvicted in interface CacheEntry

Returns:

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

isExpired

public boolean isExpired()

Description copied from interface: MVCCEntry

Returns whether this entry was marked as being expired or not

Specified by:

isExpired in interface MVCCEntry

Returns:

whether expired has been set

setCommitted

public void setCommitted()

Description copied from interface: MVCCEntry

Mark this context-entry as already committed to the DataContainer.

Specified by:

setCommitted in interface MVCCEntry

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface MVCCEntry

Returns:

True if this context entry has been committed to the DataContainer

isLoaded

public boolean isLoaded()

Specified by:

isLoaded in interface MVCCEntry

Returns:

True if we've checked persistence for presence of this entry.

isSkipSharedStore

public boolean isSkipSharedStore()

Specified by:

isSkipSharedStore in interface MVCCEntry

Returns:

True if this entry should non be written to shared persistence

setLoaded

public void setLoaded(boolean loaded)

Specified by:

setLoaded in interface MVCCEntry

resetCurrentValue

public void resetCurrentValue()

Description copied from interface: MVCCEntry

Reset the current value of the entry to the value before the commmand was executed the first time. This is invoked before the command is retried.

Specified by:

resetCurrentValue in interface MVCCEntry

updatePreviousValue

public void updatePreviousValue()

Description copied from interface: MVCCEntry

Update the previous value of the entry - set it to current value. This is invoked when the command is successfuly finished (there won't be any more retries) or when the value was updated from external source.

Specified by:

updatePreviousValue in interface MVCCEntry

setRemoved

public final void setRemoved(boolean removed)

Specified by:

setRemoved in interface CacheEntry

setEvicted

public void setEvicted(boolean evicted)

Specified by:

setEvicted in interface CacheEntry

setExpired

public void setExpired(boolean expired)

Description copied from interface: MVCCEntry

Marks this entry as being expired. This is a special form of removal.

Specified by:

setExpired in interface MVCCEntry

Parameters:

expired - whether or not this entry should be expired

setSkipSharedStore

public void setSkipSharedStore()

Specified by:

setSkipSharedStore in interface MVCCEntry

clone

public ReadCommittedEntry clone()

Specified by:

clone in interface CacheEntry

Specified by:

clone in interface MVCCEntry

Overrides:

clone in class Object

setCreated

public void setCreated(long created)

Specified by:

setCreated in interface CacheEntry

setLastUsed

public void setLastUsed(long lastUsed)

Specified by:

setLastUsed in interface CacheEntry

getInternalMetadata

public PrivateMetadata getInternalMetadata()

Specified by:

getInternalMetadata in interface CacheEntry

setInternalMetadata

public void setInternalMetadata(PrivateMetadata metadata)

Specified by:

setInternalMetadata in interface CacheEntry

toString

public String toString()

Overrides:

toString in class Object