org.apache.jackrabbit.core.state
Interface ItemStateCache

All Known Implementing Classes:

ItemStateReferenceCache, LRUItemStateCache

public interface ItemStateCache

An ItemStateCache maintains a cache of ItemState instances.

Method Summary

void	cache(ItemState state) Stores the specified ItemState object in the map using its ItemId as the key.
void	evict(ItemId id) Removes the ItemState object with the specified id from this cache if it is present.
void	evictAll() Clears all entries from this cache.
boolean	isCached(ItemId id) Returns true if this cache contains an ItemState object with the specified id.
boolean	isEmpty() Returns true if this cache contains no entries.
Set	keySet() Returns an unmodifiable set view of the keys (i.e.
ItemState	retrieve(ItemId id) Returns the ItemState object with the specified id if it is present or null if no entry exists with that id.
int	size() Returns the number of entries in this cache.
Collection	values() Returns an unmodifiable collection view of the values (i.e.

Method Detail

isCached

public boolean isCached(ItemId id)

Returns true if this cache contains an ItemState object with the specified id.

Parameters:

id - id of ItemState object whose presence should be tested.

Returns:

true if there's a corresponding cache entry, otherwise false.

retrieve

public ItemState retrieve(ItemId id)

Returns the ItemState object with the specified id if it is present or null if no entry exists with that id.

Parameters:

id - the id of the ItemState object to be returned.

Returns:

the ItemState object with the specified id or or null if no entry exists with that id

cache

public void cache(ItemState state)

Stores the specified ItemState object in the map using its ItemId as the key.

Parameters:

state - the ItemState object to cache

evict

public void evict(ItemId id)

Removes the ItemState object with the specified id from this cache if it is present.

Parameters:

id - the id of the ItemState object which should be removed from this cache.

evictAll

public void evictAll()

Clears all entries from this cache.

isEmpty

public boolean isEmpty()

Returns true if this cache contains no entries.

Returns:

true if this cache contains no entries.

size

public int size()

Returns the number of entries in this cache.

Returns:

number of entries in this cache.

keySet

public Set keySet()

Returns an unmodifiable set view of the keys (i.e. ItemId objects) of the cached entries.

Returns:

a set view of the keys of the cached entries.

values

public Collection values()

Returns an unmodifiable collection view of the values (i.e. ItemState objects) contained in this cache.

Returns:

a collection view of the values contained in this cache.