org.omnifaces.component.output.cache

Interface Cache

All Known Implementing Classes:

DefaultCache, TimeToLiveCache

public interface Cache

Interface that abstracts a simple get and put operation for a concrete cache implementation.

Note that this takes Strings for both key and value since it's not intended as a general cache solution, but is something specific for the Cache component which caches rendered output.

Since:

1.1

Author:

Arjan Tijms

Method Summary

Methods

Modifier and Type	Method and Description
String	get(String key) Gets a value from the cache
void	put(String key, String value) Stores a value in the cache
void	put(String key, String value, int timeToLive) Stores a value in the cache
void	remove(String key) Removes a value from the cache

Method Detail

get

String get(String key)

Gets a value from the cache

Parameters:

key - the key under which a value was previously stored

Returns:

The previously stored value, or null if no such value exists

put

void put(String key,
       String value)

Stores a value in the cache

Parameters:

key - the key under which a value is to be stored

value - the value that is to be stored

put

void put(String key,
       String value,
       int timeToLive)

Stores a value in the cache

Parameters:

key - the key under which a value is to be stored

value - the value that is to be stored

timeToLive - the amount of time in seconds for which the cached value is valid from the time it's being added to the cache. It's provider specific whether the cache implementation will actually remove (evict) the entry after this time has elapsed or will only perform a check upon accessing the cache entry. Whatever method the implementation chooses; after this time is elapsed a call to get(String) should return null.

remove

void remove(String key)

Removes a value from the cache

Parameters:

key - the key under which a value is to be stored