Invalidate (ImgLib2 Javadocs 0-SNAPSHOT API)

Type Parameters:

K - key type (identifies entries to remove)

All Known Subinterfaces:

AbstractCache<K,V>, AbstractUncheckedVolatileCache<K,V>, AbstractVolatileCache<K,V>, Cache<K,V>, CacheRemover<K,V,D>, LoaderCache<K,V>, LoaderRemoverCache<K,V,D>, RemoverCache<K,V,D>, UncheckedCache<K,V>, UncheckedLoaderCache<K,V>, UncheckedVolatileCache<K,V>, UncheckedVolatileLoaderCache<K,V>, VolatileCache<K,V>, VolatileLoaderCache<K,V>, VolatileLoaderRemoverCache<K,V,D>, VolatileRemoverCache<K,V,D>

All Known Implementing Classes:

AbstractCacheKeyAdapter, BoundedSoftRefLoaderCache, CacheAsUncheckedCacheAdapter, CacheKeyAdapter, DirtyDiskCellCache, DiskCellCache, GuardedStrongRefLoaderCache, GuardedStrongRefLoaderRemoverCache, IoSync, LoaderCacheAsCacheAdapter, LoaderCacheKeyAdapter, LoaderRemoverCacheAsLoaderCacheAdapter, LoaderRemoverCacheAsRemoverCacheAdapter, LoaderRemoverCacheKeyAdapter, RemoverCacheAsCacheAdapter, RemoverCacheKeyAdapter, SoftRefLoaderCache, SoftRefLoaderRemoverCache, VolatileCacheAsUncheckedVolatileCacheAdapter, VolatileLoaderCacheAsVolatileCacheAdapter, WeakRefLoaderCache, WeakRefVolatileCache, WeakRefVolatileLoaderCache
```
public interface Invalidate<K>
```
A collection of methods that invalidate cache entries. It is possible to invalidate everything, entries matching some condition, or an individual entry.
"Invalidate" means: Remove from the cache, and discard any changes that have been made in this cache or any backing cache. In particular, if changes have been persisted to disk, remove those as well.
This interface is extended both by the caches and by CacheRemover. See AbstractCache and CacheRemover, for more specific documentation for each case.

Author:

Tobias Pietzsch

Field Summary

Fields
Modifier and Type Field and Description

static long defaultParallelismThreshold
TODO: Should do some benchmarks.

Fields
Modifier and Type	Field and Description
`static long`	`defaultParallelismThreshold` TODO: Should do some benchmarks.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`invalidate(K key)` Removes and discards the entry with the specified `key`.
`default void`	`invalidateAll()` Removes and discards all entries.
`void`	`invalidateAll(long parallelismThreshold)` Removes and discards all entries.
`void`	`invalidateIf(long parallelismThreshold, Predicate<K> condition)` Removes and discards all entries with keys matching `condition`.
`default void`	`invalidateIf(Predicate<K> condition)` Removes and discards all entries with keys matching `condition`.

- Field Detail
  - defaultParallelismThreshold
```
static final long defaultParallelismThreshold
```
    TODO: Should do some benchmarks. This is picked completely arbitrarily.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - invalidate
```
void invalidate(K key)
```
    Removes and discards the entry with the specified key.
    See AbstractCache.invalidate(Object), CacheRemover.invalidate(Object).
    
    Parameters:
    
    key - key of the entry to remove
  - invalidateIf
```
void invalidateIf(long parallelismThreshold,
                  Predicate<K> condition)
```
    Removes and discards all entries with keys matching condition.
    See AbstractCache.invalidateIf(long, Predicate), CacheRemover.invalidateIf(long, Predicate).
    
    Parameters:
    
    condition - condition on keys of entries to remove
    
    parallelismThreshold - the (estimated) number of entries in the cache needed for this operation to be executed in parallel
  - invalidateAll
```
void invalidateAll(long parallelismThreshold)
```
    Removes and discards all entries.
    See AbstractCache.invalidateAll(long), CacheRemover.invalidateAll(long).
    
    Parameters:
    
    parallelismThreshold - the (estimated) number of entries in the cache needed for this operation to be executed in parallel
  - invalidateIf
```
default void invalidateIf(Predicate<K> condition)
```
    Removes and discards all entries with keys matching condition. (Calls invalidateIf(long, Predicate) with defaultParallelismThreshold.)
    
    Parameters:
    
    condition - condition on keys of entries to remove
  - invalidateAll
```
default void invalidateAll()
```
    Removes and discards all entries. (Calls invalidateAll(long) with defaultParallelismThreshold.)

Interface Invalidate<K>

Field Summary

Method Summary

Field Detail

defaultParallelismThreshold

Method Detail

invalidate

invalidateIf

invalidateAll

invalidateIf

invalidateAll