org.jboss.as.ejb3.cache

Interface Cache<K extends Serializable,V extends Identifiable<K>>

All Superinterfaces:

AffinitySupport<K>, Removable<K>

All Known Implementing Classes:

AbstractCache, GroupAwareCache, SimpleCache

public interface Cache<K extends Serializable,V extends Identifiable<K>>
extends Removable<K>, AffinitySupport<K>

Cache a stateful object and make sure any life cycle callbacks are called at the appropriate time.

Version:

$Revision: $

Author:

Carlo de Wolf

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.
void	release(V obj) Release the object from use.
void	start() Start the cache.
void	stop() Stop the cache.

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

remove

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

getStrictAffinity, getWeakAffinity, hasAffinity

Method Detail

create

V create()

Creates and caches a new instance of T.

Returns:

a new T

discard

void discard(K key)

Discard the specified object from cache.

Parameters:

key - the identifier of the object

get

V get(K key)

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

Parameters:

key - the identifier of the object

Returns:

the object, or null if it does not exist

release

void release(V obj)

Release the object from use.

Parameters:

obj - the object

start

void start()

Start the cache.

stop

void stop()

Stop the cache.