org.pageseeder.bridge

Interface PSEntityCache<E extends PSEntity>

Type Parameters:

E - The type of entity to cache.

public interface PSEntityCache<E extends PSEntity>

Interface for all entity caches.

Since:

0.1.0

Version:

0.2.4

Author:

Christophe Lauret

Method Summary

Methods

Modifier and Type	Method and Description
E	get(E entity) Retrieve the object in the cache from an instance.
E	get(Long id) Retrieve the object in the cache for the specified ID.
E	get(String key) Retrieve the object in the cache for the specified key.
Long	getVersion(String key) Return the version of the element for the specified key.
void	put(E entity) Put a new element in the underlying cache.
void	remove(String key) Removes the element.
void	removeAll() Remove all cache entries.

Method Detail

put

void put(E entity)

Put a new element in the underlying cache.

Parameters:

entity - The entity to cache.

get

E get(Long id)

Retrieve the object in the cache for the specified ID.

Parameters:

id - The ID of the entity

Returns:

The version of the element or null if the ID or element is null

get

E get(String key)

Retrieve the object in the cache for the specified key.

Parameters:

key - The key

Returns:

The version of the element or null if the key or element is null

get

E get(E entity)

Retrieve the object in the cache from an instance.

Parameters:

entity - The entity

Returns:

The version of the element or null if the key or element is null

getVersion

Long getVersion(String key)

Return the version of the element for the specified key.

Parameters:

key - The key

Returns:

The version of the element or null if the key or element is null

remove

void remove(String key)

Removes the element.

Parameters:

key - the key of the element to remove.

removeAll

void removeAll()

Remove all cache entries.