io.mangoo.cache

Interface Cache

All Known Implementing Classes:

GuavaCache, HazlecastCache

public interface Cache

Author:

svenkubiak

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the complete cache by invalidating all entries
<T> T	get(String key) Retrieves an object from the caches and converts it to a given class
ConcurrentMap<String,Object>	getAll()
Map<String,Object>	getStats() Retrieves the cache statistics
void	put(String key, Object value) Adds a value to cache with a given key overwriting and existing value
void	putAll(Map<String,Object> map) Adds a complete map of objects to the cache
void	remove(String key) Removes a value with a given key from the cache
long	size() Returns the size (number of elements) of cached values

Method Detail

put

void put(String key,
         Object value)

Adds a value to cache with a given key overwriting and existing value

Parameters:

key - The key for the cached value

value - The value to store

remove

void remove(String key)

Removes a value with a given key from the cache

Parameters:

key - The key for the cached value

size

long size()

Returns the size (number of elements) of cached values

Returns:

Cache size

clear

void clear()

Clears the complete cache by invalidating all entries

get

<T> T get(String key)

Retrieves an object from the caches and converts it to a given class

Type Parameters:

T - JavaDoc requires this (just ignore it)

Parameters:

key - The key for the cached value

Returns:

A converted cache class value

putAll

void putAll(Map<String,Object> map)

Adds a complete map of objects to the cache

Parameters:

map - The map to add

getAll

ConcurrentMap<String,Object> getAll()

Returns:

The complete content of the cache

getStats

Map<String,Object> getStats()

Retrieves the cache statistics

Returns:

Map containing cache statistics