Top Deprecated
ehcache-core 2.10.9.2

Deprecated API

No API in this release is deprecated for removal.

Deprecated Item Summary

SinceDeprecated Item and Description

Returns:

the approximate size of the memory store in bytes
net.sf.ehcache.Cache.calculateInMemorySize()

Returns:

the size of the off-heap store in bytes
net.sf.ehcache.Cache.calculateOffHeapSize()

Returns:

the size of the on-disk store in bytes
net.sf.ehcache.Cache.calculateOnDiskSize()

Returns:

the number of elements in the disk store.
net.sf.ehcache.Cache.getDiskStoreSize()

Returns:

the number of elements in the memory store
net.sf.ehcache.Cache.getMemoryStoreSize()

Returns:

the number of elements in the off-heap store
net.sf.ehcache.Cache.getOffHeapStoreSize()

net.sf.ehcache.Cache.isClusterCoherent()

use isClusterBulkLoadEnabled() instead

net.sf.ehcache.Cache.isNodeCoherent()

use isNodeBulkLoadEnabled() instead

net.sf.ehcache.Cache.setNodeCoherent(boolean
true transitions to coherent mode, false to incoherent mode
coherent)

use setNodeBulkLoadEnabled(boolean) instead

net.sf.ehcache.Cache.tryRemoveImmediately(final Object key, final boolean notifyListeners)

net.sf.ehcache.Cache.waitUntilClusterCoherent()

use waitUntilClusterBulkLoadComplete() instead

net.sf.ehcache.CacheManager.removalAll()

use removeAllCaches instead

Returns:

the approximate size of the memory store in bytes
net.sf.ehcache.Ehcache.calculateInMemorySize()

Returns:

the size of the off-heap store in bytes
net.sf.ehcache.Ehcache.calculateOffHeapSize()

Returns:

the size of the on-disk store in bytes
net.sf.ehcache.Ehcache.calculateOnDiskSize()

Returns:

the number of elements in the disk store.
net.sf.ehcache.Ehcache.getDiskStoreSize()

Returns:

a list of Object keys
net.sf.ehcache.Ehcache.getKeysNoDuplicateCheck()

versions since 2.1 do not return duplicates

Returns:

the number of elements in the memory store
net.sf.ehcache.Ehcache.getMemoryStoreSize()

Returns:

the number of elements in the off-heap store
net.sf.ehcache.Ehcache.getOffHeapStoreSize()

Returns:

true if the cache is in coherent mode cluster-wide, false otherwise
net.sf.ehcache.Ehcache.isClusterCoherent()

Use isClusterBulkLoadEnabled() instead

Returns:

true if the cache is in coherent mode cluster-wide, false otherwise
net.sf.ehcache.Ehcache.isNodeCoherent()

Use isNodeBulkLoadEnabled() instead

net.sf.ehcache.Ehcache.setNodeCoherent(boolean
true transitions to coherent mode, false to incoherent mode
coherent)

Use setNodeBulkLoadEnabled(boolean) instead

net.sf.ehcache.Ehcache.waitUntilClusterCoherent()

Use waitUntilClusterBulkLoadComplete() instead

net.sf.ehcache.Element.Element(final Object key, final Object value, final long version, final long creationTime, final long lastAccessTime, final long nextToLastAccessTime, final long lastUpdateTime, final long hitCount)

The nextToLastAccessTime field is unused since version 1.7, setting it will have no effect. Use #Element(Object, Object, long, long, long, long, long) instead

net.sf.ehcache.Element.Element(final Object
any non null value
key, final Object
any value, including nulls
value, final Boolean
specify as non-null to override cache configuration
eternal, final Integer
specify as non-null to override cache configuration
timeToIdleSeconds, final Integer
specify as non-null to override cache configuration
timeToLiveSeconds)

Returns:

The key value.
net.sf.ehcache.Element.getKey()

Please use getObjectKey() instead.

net.sf.ehcache.Element.getNextToLastAccessTime()

The nextToLastAccessTime field is unused since version 1.7, retrieving it will return the lastAccessTime. Use #getLastAccessTime() instead.

Returns:

The value which must be Serializable. If not use getObjectValue.
net.sf.ehcache.Element.getValue()

Please use getObjectValue() instead.

net.sf.ehcache.Element.setCreateTime()

Resetting the creation time is not recommended as of version 1.7

net.sf.ehcache.config.CacheConfiguration.DEFAULT_DISK_PERSISTENT

The diskPersistent attribute has been replaced with persistence(PersistenceConfiguration).

net.sf.ehcache.config.CacheConfiguration.diskPersistent

The diskPersistent attribute has been replaced with persistence(PersistenceConfiguration).

Returns:

this configuration instance
net.sf.ehcache.config.CacheConfiguration.diskPersistent(boolean
whether to persist the cache to disk between JVM restarts.
diskPersistent)

The diskPersistent attribute has been replaced with persistence(PersistenceConfiguration).

net.sf.ehcache.config.CacheConfiguration.getMaxElementsInMemory()

use getMaxEntriesLocalHeap()

net.sf.ehcache.config.CacheConfiguration.getMaxElementsOnDisk()

use getMaxEntriesLocalDisk() for unclustered caches and getMaxEntriesInCache() for clustered caches.

Returns:

the max memory of the offheap store for this cache.
net.sf.ehcache.config.CacheConfiguration.getMaxMemoryOffHeap()

See getMaxBytesLocalOffHeapAsString()

Returns:

the max memory of the offheap store for this cache, in bytes.
net.sf.ehcache.config.CacheConfiguration.getMaxMemoryOffHeapInBytes()

getMaxBytesLocalOffHeap()

net.sf.ehcache.config.CacheConfiguration.isDiskPersistent()

The diskPersistent attribute has been replaced with persistence(PersistenceConfiguration).

net.sf.ehcache.config.CacheConfiguration.isOverflowToDisk()

The overflowToDisk attribute has been replaced with Strategy#LOCALTEMPSWAP.

Returns:

this configuration instance
net.sf.ehcache.config.CacheConfiguration.maxElementsInMemory(int
The maximum number of elements in memory, before they are evicted (0 == no limit)
maxElementsInMemory)

use maxEntriesLocalHeap(int)

Returns:

this configuration instance
net.sf.ehcache.config.CacheConfiguration.maxElementsOnDisk(int
the maximum number of Elements to allow on the disk. 0 means unlimited.
maxElementsOnDisk)

use maxEntriesLocalDisk(int) for unclustered caches and maxEntriesInCache(long) for clustered caches.

Returns:

this configuration instance
net.sf.ehcache.config.CacheConfiguration.maxMemoryOffHeap(String
the max off heap memory size allocated for this cache.
maxMemoryOffHeap)

See maxBytesLocalOffHeap(long, net.sf.ehcache.config.MemoryUnit)

net.sf.ehcache.config.CacheConfiguration.overflowToDisk

The overflowToDisk attribute has been replaced with Strategy#LOCALTEMPSWAP.

Returns:

this configuration instance
net.sf.ehcache.config.CacheConfiguration.overflowToDisk(boolean
whether to use the disk store
overflowToDisk)

The overflowToDisk attribute has been replaced with Strategy#LOCALTEMPSWAP.

net.sf.ehcache.config.CacheConfiguration.setDiskPersistent(boolean
whether to persist the cache to disk between JVM restarts
diskPersistent)

The diskPersistent attribute has been replaced with persistence(PersistenceConfiguration).

net.sf.ehcache.config.CacheConfiguration.setMaxElementsInMemory(int
The maximum number of elements in memory, before they are evicted (0 == no limit)
maxElementsInMemory)

use setMaxEntriesLocalHeap(long)

net.sf.ehcache.config.CacheConfiguration.setMaxElementsOnDisk(int
the maximum number of Elements to allow on the disk. 0 means unlimited.
maxElementsOnDisk)

use setMaxEntriesLocalDisk(long) for unclustered caches and setMaxEntriesInCache(long) for clustered caches.

net.sf.ehcache.config.CacheConfiguration.setMaxMemoryOffHeap(String
the max off heap memory size allocated for this cache.
maxMemoryOffHeap)

See setMaxBytesLocalOffHeap(java.lang.String)

net.sf.ehcache.config.CacheConfiguration.setOverflowToDisk(boolean
whether to use the disk store
overflowToDisk)

The overflowToDisk attribute has been replaced with Strategy#LOCALTEMPSWAP.

net.sf.ehcache.config.CacheConfiguration.setStatistics(boolean enabled)

Returns:

this configuration instance
net.sf.ehcache.config.CacheConfiguration.statistics(boolean statistics)

net.sf.ehcache.config.Configuration.getUpdateCheck()

net.sf.ehcache.config.Configuration.setUpdateCheck(boolean updateCheck)

Returns:

this configuration instance
net.sf.ehcache.config.Configuration.updateCheck(boolean
true if the update check should be turned on; or false otherwise
updateCheck)

Returns:

attribute type as class
net.sf.ehcache.config.ConfigurationHelper.getSearchAttributeType(SearchAttribute
search attribute
sa, ClassLoader loader)

internal use only

net.sf.ehcache.config.TerracottaConfiguration.DEFAULT_CACHE_COHERENT

since 2.4 Use DEFAULT_CONSISTENCY_TYPE instead.

Returns:

this configuration instance
net.sf.ehcache.config.TerracottaConfiguration.coherent(boolean coherent)

since 2.4 Use consistency(Consistency) instead

Returns:

this configuration instance
net.sf.ehcache.config.TerracottaConfiguration.coherentReads(boolean coherentReads)

Returns:

this configuration instance
net.sf.ehcache.config.TerracottaConfiguration.copyOnRead(boolean isCopyOnRead)

net.sf.ehcache.config.TerracottaConfiguration.getCoherentReads()

Returns:

true if configured in coherent mode.
net.sf.ehcache.config.TerracottaConfiguration.isCoherent()

since 2.4 Use getConsistency() instead to query the Consistency or Ehcache#isNodeCoherent() to query if the node is coherent

net.sf.ehcache.config.TerracottaConfiguration.isCopyOnRead()

net.sf.ehcache.config.TerracottaConfiguration.setCoherent(boolean coherent)

since 2.4 Use setConsistency(Consistency) instead

net.sf.ehcache.config.TerracottaConfiguration.setCoherentReads(boolean
true if coherent reads should be used; false otherwise
coherentReads)

net.sf.ehcache.config.TerracottaConfiguration.setCopyOnRead(boolean isCopyOnRead)

net.sf.ehcache.config.generator.ConfigurationGenerator

Use ConfigurationUtil#generateCacheManagerConfigurationText(Configuration) or ConfigurationUtil#generateCacheConfigurationText(Configuration, CacheConfiguration) instead

Returns:

String equivalent to an ehcache.xml for the input parameters
net.sf.ehcache.config.generator.ConfigurationGenerator.generate(Configuration configuration, CacheConfiguration defaultCacheConfiguration, Map<String, CacheConfiguration> cacheConfigs)

use appropriate methods in ConfigurationUtil instead

Returns:

String containing configuration for the input CacheConfiguration
net.sf.ehcache.config.generator.ConfigurationGenerator.generate(Configuration configuration, CacheConfiguration cacheConfiguration)

use appropriate methods in ConfigurationUtil instead

net.sf.ehcache.constructs.EhcacheDecoratorAdapter.calculateInMemorySize()

net.sf.ehcache.constructs.EhcacheDecoratorAdapter.calculateOffHeapSize()

net.sf.ehcache.constructs.EhcacheDecoratorAdapter.calculateOnDiskSize()

net.sf.ehcache.constructs.EhcacheDecoratorAdapter.getDiskStoreSize()

net.sf.ehcache.constructs.EhcacheDecoratorAdapter.getMemoryStoreSize()

net.sf.ehcache.constructs.EhcacheDecoratorAdapter.getOffHeapStoreSize()

net.sf.ehcache.constructs.EhcacheDecoratorAdapter.isClusterCoherent()

Use isClusterBulkLoadEnabled() instead

net.sf.ehcache.constructs.EhcacheDecoratorAdapter.isNodeCoherent()

Use isNodeBulkLoadEnabled() instead

net.sf.ehcache.constructs.EhcacheDecoratorAdapter.setNodeCoherent(boolean
true transitions to coherent mode, false to incoherent mode
coherent)

Use setNodeBulkLoadEnabled(boolean) instead

net.sf.ehcache.constructs.EhcacheDecoratorAdapter.waitUntilClusterCoherent()

Use waitUntilClusterBulkLoadComplete() instead

net.sf.ehcache.constructs.classloader.ClassLoaderAwareCache.calculateInMemorySize()

net.sf.ehcache.constructs.classloader.ClassLoaderAwareCache.calculateOffHeapSize()

net.sf.ehcache.constructs.classloader.ClassLoaderAwareCache.calculateOnDiskSize()

net.sf.ehcache.constructs.classloader.ClassLoaderAwareCache.getDiskStoreSize()

net.sf.ehcache.constructs.classloader.ClassLoaderAwareCache.getMemoryStoreSize()

net.sf.ehcache.constructs.classloader.ClassLoaderAwareCache.getOffHeapStoreSize()

net.sf.ehcache.hibernate.AbstractEhcacheProvider

Deprecated as a consequence of CacheProvider being deprecated.

Returns:

a newly built cache will be built and initialised
net.sf.ehcache.hibernate.AbstractEhcacheProvider.buildCache(String
the name of the cache. Must match a cache configured in ehcache.xml
name, Properties
not used
properties)

Deprecated as a consequence of Cache being deprecated. See corresponding docs for further information.

net.sf.ehcache.hibernate.EhCache

net.sf.ehcache.hibernate.EhCacheProvider

net.sf.ehcache.hibernate.SingletonEhCacheProvider

net.sf.ehcache.hibernate.ccs.AbstractEhcacheConcurrencyStrategy

net.sf.ehcache.hibernate.ccs.AbstractEhcacheConcurrencyStrategy.cache

Deprecated as a consequence of EhCache being deprecated. See corresponding docs for further information.

net.sf.ehcache.hibernate.ccs.AbstractEhcacheConcurrencyStrategy.getCache()

Deprecated as a consequence of Cache being deprecated. See corresponding docs for further information.

net.sf.ehcache.hibernate.ccs.AbstractEhcacheConcurrencyStrategy.setCache(Cache cache)

Deprecated as a consequence of Cache being deprecated. See corresponding docs for further information.

net.sf.ehcache.hibernate.ccs.EhcacheNonstrictReadWriteCache

net.sf.ehcache.hibernate.ccs.EhcacheReadOnlyCache

net.sf.ehcache.hibernate.ccs.EhcacheReadWriteCache

net.sf.ehcache.management.CacheConfiguration.getMaxElementsInMemory()

use getMaxEntriesLocalHeap()

net.sf.ehcache.management.CacheConfiguration.getMaxElementsOnDisk()

use getMaxEntriesLocalDisk()

net.sf.ehcache.management.CacheConfiguration.getMaxMemoryOffHeapInBytes()

use getMaxBytesLocalOffHeap()

net.sf.ehcache.management.CacheConfiguration.setMaxElementsInMemory(int maxElements)

use setMaxEntriesLocalHeap(long)

net.sf.ehcache.management.CacheConfiguration.setMaxElementsOnDisk(int maxElements)

use setMaxEntriesLocalDisk(long)

net.sf.ehcache.management.CacheConfigurationMBean.getMaxElementsInMemory()

use getMaxEntriesLocalHeap()

net.sf.ehcache.management.CacheConfigurationMBean.getMaxElementsOnDisk()

use getMaxEntriesLocalDisk()

net.sf.ehcache.management.CacheConfigurationMBean.getMaxMemoryOffHeapInBytes()

use getMaxBytesLocalOffHeap()

net.sf.ehcache.management.CacheConfigurationMBean.setMaxElementsInMemory(int maxElements)

use setMaxEntriesLocalHeap(long)

net.sf.ehcache.management.CacheConfigurationMBean.setMaxElementsOnDisk(int maxElements)

use setMaxEntriesLocalDisk(long)

net.sf.ehcache.management.sampled.CacheSamplerImpl.getOffHeapSize()

use getLocalOffHeapSize()

net.sf.ehcache.management.sampled.CacheSamplerImpl.getOnDiskSize()

use getLocalDiskSize()

Returns:

the number of elements in memory
net.sf.ehcache.management.sampled.LegacyCacheStatistics.getInMemorySize()

use getLocalHeapSize()

Returns:

the number of elements in off-heap
net.sf.ehcache.management.sampled.LegacyCacheStatistics.getOffHeapSize()

use getLocalOffHeapSize()

Returns:

number of elements on disk
net.sf.ehcache.management.sampled.LegacyCacheStatistics.getOnDiskSize()

use getLocalDiskSize()

net.sf.ehcache.management.sampled.SampledCache.getInMemorySize()

use getLocalHeapSize()

net.sf.ehcache.management.sampled.SampledCache.getOffHeapSize()

use getLocalOffHeapSize()

net.sf.ehcache.management.sampled.SampledCache.getOnDiskSize()

use getLocalDiskSize()

net.sf.ehcache.management.sampled.SampledCache.isClusterCoherent()

net.sf.ehcache.management.sampled.SampledCache.isNodeCoherent()

net.sf.ehcache.management.sampled.SampledCache.setNodeCoherent(boolean coherent)

use setNodeBulkLoadEnabled(boolean) instead

Returns:

Max elements in memory config setting value
net.sf.ehcache.management.sampled.SampledCacheMBean.getMaxElementsInMemory()

use getMaxEntriesLocalHeap() instead

net.sf.ehcache.management.sampled.SampledCacheMBean.isClusterCoherent()

use isClusterBulkLoadEnabled() instead

net.sf.ehcache.management.sampled.SampledCacheMBean.isNodeCoherent()

use isNodeBulkLoadEnabled() instead

net.sf.ehcache.management.sampled.SampledCacheMBean.setMaxElementsInMemory(int maxElements)

use CacheSampler#setMaxEntriesLocalHeap(long maxElements) instead

net.sf.ehcache.management.sampled.SampledCacheMBean.setNodeCoherent(boolean coherent)

use setNodeBulkLoadEnabled(boolean) instead

net.sf.ehcache.statistics.CacheUsageListener.notifyTimeTakenForGet(final long millis)

net.sf.ehcache.store.AuthoritativeTier.putFaulted(Element element)

net.sf.ehcache.store.CacheStore.CacheStore(final CachingTier<Object, Element>
the cache fronting the authority
cache, final AuthoritativeTier
the authority fronted by the cache
authority, final CacheConfiguration
OMFG! NOOOOOooooo.....
cacheConfiguration)

net.sf.ehcache.store.CacheStore.cacheConfiguration

net.sf.ehcache.store.CacheStore.containsKeyInMemory(final Object
The Element key
key)

net.sf.ehcache.store.CacheStore.containsKeyOffHeap(final Object
The Element key
key)

net.sf.ehcache.store.CacheStore.containsKeyOnDisk(final Object
The Element key
key)

net.sf.ehcache.store.CacheStore.getInternalContext()

net.sf.ehcache.store.CacheStore.masterLocks

net.sf.ehcache.store.CachingTier.contains(K key)

Returns:

the policy
net.sf.ehcache.store.CachingTier.getEvictionPolicy()

Returns:

the count of entries held in heap
net.sf.ehcache.store.CachingTier.getInMemorySize()

net.sf.ehcache.store.CachingTier.getInMemorySizeInBytes()

Returns:

the count of entries held off heap
net.sf.ehcache.store.CachingTier.getOffHeapSize()

net.sf.ehcache.store.CachingTier.getOffHeapSizeInBytes()

net.sf.ehcache.store.CachingTier.getOnDiskSizeInBytes()

net.sf.ehcache.store.CachingTier.recalculateSize(K
the key to perform the recalculation for
key)

net.sf.ehcache.store.CachingTier.setEvictionPolicy(Policy
the policy to use
policy)

Returns:

a backing map
net.sf.ehcache.store.MemoryStore.BackingFactory.newBackingMap(PoolAccessor<T extends PoolParticipant>
on-heap pool accessor
poolAccessor, int
initial store capacity
initialCapacity, float
map load factor
loadFactor, int
map concurrency
concurrency, int
maximum store capacity
maximumCapacity, RegisteredEventListeners
event listener (or null for no notifications)
eventListener)

Returns:

select target names, searchAttribute or aggregator
net.sf.ehcache.store.StoreQuery.getTargets()

net.sf.ehcache.store.StoreQuery.targets(String[] targets)

Returns:

the Set of entries
net.sf.ehcache.store.cachingtier.HeapCacheBackEnd.entrySet()

Returns:

the policy
net.sf.ehcache.store.cachingtier.HeapCacheBackEnd.getPolicy()

net.sf.ehcache.store.cachingtier.HeapCacheBackEnd.recalculateSize(K key)

net.sf.ehcache.store.cachingtier.HeapCacheBackEnd.setPolicy(Policy
the policy to use
policy)

Returns:

the amount of mappings installed
net.sf.ehcache.store.cachingtier.HeapCacheBackEnd.size()

Returns:

the amount of bytes for this backend
net.sf.ehcache.store.cachingtier.PooledBasedBackEnd.getSizeInBytes()

net.sf.ehcache.store.compound.CopyStrategy

replaced by net.sf.ehcache.store.compound.ReadWriteCopyStrategy

net.sf.ehcache.store.compound.LegacyCopyStrategyAdapter.LegacyCopyStrategyAdapter(CopyStrategy
the legacy CopyStrategy to adapt
legacyCopyStrategy)

Deprecated as a consequence of CopyStrategy being deprecated. See corresponding docs for further information.

net.sf.ehcache.store.compound.LegacyCopyStrategyAdapter.legacyCopyStrategy

Deprecated as a consequence of CopyStrategy being deprecated. See corresponding docs for further information.

net.sf.ehcache.store.disk.Segment.returnSafeDeprecated(final Object key, final int hash, final Element element)

net.sf.ehcache.util.SlewClock.realignWithTimeProvider()

net.sf.ehcache.util.concurrent.ConcurrentHashMap.recalculateSize(final K k)