javax.cache.integration

Interface CacheLoader<K,V>

Type Parameters:

K - the type of keys handled by this loader

V - the type of values generated by this loader

public interface CacheLoader<K,V>

Used when a cache is read-through or when loading data into a cache via the and javax.cache.Cache#loadAll(Iterable, boolean, CompletionListener) method.

See CacheWriter which is the corollary for write-through caching.

Since:

1.0

Author:

Greg Luck, Yannis Cosmadopoulos

See Also:

CacheWriter

Method Summary

Methods

Modifier and Type	Method and Description
Cache.Entry<K,V>	load(K key) Loads an object.
Map<K,V>	loadAll(Iterable<? extends K> keys) Loads multiple objects.

Method Detail

load

Cache.Entry<K,V> load(K key)

Loads an object. Application developers should implement this method to customize the loading of cache object. This method is called by the caching service when the requested object is not in the cache. If the object can't be loaded null should be returned.

Parameters:

key - the key identifying the object being loaded

Returns:

The entry for the object that is to be stored in the cache or null if the object can't be loaded

loadAll

Map<K,V> loadAll(Iterable<? extends K> keys)

Loads multiple objects. Application developers should implement this method to customize the loading of cache object. This method is called by the caching service when the requested object is not in the cache. If an object can't be loaded, it is not returned in the resulting map.

Parameters:

keys - keys identifying the values to be loaded

Returns:

A map of key, values to be stored in the cache.