net.imglib2.cache

Interface CacheRemover<K,V,D>

Type Parameters:

K - key type

V - value type

D - value data type

All Superinterfaces:

Invalidate<K>

All Known Implementing Classes:

DirtyDiskCellCache, DiskCellCache, IoSync

public interface CacheRemover<K,V,D>
extends Invalidate<K>

Handles entries that are removed from a cache (by propagating to a higher-level cache, writing to disk, or similar).

To make this work, it must be possible to extract data D out of a value V, and to reconstruct an identical value V from D. D must be sufficient to reconstruct an identical V, and must not contain any references to V.

Author:

Tobias Pietzsch

Field Summary

Fields inherited from interface net.imglib2.cache.Invalidate

defaultParallelismThreshold

Method Summary

Modifier and Type	Method and Description
D	extract(V value) Extract data out of value.
default void	invalidate(K key) Called when a specific entry is invalidated from the cache.
default void	invalidateAll(long parallelismThreshold) Called when all entries are invalidated from the cache.
default void	invalidateIf(long parallelismThreshold, Predicate<K> condition) Called when all entries with keys matching condition are invalidated from the cache.
void	onRemoval(K key, D valueData) Called when an entry is evicted from the cache.
CompletableFuture<Void>	persist(K key, D valueData) TODO
V	reconstruct(K key, D valueData) Construct a value from its key and valueData.

Methods inherited from interface net.imglib2.cache.Invalidate

invalidateAll, invalidateIf

Method Detail

onRemoval

void onRemoval(K key,
               D valueData)

Called when an entry is evicted from the cache.

Parameters:

key - key of the entry to remove

valueData - value data of the entry to remove

persist

CompletableFuture<Void> persist(K key,
                                D valueData)

TODO

Parameters:

key -

valueData -

extract

D extract(V value)

Extract data out of value. The data must be sufficient to reconstruct an identical value, and must not contain any references to value.

reconstruct

V reconstruct(K key,
              D valueData)

Construct a value from its key and valueData.

invalidate

default void invalidate(K key)

Called when a specific entry is invalidated from the cache. (See AbstractCache.invalidate(Object).)

If this CacheRemover itself represents a (higher-level) cache, the entry should be invalidated in this cache as well.

Specified by:

invalidate in interface Invalidate<K>

Parameters:

key - key of the entry to remove

invalidateIf

default void invalidateIf(long parallelismThreshold,
                          Predicate<K> condition)

Called when all entries with keys matching condition are invalidated from the cache. (See AbstractCache.invalidateIf(long, Predicate).)

If this CacheRemover itself represents a (higher-level) cache, the entries should be invalidated in this cache as well.

Specified by:

invalidateIf in interface Invalidate<K>

Parameters:

parallelismThreshold - the (estimated) number of entries in the cache needed for this operation to be executed in parallel

condition - condition on keys of entries to remove

invalidateAll

default void invalidateAll(long parallelismThreshold)

Called when all entries are invalidated from the cache. (See AbstractCache.invalidateAll(long).)

If this CacheRemover itself represents a (higher-level) cache, the entries should be invalidated in this cache as well.

Specified by:

invalidateAll in interface Invalidate<K>

Parameters:

parallelismThreshold - the (estimated) number of entries in the cache needed for this operation to be executed in parallel