ItemStateCache (Apache Jackrabbit 2.20.16 API)

All Known Implementing Classes:

ItemStateReferenceCache, MLRUItemStateCache
```
public interface ItemStateCache
```
An ItemStateCache maintains a cache of ItemState instances.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`cache(ItemState state)` Stores the specified `ItemState` object in the map using its `ItemId` as the key.
`void`	`dispose()` Informs the cache that it is no longer in use.
`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.
`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`.
`ItemState[]`	`retrieveAll()` Returns all the cached item states.

- Method Detail
  - isCached
```
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
```
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
  - retrieveAll
```
ItemState[] retrieveAll()
```
    Returns all the cached item states.
    
    Returns:
    
    newly allocated item state array
  - cache
```
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
```
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
```
void evictAll()
```
    Clears all entries from this cache.
  - isEmpty
```
boolean isEmpty()
```
    Returns true if this cache contains no entries.
    
    Returns:
    
    true if this cache contains no entries.
  - dispose
```
void dispose()
```
    Informs the cache that it is no longer in use.

Interface ItemStateCache

Method Summary

Method Detail

isCached

retrieve

retrieveAll

cache

evict

evictAll

isEmpty

dispose