javastrava.cache

Interface StravaCache<T extends StravaCacheable<U>,U>

Type Parameters:

T - Class of object to be stored in cache

U - Class of object's id

All Known Implementing Classes:

StravaCacheImpl

public interface StravaCache<T extends StravaCacheable<U>,U>

The caching mechanism caches data temporarily in memory

Data is cached per unique token and cannot be read by a session with an access token different to the one that stored data

Author:

Dan Shannon

Method Summary

Modifier and Type	Method and Description
T	get(U key) Retrieves the object from the cache.
List<T>	list() Returns a list of the objects in the cache
void	put(T object) Stores the given object in the cache
void	putAll(List<T> list) Puts all the contents of the list in the cache
void	remove(U key) Removes the object identified by the key from the cache
void	removeAll() Removes all elements from the cache that are associated with the token
int	size() Returns the number of objects in the cache

Method Detail

get

T get(U key)

Retrieves the object from the cache.

Parameters:

key - The key

Returns:

the object, or null if not in cache

list

List<T> list()

Returns a list of the objects in the cache

Returns:

List of the objects in the cache

put

void put(T object)

Stores the given object in the cache

Parameters:

object - Object

putAll

void putAll(List<T> list)

Puts all the contents of the list in the cache

Parameters:

list - List of objects to be stored in cache

remove

void remove(U key)

Removes the object identified by the key from the cache

Parameters:

key - The key of the object to be removed

removeAll

void removeAll()

Removes all elements from the cache that are associated with the token

size

int size()

Returns the number of objects in the cache

Returns:

Number of objects in the cache