org.ehcache.core.spi.store.tiering

Interface LowerCachingTier<K,V>

Type Parameters:

K - the key type

V - the value type

All Superinterfaces:

ConfigurationChangeSupport

public interface LowerCachingTier<K,V>
extends ConfigurationChangeSupport

Interface for the lower tier of a multi-tier CachingTier.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LowerCachingTier.Provider Service interface for providing LowerCachingTier instances.

Method Summary

Modifier and Type	Method and Description
void	clear() Empty out this tier
Store.ValueHolder<V>	get(K key) Return the value holder currently in this tier.
Store.ValueHolder<V>	getAndRemove(K key) Return the value holder currently in this tier and removes it atomically.
Store.ValueHolder<V>	installMapping(K key, java.util.function.Function<K,Store.ValueHolder<V>> source) Either return the Store.ValueHolder currently in the caching tier or installs and returns the result of the passed in function.
void	invalidate(K key) Removes a mapping, triggering the CachingTier.InvalidationListener if registered.
void	invalidateAll() Invalidates all mapping, invoking the CachingTier.InvalidationListener if registered.
void	invalidateAllWithHash(long hash) Invalidates all mappings whose key's hash code matches the provided one, invoking the CachingTier.InvalidationListener if registered.
void	setInvalidationListener(CachingTier.InvalidationListener<K,V> invalidationListener) Set the caching tier's invalidation listener.

Methods inherited from interface org.ehcache.core.spi.store.ConfigurationChangeSupport

getConfigurationChangeListeners

Method Detail

installMapping

Store.ValueHolder<V> installMapping(K key,
                                    java.util.function.Function<K,Store.ValueHolder<V>> source)
                             throws org.ehcache.spi.resilience.StoreAccessException

Either return the Store.ValueHolder currently in the caching tier or installs and returns the result of the passed in function.

Note that in case of expired Store.ValueHolder null will be returned and the mapping will be invalidated.

Parameters:

key - the key

source - the function that computes the value

Returns:

the value holder, or null

Throws:

org.ehcache.spi.resilience.StoreAccessException - if the mapping cannot be accessed, installed or removed

get

Store.ValueHolder<V> get(K key)
                  throws org.ehcache.spi.resilience.StoreAccessException

Return the value holder currently in this tier.

Parameters:

key - the key

Returns:

the value holder, or null

Throws:

org.ehcache.spi.resilience.StoreAccessException - if the mapping cannot be access

getAndRemove

Store.ValueHolder<V> getAndRemove(K key)
                           throws org.ehcache.spi.resilience.StoreAccessException

Return the value holder currently in this tier and removes it atomically.

Parameters:

key - the key

Returns:

the value holder, or null

Throws:

org.ehcache.spi.resilience.StoreAccessException - if the mapping cannot be access or removed

invalidate

void invalidate(K key)
         throws org.ehcache.spi.resilience.StoreAccessException

Removes a mapping, triggering the CachingTier.InvalidationListener if registered.

Parameters:

key - the key to remove

Throws:

org.ehcache.spi.resilience.StoreAccessException - if the mapping cannot be removed

invalidateAll

void invalidateAll()
            throws org.ehcache.spi.resilience.StoreAccessException

Invalidates all mapping, invoking the CachingTier.InvalidationListener if registered.

Throws:

org.ehcache.spi.resilience.StoreAccessException - if mappings cannot be removed

invalidateAllWithHash

void invalidateAllWithHash(long hash)
                    throws org.ehcache.spi.resilience.StoreAccessException

Invalidates all mappings whose key's hash code matches the provided one, invoking the CachingTier.InvalidationListener if registered.

Throws:

org.ehcache.spi.resilience.StoreAccessException - if mappings cannot be removed

clear

void clear()
    throws org.ehcache.spi.resilience.StoreAccessException

Empty out this tier

Throws:

org.ehcache.spi.resilience.StoreAccessException - if mappings cannot be removed

setInvalidationListener

void setInvalidationListener(CachingTier.InvalidationListener<K,V> invalidationListener)

Set the caching tier's invalidation listener.

Parameters:

invalidationListener - the listener