org.ehcache.impl.store

Class BaseStore<K,V>

java.lang.Object

org.ehcache.impl.store.BaseStore<K,V>

All Implemented Interfaces:

org.ehcache.core.spi.store.ConfigurationChangeSupport, org.ehcache.core.spi.store.Store<K,V>

public abstract class BaseStore<K,V>
extends java.lang.Object
implements org.ehcache.core.spi.store.Store<K,V>

Base class to most stores. It provides functionality common to stores in general. A given store implementation is not required to extend it but the implementor might find it easier to do so.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	BaseStore.BaseStoreProvider

Nested classes/interfaces inherited from interface org.ehcache.core.spi.store.Store

org.ehcache.core.spi.store.Store.Configuration<K,V>, org.ehcache.core.spi.store.Store.Iterator<T>, org.ehcache.core.spi.store.Store.Provider, org.ehcache.core.spi.store.Store.PutStatus, org.ehcache.core.spi.store.Store.RemoveStatus, org.ehcache.core.spi.store.Store.ReplaceStatus, org.ehcache.core.spi.store.Store.ValueHolder<V>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Class<K>	keyType
protected boolean	operationStatisticsEnabled Tells if this store is by itself or in a tiered setup
protected org.ehcache.core.spi.service.StatisticsService	statisticsService
protected java.lang.Class<V>	valueType

Constructor Summary

Constructors

Constructor and Description
BaseStore(java.lang.Class<K> keyType, java.lang.Class<V> valueType, boolean operationStatisticsEnabled, org.ehcache.core.spi.service.StatisticsService statisticsService)
BaseStore(org.ehcache.core.spi.store.Store.Configuration<K,V> config, org.ehcache.core.spi.service.StatisticsService statisticsService)

Method Summary

Modifier and Type	Method and Description
protected void	checkKey(K keyObject)
protected void	checkValue(V valueObject)
protected <T extends java.lang.Enum<T>> org.ehcache.core.statistics.OperationObserver<T>	createObserver(java.lang.String name, java.lang.Class<T> outcome, boolean canBeDisabled) Create an OperationObserver using this for the context.
protected abstract java.lang.String	getStatisticsTag()
protected <T extends java.io.Serializable> void	registerStatistic(java.lang.String name, org.ehcache.core.statistics.StatisticType type, java.util.Set<java.lang.String> tags, java.util.function.Supplier<T> valueSupplier)

Methods inherited from class java.lang.Object

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

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

bulkCompute, bulkCompute, bulkComputeIfAbsent, clear, computeAndGet, computeIfAbsent, containsKey, get, getAndCompute, getAndPut, getAndRemove, getStoreEventSource, iterator, put, putIfAbsent, remove, remove, replace, replace

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

getConfigurationChangeListeners

Field Detail

keyType

protected final java.lang.Class<K> keyType

valueType

protected final java.lang.Class<V> valueType

operationStatisticsEnabled

protected final boolean operationStatisticsEnabled

Tells if this store is by itself or in a tiered setup

statisticsService

protected final org.ehcache.core.spi.service.StatisticsService statisticsService

Constructor Detail

BaseStore

public BaseStore(org.ehcache.core.spi.store.Store.Configuration<K,V> config,
                 org.ehcache.core.spi.service.StatisticsService statisticsService)

BaseStore

public BaseStore(java.lang.Class<K> keyType,
                 java.lang.Class<V> valueType,
                 boolean operationStatisticsEnabled,
                 org.ehcache.core.spi.service.StatisticsService statisticsService)

Method Detail

checkKey

protected void checkKey(K keyObject)

checkValue

protected void checkValue(V valueObject)

createObserver

protected <T extends java.lang.Enum<T>> org.ehcache.core.statistics.OperationObserver<T> createObserver(java.lang.String name,
                                                                                                        java.lang.Class<T> outcome,
                                                                                                        boolean canBeDisabled)

Create an OperationObserver using this for the context.

Type Parameters:

T - type of the outcome

Parameters:

name - name of the statistic

outcome - class of the possible outcomes

canBeDisabled - if this statistic can be disabled by a StoreStatisticsConfiguration

Returns:

the created observer

registerStatistic

protected <T extends java.io.Serializable> void registerStatistic(java.lang.String name,
                                                                  org.ehcache.core.statistics.StatisticType type,
                                                                  java.util.Set<java.lang.String> tags,
                                                                  java.util.function.Supplier<T> valueSupplier)

getStatisticsTag

protected abstract java.lang.String getStatisticsTag()