com.enterprisemath.utils.cache

Interface ObjectCache

All Known Implementing Classes:

ExpiringInMemoryObjectCache, InMemoryObjectCache

public interface ObjectCache

Defines interface for caching objects.

Note: Adding functions to this interface will NOT be considered as breaking binary compatibility.

Author:

radek.hecl

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the cache, all objects are removed.
Object	get(String key) Retrieves object.
Object	get(String key, Object def) Returns object in the non strict manner.
Set<String>	getKeys() Returns all keys which are in use.
void	put(String key, Object object) Puts object into cache.
void	remove(String key) Removes the specified key.

Method Detail

put

void put(String key,
         Object object)

Puts object into cache. If object with the same key exists, then it is are overridden.

Parameters:

key - data key

object - object

remove

void remove(String key)

Removes the specified key.

Parameters:

key - key

get

Object get(String key)

Retrieves object.

Parameters:

key - data key

Returns:

object

Throws:

NoSuchElementException - if key doesn't exists

get

Object get(String key,
           Object def)

Returns object in the non strict manner. Default value is returned if key doesn't exists.

Parameters:

key - key

def - default value returned if key doesn't exists

Returns:

object or default value

getKeys

Set<String> getKeys()

Returns all keys which are in use.

Returns:

all keys which are in use

clear

void clear()

Clears the cache, all objects are removed.