org.jboss.as.ejb3.cache.spi.impl

Class AbstractBackingCacheEntry<K extends Serializable,V extends Cacheable<K>>

java.lang.Object

org.jboss.as.ejb3.cache.spi.impl.AbstractBackingCacheEntry<K,V>

All Implemented Interfaces:

Serializable, Comparable<BackingCacheEntry<K,V>>, Cacheable<K>, Identifiable<K>, BackingCacheEntry<K,V>

Direct Known Subclasses:

NonPassivatingBackingCacheEntry, SerializationGroupImpl, SerializationGroupMemberImpl

public abstract class AbstractBackingCacheEntry<K extends Serializable,V extends Cacheable<K>>
extends Object
implements BackingCacheEntry<K,V>

Abstract superclass for BackingCacheEntry implementations.

Author:

Brian Stansberry, Paul Ferraro

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractBackingCacheEntry()

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(BackingCacheEntry<K,V> entry)
boolean	equals(Object object)
long	getLastUsed() Gets the timestamp of the last time this entry was in use.
int	hashCode()
void	invalidate() Causes BackingCacheEntry.isValid() to hereafter return true.
boolean	isInUse() Gets whether this entry is in use by a caller.
boolean	isPrePassivated() Gets whether the entry can be passivated without invoking any callbacks on the underlying item.
boolean	isValid() Whether this entry has been invalidated (in which case it should be reacquired).
void	setInUse(boolean inUse) Sets whether this entry is in use by a caller.
void	setLastUsed(long lastUsed) Exposed as public only as an aid to unit tests.
void	setPrePassivated(boolean prePassivated) Sets whether the entry can be passivated without invoking any callbacks on the underlying item.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jboss.as.ejb3.cache.spi.BackingCacheEntry

getUnderlyingItem, lock, tryLock, unlock

Methods inherited from interface org.jboss.as.ejb3.cache.Cacheable

isModified

Methods inherited from interface org.jboss.as.ejb3.cache.Identifiable

getId

Constructor Detail

AbstractBackingCacheEntry

public AbstractBackingCacheEntry()

Method Detail

getLastUsed

public long getLastUsed()

Description copied from interface: BackingCacheEntry

Gets the timestamp of the last time this entry was in use.

Specified by:

getLastUsed in interface BackingCacheEntry<K extends Serializable,V extends Cacheable<K>>

Returns:

isInUse

public boolean isInUse()

Description copied from interface: BackingCacheEntry

Gets whether this entry is in use by a caller.

Specified by:

isInUse in interface BackingCacheEntry<K extends Serializable,V extends Cacheable<K>>

setInUse

public void setInUse(boolean inUse)

Description copied from interface: BackingCacheEntry

Sets whether this entry is in use by a caller.

Specified by:

setInUse in interface BackingCacheEntry<K extends Serializable,V extends Cacheable<K>>

setLastUsed

public void setLastUsed(long lastUsed)

Exposed as public only as an aid to unit tests. In normal use this should only be invoked internally or by subclasses.

Parameters:

lastUsed - time since epoch when last used

isPrePassivated

public boolean isPrePassivated()

Description copied from interface: BackingCacheEntry

Gets whether the entry can be passivated without invoking any callbacks on the underlying item.

Specified by:

isPrePassivated in interface BackingCacheEntry<K extends Serializable,V extends Cacheable<K>>

setPrePassivated

public void setPrePassivated(boolean prePassivated)

Description copied from interface: BackingCacheEntry

Sets whether the entry can be passivated without invoking any callbacks on the underlying item.

Specified by:

setPrePassivated in interface BackingCacheEntry<K extends Serializable,V extends Cacheable<K>>

invalidate

public void invalidate()

Description copied from interface: BackingCacheEntry

Causes BackingCacheEntry.isValid() to hereafter return true.

NOTE: This method should only be called with the lock held.

Specified by:

invalidate in interface BackingCacheEntry<K extends Serializable,V extends Cacheable<K>>

isValid

public boolean isValid()

Description copied from interface: BackingCacheEntry

Whether this entry has been invalidated (in which case it should be reacquired).

NOTE: This method should only be called with the lock held.

Specified by:

isValid in interface BackingCacheEntry<K extends Serializable,V extends Cacheable<K>>

Returns:

truee if still valid, falsee if invalidated

See Also:

BackingCacheEntry.invalidate()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

compareTo

public int compareTo(BackingCacheEntry<K,V> entry)

Specified by:

compareTo in interface Comparable<BackingCacheEntry<K extends Serializable,V extends Cacheable<K>>>