org.cache2k.integration

Class AdvancedCacheLoader<K,V>

java.lang.Object

org.cache2k.integration.AdvancedCacheLoader<K,V>

public abstract class AdvancedCacheLoader<K,V>
extends Object

Retrieves or generates a value to load into the cache. The advanced loader interface contains the current time and the previous cache entry. The previous cache entry can be used for a more intelligent loading strategy, e.g. for HTTP based loading with the If-Modified-Since header.

For general documentation on the loader, please see CacheLoader.

Author:

Jens Wilke

See Also:

CacheLoader

Constructor Summary

Constructors

Constructor and Description
AdvancedCacheLoader()

Method Summary

Modifier and Type	Method and Description
abstract V	load(K key, long currentTime, CacheEntry<K,V> currentEntry) Retrieves or generates data based on the key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AdvancedCacheLoader

public AdvancedCacheLoader()

Method Detail

load

public abstract V load(K key,
                       long currentTime,
                       CacheEntry<K,V> currentEntry)
                throws Exception

Retrieves or generates data based on the key.

Parameters:

key - The non-null key to provide the value for.

currentTime - Time in millis, retrieved before the call.

currentEntry - entry currently in the cache, regardless whether expired or not. There is no guarantee that an expired entry will be provided to the loader. Depending und passed time and configuration expired entries may be purged from the cache before the next load happens. Check the configuration parameters Cache2kBuilder.keepDataAfterExpired(boolean) and Cache2kBuilder.refreshAhead(boolean).

Returns:

value to be associated with the key. If the cache permits null values a null is associated with the key.

Throws:

Exception - Unhandled exception from the loader. Exceptions are suppressed or wrapped and rethrown via a CacheLoaderException