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

Class AbstractCache<K extends Serializable,V extends Cacheable<K>,E extends BackingCacheEntry<K,V>>

java.lang.Object

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

All Implemented Interfaces:

AffinitySupport<K>, Cache<K,V>, Removable<K>

Direct Known Subclasses:

SimpleCache

public abstract class AbstractCache<K extends Serializable,V extends Cacheable<K>,E extends BackingCacheEntry<K,V>>
extends Object
implements Cache<K,V>

Author:

Paul Ferraro

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCache(BackingCache<K,V,E> backingCache)

Method Summary

Methods

Modifier and Type	Method and Description
V	create() Creates and caches a new instance of T.
void	discard(K key) Discard the specified object from cache.
V	get(K key) Get the specified object from cache.
org.jboss.ejb.client.Affinity	getStrictAffinity() Returns the strict affinity associated with the entries of this cache
org.jboss.ejb.client.Affinity	getWeakAffinity(K key) Returns the weak affinity associated with the specified entry of this cache
boolean	hasAffinity(K key) Indicates whether the cache has an affinity for the specified key.
void	release(V object) Release the object from use.
void	remove(K key) Remove and destroy the specified object from cache.
void	start() Start the cache.
void	stop() Stop the cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCache

protected AbstractCache(BackingCache<K,V,E> backingCache)

Method Detail

create

public V create()

Description copied from interface: Cache

Creates and caches a new instance of T.

Specified by:

create in interface Cache<K extends Serializable,V extends Cacheable<K>>

Returns:

a new T

discard

public void discard(K key)

Discard the specified object from cache.

Specified by:

discard in interface Cache<K extends Serializable,V extends Cacheable<K>>

Parameters:

key - the identifier of the object

See Also:

Cache.discard(java.io.Serializable)

get

public V get(K key)
                           throws javax.ejb.NoSuchEJBException

Get the specified object from cache. This will mark the object as being in use.

Specified by:

get in interface Cache<K extends Serializable,V extends Cacheable<K>>

Parameters:

key - the identifier of the object

Returns:

the object, or null if it does not exist

Throws:

javax.ejb.NoSuchEJBException

See Also:

Cache.get(java.io.Serializable)

release

public void release(V object)

Release the object from use.

Specified by:

release in interface Cache<K extends Serializable,V extends Cacheable<K>>

Parameters:

object - the object

See Also:

Cache.release(org.jboss.as.ejb3.cache.Identifiable)

remove

public void remove(K key)

Remove and destroy the specified object from cache.

Specified by:

remove in interface Removable<K extends Serializable>

Parameters:

key - the identifier of the object

start

public void start()

Start the cache.

Specified by:

start in interface Cache<K extends Serializable,V extends Cacheable<K>>

See Also:

Cache.start()

stop

public void stop()

Stop the cache.

Specified by:

stop in interface Cache<K extends Serializable,V extends Cacheable<K>>

See Also:

Cache.stop()

getStrictAffinity

public org.jboss.ejb.client.Affinity getStrictAffinity()

Description copied from interface: AffinitySupport

Returns the strict affinity associated with the entries of this cache

Specified by:

getStrictAffinity in interface AffinitySupport<K extends Serializable>

getWeakAffinity

public org.jboss.ejb.client.Affinity getWeakAffinity(K key)

Description copied from interface: AffinitySupport

Returns the weak affinity associated with the specified entry of this cache

Specified by:

getWeakAffinity in interface AffinitySupport<K extends Serializable>

hasAffinity

public boolean hasAffinity(K key)

Description copied from interface: AffinitySupport

Indicates whether the cache has an affinity for the specified key.

Specified by:

hasAffinity in interface AffinitySupport<K extends Serializable>

Parameters:

key - a candidate key

Returns:

true if this cache likes this key, false otherwise