A B C D E F G H I L M N O P Q R S T U V W Z

A

access(Duration) - Method in class org.ehcache.config.builders.ExpiryPolicyBuilder

Set TTL since last access

add(ServiceConfiguration<?>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Adds a ServiceConfiguration to the returned builder.

add(Builder<? extends ServiceConfiguration<?>>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Convenience method to add a ServiceConfiguration that is produced by a Builder.

adviseAgainstEviction(K, V) - Method in interface org.ehcache.config.EvictionAdvisor

Returns true if the given key value pair should not be evicted if possible.

asynchronous() - Method in class org.ehcache.config.builders.CacheEventListenerConfigurationBuilder

Sets the returned builder for asynchronous event processing.

B

batchSize(int) - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder.BatchedWriteBehindConfigurationBuilder

Updates the batch size on the returned builder.

build() - Method in interface org.ehcache.config.Builder

Builds an instance.

build() - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

build() - Method in class org.ehcache.config.builders.CacheEventListenerConfigurationBuilder

Builds the CacheEventListenerConfiguration this builder represents.

build(boolean) - Method in class org.ehcache.config.builders.CacheManagerBuilder

Builds a CacheManager or a subtype of it and initializes it if requested.

build() - Method in class org.ehcache.config.builders.CacheManagerBuilder

Builds a CacheManager or a subtype of it uninitialized.

build() - Method in class org.ehcache.config.builders.ExpiryPolicyBuilder

build() - Method in class org.ehcache.config.builders.PooledExecutionServiceConfigurationBuilder

Builds the PooledExecutionServiceConfiguration

build() - Method in class org.ehcache.config.builders.ResourcePoolsBuilder

Builds the ResourcePools based on this builder's configuration.

build(boolean) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Builds the UserManagedCache, initializing it if requested.

build() - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Builds an unitialized UserManagedCache.

build() - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder.BatchedWriteBehindConfigurationBuilder

Builds the WriteBehindConfiguration

build() - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder.UnBatchedWriteBehindConfigurationBuilder

Builds the WriteBehindConfiguration

build() - Method in class org.ehcache.expiry.Expirations.ExpiryBuilder

Deprecated.

Builder<T> - Interface in org.ehcache.config

A builder of Ts.

builder(CacheManagerBuilder<? extends CacheManager>) - Method in interface org.ehcache.config.builders.CacheManagerConfiguration

Enables to refine the type that the CacheManagerBuilder will build.

builder(UserManagedCacheBuilder<K, V, ? extends UserManagedCache<K, V>>) - Method in interface org.ehcache.config.builders.UserManagedCacheConfiguration

Enables to refine the type that the UserManagedCacheBuilder will build.

builder() - Static method in class org.ehcache.expiry.Expirations

Deprecated.

Use org.ehcache.config.builders.ExpiryPolicyBuilder#expiry() instead

BulkCacheLoadingException - Exception in org.ehcache.spi.loaderwriter

Thrown by a Cache when its CacheLoaderWriter fails while bulk loading values.

BulkCacheLoadingException(Map<?, Exception>, Map<?, ?>) - Constructor for exception org.ehcache.spi.loaderwriter.BulkCacheLoadingException

Constructs a BulkCacheLoadingException instance with the given maps.

BulkCacheLoadingException(String, Map<Object, Exception>, Map<Object, Object>) - Constructor for exception org.ehcache.spi.loaderwriter.BulkCacheLoadingException

Constructs a new exception instance with the given message and maps.

BulkCacheWritingException - Exception in org.ehcache.spi.loaderwriter

Thrown by a Cache when its CacheLoaderWriter fails while bulk mutating values.

BulkCacheWritingException(Map<?, Exception>, Set<?>) - Constructor for exception org.ehcache.spi.loaderwriter.BulkCacheWritingException

Constructs a BulkCacheWritingException instance with the given map and set.

C

Cache<K,V> - Interface in org.ehcache

Defines all operational methods to create, access, update and delete mappings of key to value.

Cache.Entry<K,V> - Interface in org.ehcache

A mapping of key to value held in a Cache.

CacheConfiguration<K,V> - Interface in org.ehcache.config

Represents the minimal configuration for a Cache.

CacheConfigurationBuilder<K,V> - Class in org.ehcache.config.builders

The CacheConfigurationBuilder enables building CacheConfigurations using a fluent style.

CacheEvent<K,V> - Interface in org.ehcache.event

An event resulting from a mutative Cache operation.

CacheEventListener<K,V> - Interface in org.ehcache.event

Definition of the contract for implementing listeners to receive CacheEvents from a Cache.

CacheEventListenerConfigurationBuilder - Class in org.ehcache.config.builders

The CacheEventListenerConfigurationBuilder enables building CacheEventListenerConfigurations using a fluent style.

CacheIterationException - Exception in org.ehcache

Indicates an unrecoverable failure occurred during iteration.

CacheIterationException() - Constructor for exception org.ehcache.CacheIterationException

Creates a CacheIterationException.

CacheIterationException(String) - Constructor for exception org.ehcache.CacheIterationException

Creates a CacheIterationException with the provided message.

CacheIterationException(String, Throwable) - Constructor for exception org.ehcache.CacheIterationException

Creates a CacheIterationException with the provided message and cause.

CacheIterationException(Throwable) - Constructor for exception org.ehcache.CacheIterationException

Creates a CacheIterationException with the provided cause.

CacheLoaderWriter<K,V> - Interface in org.ehcache.spi.loaderwriter

A CacheLoaderWriter is used to keep a Cache in sync with another system.

CacheLoaderWriterProvider - Interface in org.ehcache.spi.loaderwriter

A Service that creates CacheLoaderWriter instances.

CacheLoadingException - Exception in org.ehcache.spi.loaderwriter

Thrown by a Cache when the CacheLoaderWriter fails when loading a value.

CacheLoadingException() - Constructor for exception org.ehcache.spi.loaderwriter.CacheLoadingException

Constructs a CacheLoadingException.

CacheLoadingException(String) - Constructor for exception org.ehcache.spi.loaderwriter.CacheLoadingException

Constructs a CacheLoadingException with the provided message.

CacheLoadingException(String, Throwable) - Constructor for exception org.ehcache.spi.loaderwriter.CacheLoadingException

Constructs a CacheLoadingException wrapping the cause passed in and with the provided message.

CacheLoadingException(Throwable) - Constructor for exception org.ehcache.spi.loaderwriter.CacheLoadingException

Constructs a CacheLoadingException wrapping the cause passed in.

CacheManager - Interface in org.ehcache

A repository that manages Caches and associated Services.

CacheManagerBuilder<T extends CacheManager> - Class in org.ehcache.config.builders

The CacheManagerBuilder enables building cache managers using a fluent style.

CacheManagerConfiguration<T extends CacheManager> - Interface in org.ehcache.config.builders

A configuration type that enables to further specify the type of CacheManager in a CacheManagerBuilder.

CachePersistenceException - Exception in org.ehcache

Thrown when failures occur during operations on PersistentCacheManager.

CachePersistenceException(String) - Constructor for exception org.ehcache.CachePersistenceException

Creates a CachePersistenceException with the provided message.

CachePersistenceException(String, Throwable) - Constructor for exception org.ehcache.CachePersistenceException

Creates a CachePersistenceException with the provided message and cause.

CacheRuntimeConfiguration<K,V> - Interface in org.ehcache.config

Represents the configuration currently used by a Cache.

CacheWritingException - Exception in org.ehcache.spi.loaderwriter

Thrown by a Cache when the CacheLoaderWriter fails when writing a value.

CacheWritingException() - Constructor for exception org.ehcache.spi.loaderwriter.CacheWritingException

Constructs a CacheWritingException.

CacheWritingException(String) - Constructor for exception org.ehcache.spi.loaderwriter.CacheWritingException

Constructs a CacheWritingException with the provided message.

CacheWritingException(String, Throwable) - Constructor for exception org.ehcache.spi.loaderwriter.CacheWritingException

Constructs a CacheWritingException wrapping the cause passed in and with the provided message.

CacheWritingException(Throwable) - Constructor for exception org.ehcache.spi.loaderwriter.CacheWritingException

Constructs a CacheWritingException wrapping the cause passed in.

clear() - Method in interface org.ehcache.Cache

Removes all mappings currently present in the Cache.

clearAllServiceConfig() - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Clears all ServiceConfigurations from the returned builder.

clearFailure(StoreAccessException) - Method in interface org.ehcache.spi.resilience.ResilienceStrategy

Called when a Cache.clear() fails due to an underlying store failure.

close() - Method in interface org.ehcache.CacheManager

Transitions this CacheManager to UNINITIALIZED.

close() - Method in interface org.ehcache.UserManagedCache

Transitions this UserManagedCache to UNINITIALIZED.

compareTo(long, long, ResourceUnit) - Method in interface org.ehcache.config.ResourceUnit

Compares thisSize in this unit to thatSize in thatUnit.

compareTo(long, long, ResourceUnit) - Method in enum org.ehcache.config.units.MemoryUnit

Compares thisSize in this unit to thatSize in thatUnit.

concurrency - Variable in class org.ehcache.config.builders.WriteBehindConfigurationBuilder

concurrencyLevel(int) - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder.BatchedWriteBehindConfigurationBuilder

Sets the concurrency level on the returned builder.

concurrencyLevel(int) - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder

Sets the concurrency level on the returned builder.

concurrencyLevel(int) - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder.UnBatchedWriteBehindConfigurationBuilder

Sets the concurrency level on the returned builder.

Configuration - Interface in org.ehcache.config

Represents the configuration for a CacheManager.

constructedWith(Object...) - Method in class org.ehcache.config.builders.CacheEventListenerConfigurationBuilder

Adds arguments that will be passed to the constructor of the CacheEventListener subclass configured previously.

containsKey(K) - Method in interface org.ehcache.Cache

Checks whether a mapping for the given key is present, without retrieving the associated value.

containsKeyFailure(K, StoreAccessException) - Method in interface org.ehcache.spi.resilience.ResilienceStrategy

Called when a Cache.containsKey(java.lang.Object) fails due to an underlying store failure, and the resultant cache load operation also fails.

convert(long, MemoryUnit) - Method in enum org.ehcache.config.units.MemoryUnit

Converts quantity in unit into this unit.

Copier<T> - Interface in org.ehcache.spi.copy

Defines the contract used to copy type instances.

copyForRead(T) - Method in interface org.ehcache.spi.copy.Copier

Creates a copy of the instance passed in.

copyForWrite(T) - Method in interface org.ehcache.spi.copy.Copier

Creates a copy of the instance passed in.

CopyProvider - Interface in org.ehcache.spi.copy

A Service providing Copier instances.

create(Duration) - Method in class org.ehcache.config.builders.ExpiryPolicyBuilder

Set TTL since creation

createCache(String, CacheConfiguration<K, V>) - Method in interface org.ehcache.CacheManager

Creates a Cache in this CacheManager according to the specified CacheConfiguration.

createCache(String, Builder<? extends CacheConfiguration<K, V>>) - Method in interface org.ehcache.CacheManager

Creates a Cache in this CacheManager according to the specified CacheConfiguration provided through a Builder.

createCacheLoaderWriter(String, CacheConfiguration<K, V>) - Method in interface org.ehcache.spi.loaderwriter.CacheLoaderWriterProvider

Creates a CacheLoaderWriter for use with the Cache of the given alias and configuration.

createKeyCopier(Class<T>, Serializer<T>, ServiceConfiguration<?>...) - Method in interface org.ehcache.spi.copy.CopyProvider

Creates a key Copier with the given parameters.

createKeySerializer(Class<T>, ClassLoader, ServiceConfiguration<?>...) - Method in interface org.ehcache.spi.serialization.SerializationProvider

Creates a key Serializer with the given parameters.

createResilienceStrategy(String, CacheConfiguration<K, V>, RecoveryStore<K>) - Method in interface org.ehcache.spi.resilience.ResilienceStrategyProvider

Creates a ResilienceStrategy for the Cache with the given alias and configuration using the given RecoveryStore.

createResilienceStrategy(String, CacheConfiguration<K, V>, RecoveryStore<K>, CacheLoaderWriter<? super K, V>) - Method in interface org.ehcache.spi.resilience.ResilienceStrategyProvider

Creates a ResilienceStrategy for the Cache with the given alias and configuration using the given RecoveryStore and CacheLoaderWriter

createValueCopier(Class<T>, Serializer<T>, ServiceConfiguration<?>...) - Method in interface org.ehcache.spi.copy.CopyProvider

Creates a value Copier with the given parameters.

createValueSerializer(Class<T>, ClassLoader, ServiceConfiguration<?>...) - Method in interface org.ehcache.spi.serialization.SerializationProvider

Creates a value Serializer with the given parameters.

createWriteBehindLoaderWriter(CacheLoaderWriter<K, V>, WriteBehindConfiguration) - Method in interface org.ehcache.spi.loaderwriter.WriteBehindProvider

Creates write-behind decorated CacheLoaderWriter according to the given configuration.

D

defaultPool(String, int, int) - Method in class org.ehcache.config.builders.PooledExecutionServiceConfigurationBuilder

Adds a default pool configuration to the returned builder.

delete(K) - Method in interface org.ehcache.spi.loaderwriter.CacheLoaderWriter

Deletes a single mapping.

deleteAll(Iterable<? extends K>) - Method in interface org.ehcache.spi.loaderwriter.CacheLoaderWriter

Deletes multiple mappings.

deregisterCacheEventListener(CacheEventListener<? super K, ? super V>) - Method in interface org.ehcache.config.CacheRuntimeConfiguration

Deregisters a previously registered CacheEventListener instance.

destroy() - Method in interface org.ehcache.PersistentCacheManager

Destroys all persistent data associated with this PersistentCacheManager.

destroy() - Method in interface org.ehcache.PersistentUserManagedCache

Destroys all persistent data structures for this PersistentUserManagedCache.

destroy(String) - Method in interface org.ehcache.spi.persistence.PersistableResourceService

Destroys the persistence space with the given name.

destroyAll() - Method in interface org.ehcache.spi.persistence.PersistableResourceService

Destroys all persistence spaces.

destroyCache(String) - Method in interface org.ehcache.PersistentCacheManager

Destroys all data persistent data associated with the aliased Cache instance managed by this CacheManager.

disableCoalescing() - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder.BatchedWriteBehindConfigurationBuilder

Disables batch coalescing on the returned builder.

disk(long, MemoryUnit) - Method in class org.ehcache.config.builders.ResourcePoolsBuilder

Convenience method to add a non persistent disk pool.

disk(long, MemoryUnit, boolean) - Method in class org.ehcache.config.builders.ResourcePoolsBuilder

Convenience method to add a disk pool specifying persistence.

Duration - Class in org.ehcache.expiry

Deprecated.

Replaced with Duration

Duration(long, TimeUnit) - Constructor for class org.ehcache.expiry.Duration

Deprecated.

Instantiates a new Duration of the given length and TimeUnit.

E

enableCoalescing() - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder.BatchedWriteBehindConfigurationBuilder

Enables batch coalescing on the returned builder.

entrySet() - Method in interface org.ehcache.spi.persistence.StateHolder

Retrieves all the entries in the StateHolder as a Set of Map.Entry instances.

EntryUnit - Enum in org.ehcache.config.units

A ResourceUnit that designates a count by entries.

equals(Object) - Method in class org.ehcache.expiry.Duration

Deprecated.

equals(T, ByteBuffer) - Method in interface org.ehcache.spi.serialization.Serializer

Checks if the given instance and serial form represent the same instance.

EventFiring - Enum in org.ehcache.event

The supported event firing modes.

eventOrdering(EventOrdering) - Method in class org.ehcache.config.builders.CacheEventListenerConfigurationBuilder

Adds specific EventOrdering to the returned builder.

EventOrdering - Enum in org.ehcache.event

The supported event ordering modes.

EventType - Enum in org.ehcache.event

The different event types.

Eviction - Class in org.ehcache.config

Utility class for getting predefined EvictionAdvisor instances.

Eviction() - Constructor for class org.ehcache.config.Eviction

EvictionAdvisor<K,V> - Interface in org.ehcache.config

A specialized predicate used to advise on eviction of cache entries.

Expirations - Class in org.ehcache.expiry

Deprecated.

Expirations.ExpiryBuilder<K,V> - Class in org.ehcache.expiry

Deprecated.

expiry() - Static method in class org.ehcache.config.builders.ExpiryPolicyBuilder

Fluent API for creating an ExpiryPolicy instance where you can specify constant values for creation, access and update time.

Expiry<K,V> - Interface in org.ehcache.expiry

Deprecated.

Replaced with ExpiryPolicy that builds on the java.time types.

ExpiryPolicy<K,V> - Interface in org.ehcache.expiry

A policy object that governs expiration for mappings in a Cache.

ExpiryPolicyBuilder - Class in org.ehcache.config.builders

Builder and utilities for getting predefined ExpiryPolicy instances.

F

firingMode(EventFiring) - Method in class org.ehcache.config.builders.CacheEventListenerConfigurationBuilder

Adds specific EventFiring to the returned builder.

G

get(K) - Method in interface org.ehcache.Cache

Retrieves the value currently mapped to the provided key.

get(K) - Method in interface org.ehcache.spi.persistence.StateHolder

Retrieves the value mapped to the given key

getAll(Set<? extends K>) - Method in interface org.ehcache.Cache

Retrieves all values associated with the given key set.

getAllFailure(Iterable<? extends K>, StoreAccessException) - Method in interface org.ehcache.spi.resilience.ResilienceStrategy

Called when a Cache.getAll(java.util.Set) fails on a cache without a cache loader due to an underlying store failure.

getBatchingConfiguration() - Method in interface org.ehcache.spi.loaderwriter.WriteBehindConfiguration

Returns the batching configuration or null if batching is not enabled.

getBatchSize() - Method in interface org.ehcache.spi.loaderwriter.WriteBehindConfiguration.BatchingConfiguration

The recommended size of a batch of operations.

getCache(String, Class<K>, Class<V>) - Method in interface org.ehcache.CacheManager

Retrieves the Cache associated with the given alias, if one is known.

getCacheConfigurations() - Method in interface org.ehcache.config.Configuration

Mapping of aliases to CacheConfigurations, used to configure the Caches managed by the CacheManager.

getClassLoader() - Method in interface org.ehcache.config.CacheConfiguration

The ClassLoader for the Cache.

getClassLoader() - Method in interface org.ehcache.config.Configuration

The ClassLoader for the CacheManager.

getConcurrency() - Method in interface org.ehcache.spi.loaderwriter.WriteBehindConfiguration

The concurrency of the write behind engines queues.

getEvictionAdvisor() - Method in interface org.ehcache.config.CacheConfiguration

The EvictionAdvisor predicate function.

getExistingServiceConfiguration(Class<T>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Returns the first ServiceConfiguration with type matching the class passed in.

getExistingServiceConfigurations(Class<T>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Returns all ServiceConfigurations of type matching the class passed in.

getExpiry() - Method in interface org.ehcache.config.CacheConfiguration

Deprecated.

Use CacheConfiguration.getExpiryPolicy()

getExpiryForAccess(K, ValueSupplier<? extends V>) - Method in interface org.ehcache.expiry.Expiry

Deprecated.

Returns the expiration Duration (relative to the current time) when an existing entry is accessed from a Cache.

getExpiryForAccess(K, Supplier<? extends V>) - Method in interface org.ehcache.expiry.ExpiryPolicy

Returns the expiration duration (relative to the current time) when an existing entry is accessed from a Cache.

getExpiryForCreation(K, V) - Method in interface org.ehcache.expiry.Expiry

Deprecated.

Returns the lifetime of an entry when it is initially added to a Cache.

getExpiryForCreation(K, V) - Method in interface org.ehcache.expiry.ExpiryPolicy

Returns the lifetime of an entry when it is initially added to a Cache.

getExpiryForUpdate(K, ValueSupplier<? extends V>, V) - Method in interface org.ehcache.expiry.Expiry

Deprecated.

Returns the expiration Duration (relative to the current time) when an existing entry is updated in a Cache.

getExpiryForUpdate(K, Supplier<? extends V>, V) - Method in interface org.ehcache.expiry.ExpiryPolicy

Returns the expiration duration (relative to the current time) when an existing entry is updated in a Cache.

getExpiryPolicy() - Method in interface org.ehcache.config.CacheConfiguration

The ExpiryPolicy rules for the Cache.

getFailure(K, StoreAccessException) - Method in interface org.ehcache.spi.resilience.ResilienceStrategy

Called when a Cache.get(java.lang.Object) fails on a cache without a cache loader due to an underlying store failure.

getFailures() - Method in exception org.ehcache.spi.loaderwriter.BulkCacheLoadingException

Returns the map of keys to exception.

getFailures() - Method in exception org.ehcache.spi.loaderwriter.BulkCacheWritingException

Returns the map of keys to exception.

getKey() - Method in interface org.ehcache.Cache.Entry

Returns the key of this mapping

getKey() - Method in interface org.ehcache.event.CacheEvent

The key of the mapping affected by this event.

getKeyType() - Method in interface org.ehcache.config.CacheConfiguration

The key type for the Cache.

getLength() - Method in class org.ehcache.expiry.Duration

Deprecated.

Gets the length of time this Duration represents.

getMaxDelay() - Method in interface org.ehcache.spi.loaderwriter.WriteBehindConfiguration.BatchingConfiguration

The maximum time to wait before writing behind.

getMaxDelayUnit() - Method in interface org.ehcache.spi.loaderwriter.WriteBehindConfiguration.BatchingConfiguration

The time unit for the maximum delay.

getMaxQueueSize() - Method in interface org.ehcache.spi.loaderwriter.WriteBehindConfiguration

The maximum number of operations allowed on each write behind queue.

getMessage() - Method in exception org.ehcache.spi.loaderwriter.BulkCacheWritingException

getNewValue() - Method in interface org.ehcache.event.CacheEvent

The mapped value immediately after the mutative event occurred.

getOldValue() - Method in interface org.ehcache.event.CacheEvent

The mapped value immediately before the mutative event occurred.

getPersistenceSpaceIdentifier(String, CacheConfiguration<?, ?>) - Method in interface org.ehcache.spi.persistence.PersistableResourceService

Returns a PersistableResourceService.PersistenceSpaceIdentifier for the space associated to the provided arguments.

getPersistentStateHolder(String, Class<K>, Class<V>) - Method in interface org.ehcache.spi.persistence.StateRepository

Deprecated.

Replaced by StateRepository.getPersistentStateHolder(String, Class, Class, Predicate, ClassLoader) that takes in a Predicate that authorizes a class for deserialization

getPersistentStateHolder(String, Class<K>, Class<V>, Predicate<Class<?>>, ClassLoader) - Method in interface org.ehcache.spi.persistence.StateRepository

Gets a named state holder rooted in the current StateRepository.

getPoolForResource(ResourceType<P>) - Method in interface org.ehcache.config.ResourcePools

Gets a specific ResourcePool based on its type.

getResourcePoolClass() - Method in enum org.ehcache.config.ResourceType.Core

getResourcePoolClass() - Method in interface org.ehcache.config.ResourceType

Gets the ResourcePool type associated with this ResourceType.

getResourcePools() - Method in interface org.ehcache.config.CacheConfiguration

The ResourcePools for the Cache.

getResourceTypeSet() - Method in interface org.ehcache.config.ResourcePools

Gets the set of ResourceTypes present in the ResourcePools.

getRuntimeConfiguration() - Method in interface org.ehcache.Cache

Exposes the CacheRuntimeConfiguration associated with this Cache instance.

getRuntimeConfiguration() - Method in interface org.ehcache.CacheManager

Returns the current Configuration used by this CacheManager.

getService(Class<U>) - Method in interface org.ehcache.spi.service.ServiceProvider

Looks up the Service of the given serviceType.

getServiceConfigurations() - Method in interface org.ehcache.config.CacheConfiguration

The service configurations defined for the Cache.

getServiceCreationConfigurations() - Method in interface org.ehcache.config.Configuration

ServiceCreationConfiguration initially used to bootstrap the CacheManager and its Caches.

getServicesOfType(Class<U>) - Method in interface org.ehcache.spi.service.ServiceProvider

Looks up all Service instances that are subtypes of the given serviceType supplied.

getServiceType() - Method in interface org.ehcache.spi.service.ServiceConfiguration

Indicates which service this configuration works with.

getServiceType() - Method in interface org.ehcache.spi.service.ServiceCreationConfiguration

Indicates which service consumes this configuration at creation.

getSize() - Method in interface org.ehcache.config.SizedResourcePool

Gets the size of this pool.

getSource() - Method in interface org.ehcache.event.CacheEvent

Deprecated.

getStateRepositoryWithin(PersistableResourceService.PersistenceSpaceIdentifier<?>, String) - Method in interface org.ehcache.spi.persistence.PersistableResourceService

Returns a named state repository in the context of the given identifier.

getStatus() - Method in interface org.ehcache.CacheManager

Returns the current Status of this CacheManager.

getStatus() - Method in interface org.ehcache.UserManagedCache

Returns the current Status of this UserManagedCache.

getSuccesses() - Method in exception org.ehcache.spi.loaderwriter.BulkCacheLoadingException

Returns the map of keys to value.

getSuccesses() - Method in exception org.ehcache.spi.loaderwriter.BulkCacheWritingException

Returns the set of keys that were successfully written.

getThreadPoolAlias() - Method in interface org.ehcache.spi.loaderwriter.WriteBehindConfiguration

Returns the alias of the thread resource pool to use for write behind task execution.

getTierHeight() - Method in enum org.ehcache.config.ResourceType.Core

getTierHeight() - Method in interface org.ehcache.config.ResourceType

Indicates the level this resource sits in the tiering system.

getTimeUnit() - Method in class org.ehcache.expiry.Duration

Deprecated.

Gets the TimeUnit of this Duration.

getType() - Method in interface org.ehcache.config.ResourcePool

Get the ResourceType.

getType() - Method in interface org.ehcache.event.CacheEvent

Gets the EventType of this event.

getUnit() - Method in interface org.ehcache.config.SizedResourcePool

Gets the unit in which the resource is sized.

getValue() - Method in interface org.ehcache.Cache.Entry

Returns the value of this mapping

getValueType() - Method in interface org.ehcache.config.CacheConfiguration

The value type for the Cache.

H

handlesResourceType(ResourceType<?>) - Method in interface org.ehcache.spi.persistence.PersistableResourceService

Returns true if this service handles the given resource type.

hasConfiguredExpiry() - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Indicates whether this builder has configured expiry or not.

hashCode() - Method in class org.ehcache.expiry.Duration

Deprecated.

heap(long) - Static method in class org.ehcache.config.builders.ResourcePoolsBuilder

Creates a new ResourcePoolsBuilder with a heap pool sized in entries

heap(long, ResourceUnit) - Method in class org.ehcache.config.builders.ResourcePoolsBuilder

Convenience method to add a heap pool.

I

identifier(String) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Adds an identifier to the returned builder.

INFINITE - Static variable in class org.ehcache.expiry.Duration

Deprecated.

The infinite Duration.

INFINITE - Static variable in interface org.ehcache.expiry.ExpiryPolicy

A duration that represents an infinite time.

init() - Method in interface org.ehcache.CacheManager

Transitions this CacheManager to AVAILABLE.

init(StateRepository) - Method in interface org.ehcache.spi.serialization.StatefulSerializer

This method is used to inject a StateRepository to the serializer by the authoritative tier of a cache during the cache initialization.

init() - Method in interface org.ehcache.UserManagedCache

Transitions this UserManagedCache to AVAILABLE.

isCoalescing() - Method in interface org.ehcache.spi.loaderwriter.WriteBehindConfiguration.BatchingConfiguration

Whether write operations can be coalesced.

isInfinite() - Method in class org.ehcache.expiry.Duration

Deprecated.

Indicates if this duration represents Duration.INFINITE or an infinite Duration.

isOrdered() - Method in enum org.ehcache.event.EventOrdering

Indicates if the mode obeys ordering.

isPersistable() - Method in enum org.ehcache.config.ResourceType.Core

isPersistable() - Method in interface org.ehcache.config.ResourceType

Indicates whether this ResourceType supports persistence.

isPersistent() - Method in interface org.ehcache.config.ResourcePool

Indicates whether the underlying resource is persistent.

iteratorFailure(StoreAccessException) - Method in interface org.ehcache.spi.resilience.ResilienceStrategy

Called when a cache iterator advancement fails due to an underlying store failure.

L

load(K) - Method in interface org.ehcache.spi.loaderwriter.CacheLoaderWriter

Loads a single value.

loadAll(Iterable<? extends K>) - Method in interface org.ehcache.spi.loaderwriter.CacheLoaderWriter

Loads multiple values.

M

MaintainableService - Interface in org.ehcache.spi.service

Service interface that indicates that implementing services participate in MAINTENANCE mode.

MaintainableService.MaintenanceScope - Enum in org.ehcache.spi.service

Defines Maintenance scope

maxWriteDelay(long, TimeUnit) - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder.BatchedWriteBehindConfigurationBuilder

Updates the max write delay on the returned builder.

MemoryUnit - Enum in org.ehcache.config.units

A ResourceUnit that designates memory quantity.

N

newBatchedWriteBehindConfiguration(long, TimeUnit, int) - Static method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder

Creates a new builder for WriteBehindConfiguration that supports batching.

newCacheConfigurationBuilder(Class<K>, Class<V>, ResourcePools) - Static method in class org.ehcache.config.builders.CacheConfigurationBuilder

Creates a new instance ready to produce a CacheConfiguration with key type <K> and with value type <V> and which will use the configured resources.

newCacheConfigurationBuilder(Class<K>, Class<V>, Builder<? extends ResourcePools>) - Static method in class org.ehcache.config.builders.CacheConfigurationBuilder

Creates a new instance ready to produce a CacheConfiguration with key type <K> and with value type <V> and which will use the configured resources, passed as a ResourcePoolsBuilder.

newCacheConfigurationBuilder(CacheConfiguration<K, V>) - Static method in class org.ehcache.config.builders.CacheConfigurationBuilder

Creates a new instance ready to produce a CacheConfiguration functionally equivalent to the supplied configuration.

newCacheManager(Configuration) - Static method in class org.ehcache.config.builders.CacheManagerBuilder

Creates a new CacheManager based on the provided configuration.

newCacheManagerBuilder() - Static method in class org.ehcache.config.builders.CacheManagerBuilder

Creates a new CacheManagerBuilder

newEventListenerConfiguration(Class<? extends CacheEventListener<?, ?>>, EventType, EventType...) - Static method in class org.ehcache.config.builders.CacheEventListenerConfigurationBuilder

Creates a new builder instance using the given CacheEventListener subclass and the EventTypes it will listen to.

newEventListenerConfiguration(CacheEventListener<?, ?>, EventType, EventType...) - Static method in class org.ehcache.config.builders.CacheEventListenerConfigurationBuilder

Creates a new builder instance using the given CacheEventListener instance and the EventTypes it will listen to.

newEventListenerConfiguration(Class<? extends CacheEventListener<?, ?>>, Set<EventType>) - Static method in class org.ehcache.config.builders.CacheEventListenerConfigurationBuilder

Creates a new builder instance using the given CacheEventListener subclass and the set of EventTypes to listen to.

newEventListenerConfiguration(CacheEventListener<?, ?>, Set<EventType>) - Static method in class org.ehcache.config.builders.CacheEventListenerConfigurationBuilder

Creates a new builder instance using the given CacheEventListener instance and the set of EventTypes to listen to.

newPooledExecutionServiceConfigurationBuilder() - Static method in class org.ehcache.config.builders.PooledExecutionServiceConfigurationBuilder

Creates a new instance of PooledExecutionServiceConfigurationBuilder

newResourcePoolsBuilder() - Static method in class org.ehcache.config.builders.ResourcePoolsBuilder

Creates a new ResourcePoolsBuilder.

newResourcePoolsBuilder(ResourcePools) - Static method in class org.ehcache.config.builders.ResourcePoolsBuilder

Convenience method to get a builder from an existing ResourcePools.

newUnBatchedWriteBehindConfiguration() - Static method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder

Creates a new builder for WriteBehindConfiguration without batching support.

newUserManagedCacheBuilder(Class<K>, Class<V>) - Static method in class org.ehcache.config.builders.UserManagedCacheBuilder

Creates a new UserManagedCacheBuilder.

NO_EXPIRY - Static variable in interface org.ehcache.expiry.ExpiryPolicy

An ExpiryPolicy that represents a no expiration policy

noAdvice() - Static method in class org.ehcache.config.Eviction

Returns an EvictionAdvisor where no mappings are advised against eviction.

noExpiration() - Static method in class org.ehcache.config.builders.ExpiryPolicyBuilder

Get an ExpiryPolicy instance for a non expiring (ie.

noExpiration() - Static method in class org.ehcache.expiry.Expirations

Deprecated.

Use org.ehcache.config.builders.ExpiryPolicyBuilder#noExpiration() instead

O

obliterate() - Method in interface org.ehcache.spi.resilience.RecoveryStore

Obliterate all keys in a store.

obliterate(K) - Method in interface org.ehcache.spi.resilience.RecoveryStore

Obliterate a given key.

obliterate(Iterable<? extends K>) - Method in interface org.ehcache.spi.resilience.RecoveryStore

Obliterate a list of keys.

of(long, TimeUnit) - Static method in class org.ehcache.expiry.Duration

Deprecated.

Convenience method to create a Duration with the specified values.

offheap(long, MemoryUnit) - Method in class org.ehcache.config.builders.ResourcePoolsBuilder

Convenience method to add an offheap pool.

onEvent(CacheEvent<? extends K, ? extends V>) - Method in interface org.ehcache.event.CacheEventListener

Invoked on CacheEvent firing.

ordered() - Method in class org.ehcache.config.builders.CacheEventListenerConfigurationBuilder

Sets the returned builder for ordered event processing.

org.ehcache - package org.ehcache

Main Ehcache API, including cache managers and caches.

org.ehcache.config - package org.ehcache.config

CacheManager configuration, Cache configuration and other configuration classes.

org.ehcache.config.builders - package org.ehcache.config.builders

Builders designed to help with programmatic configuration of Ehcache using a fluent API

org.ehcache.config.units - package org.ehcache.config.units

ResourceUnit implementations

org.ehcache.event - package org.ehcache.event

CacheEvent and related types.

org.ehcache.expiry - package org.ehcache.expiry

Expiry API of a Cache.

org.ehcache.spi.copy - package org.ehcache.spi.copy

Copier SPI in Ehcache.

org.ehcache.spi.loaderwriter - package org.ehcache.spi.loaderwriter

CacheLoaderWriter SPI for a Cache.

org.ehcache.spi.persistence - package org.ehcache.spi.persistence

PersistableResourceService and other persistence related SPI.

org.ehcache.spi.resilience - package org.ehcache.spi.resilience

org.ehcache.resilience.ResilienceStrategy API of a Cache.

org.ehcache.spi.serialization - package org.ehcache.spi.serialization

Serializer SPI in Ehcache.

org.ehcache.spi.service - package org.ehcache.spi.service

Service SPI related in Ehcache.

P

PersistableResourceService - Interface in org.ehcache.spi.persistence

Interface for Services that handle a ResourceType which is persistable.

PersistableResourceService.PersistenceSpaceIdentifier<T extends PersistableResourceService> - Interface in org.ehcache.spi.persistence

An identifier for an existing persistable resource.

persistence(String) - Static method in class org.ehcache.config.builders.CacheManagerBuilder

Convenience method to get a CacheManagerConfiguration for a PersistentCacheManager stored on disk.

persistence(File) - Static method in class org.ehcache.config.builders.CacheManagerBuilder

Convenience method to get a CacheManagerConfiguration for a PersistentCacheManager stored on disk.

PersistentCacheManager - Interface in org.ehcache

A CacheManager that knows how to lifecycle caches that can outlive the JVM.

PersistentUserManagedCache<K,V> - Interface in org.ehcache

A UserManagedCache that holds data that can outlive the JVM.

PluralService - Annotation Type in org.ehcache.spi.service

Indicates that a Service subtype is permitted to have more than one concrete implementation registered with a ServiceProvider.

pool(String, int, int) - Method in class org.ehcache.config.builders.PooledExecutionServiceConfigurationBuilder

Adds a pool configuration to the returned builder.

PooledExecutionServiceConfigurationBuilder - Class in org.ehcache.config.builders

The PooledExecutionServiceConfigurationBuilder enables building configurations for an ExecutionService that is pool based using a fluent style.

put(K, V) - Method in interface org.ehcache.Cache

Associates the given value to the given key in this Cache.

putAll(Map<? extends K, ? extends V>) - Method in interface org.ehcache.Cache

Associates all the provided key:value pairs.

putAllFailure(Map<? extends K, ? extends V>, StoreAccessException) - Method in interface org.ehcache.spi.resilience.ResilienceStrategy

Called when a Cache.putAll(java.util.Map) fails due to an underlying store failure.

putFailure(K, V, StoreAccessException) - Method in interface org.ehcache.spi.resilience.ResilienceStrategy

Called when a Cache.put(java.lang.Object, java.lang.Object) fails due to an underlying store failure.

putIfAbsent(K, V) - Method in interface org.ehcache.Cache

Maps the specified key to the specified value in this cache, unless a non-expired mapping already exists.

putIfAbsent(K, V) - Method in interface org.ehcache.spi.persistence.StateHolder

If the specified key is not already associated with a value (or is mapped to null) associates it with the given value and returns null, else returns the current value.

putIfAbsentFailure(K, V, StoreAccessException) - Method in interface org.ehcache.spi.resilience.ResilienceStrategy

Called when a Cache.putIfAbsent(java.lang.Object, java.lang.Object) fails due to an underlying store failure.

Q

queueSize(int) - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder.BatchedWriteBehindConfigurationBuilder

Sets the batch queue size on the returned builder.

queueSize - Variable in class org.ehcache.config.builders.WriteBehindConfigurationBuilder

queueSize(int) - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder

Sets the batch queue size on the returned builder.

queueSize(int) - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder.UnBatchedWriteBehindConfigurationBuilder

Sets the batch queue size on the returned builder.

R

read(ByteBuffer) - Method in interface org.ehcache.spi.serialization.Serializer

Reconstructs an instance from the given serial form.

RecoveryStore<K> - Interface in org.ehcache.spi.resilience

A recovery store is used during entry cleanup done by the ResilienceStrategy.

registerCacheEventListener(CacheEventListener<? super K, ? super V>, EventOrdering, EventFiring, Set<EventType>) - Method in interface org.ehcache.config.CacheRuntimeConfiguration

Registers a CacheEventListener on the cache.

registerCacheEventListener(CacheEventListener<? super K, ? super V>, EventOrdering, EventFiring, EventType, EventType...) - Method in interface org.ehcache.config.CacheRuntimeConfiguration

Registers a CacheEventListener on the cache.

releaseCacheLoaderWriter(CacheLoaderWriter<?, ?>) - Method in interface org.ehcache.spi.loaderwriter.CacheLoaderWriterProvider

Releases a CacheLoaderWriter when the associated Cache is finished with it.

releaseCopier(Copier<?>) - Method in interface org.ehcache.spi.copy.CopyProvider

Releases the provided Copier instance.

releasePersistenceSpaceIdentifier(PersistableResourceService.PersistenceSpaceIdentifier<?>) - Method in interface org.ehcache.spi.persistence.PersistableResourceService

Releases a previously obtained PersistableResourceService.PersistenceSpaceIdentifier.

releaseSerializer(Serializer<?>) - Method in interface org.ehcache.spi.serialization.SerializationProvider

Releases the given Serializer instance.

releaseWriteBehindLoaderWriter(CacheLoaderWriter<?, ?>) - Method in interface org.ehcache.spi.loaderwriter.WriteBehindProvider

Releases a write-behind decorator when the associated Cache is finished with it.

remove(K) - Method in interface org.ehcache.Cache

Removes the value, if any, associated with the provided key.

remove(K, V) - Method in interface org.ehcache.Cache

Removes the entry for a key only if currently mapped to the given value and the entry is not expired.

remove(ServiceConfiguration<?>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Removes a ServiceConfiguration from the returned builder.

removeAll(Set<? extends K>) - Method in interface org.ehcache.Cache

Removes any associated value for the given key set.

removeAllFailure(Iterable<? extends K>, StoreAccessException) - Method in interface org.ehcache.spi.resilience.ResilienceStrategy

Called when a Cache.removeAll(java.util.Set) fails due to an underlying store failure.

removeCache(String) - Method in interface org.ehcache.CacheManager

Removes the Cache associated with the alias provided, if one is known.

removeFailure(K, StoreAccessException) - Method in interface org.ehcache.spi.resilience.ResilienceStrategy

Called when a Cache.remove(java.lang.Object) fails due to an underlying store failure.

removeFailure(K, V, StoreAccessException) - Method in interface org.ehcache.spi.resilience.ResilienceStrategy

Called when a Cache.remove(Object, Object) fails due to an underlying store failure.

replace(K, V) - Method in interface org.ehcache.Cache

Replaces the entry for a key only if currently mapped to some value and the entry is not expired.

replace(K, V, V) - Method in interface org.ehcache.Cache

Replaces the entry for a key only if currently mapped to the given value and the entry is not expired.

replaceFailure(K, V, StoreAccessException) - Method in interface org.ehcache.spi.resilience.ResilienceStrategy

Called when a Cache.replace(java.lang.Object, java.lang.Object) fails due to an underlying store failure.

replaceFailure(K, V, V, StoreAccessException) - Method in interface org.ehcache.spi.resilience.ResilienceStrategy

Called when a Cache.replace(java.lang.Object, java.lang.Object, java.lang.Object) fails due to an underlying store failure.

replacing(ServiceCreationConfiguration<?>) - Method in class org.ehcache.config.builders.CacheManagerBuilder

Replaces an existing ServiceCreationConfiguration of the same type on the returned builder.

requiresSerialization() - Method in enum org.ehcache.config.ResourceType.Core

requiresSerialization() - Method in interface org.ehcache.config.ResourceType

Indicates whether this ResourceType requires serialization support.

ResilienceStrategy<K,V> - Interface in org.ehcache.spi.resilience

A strategy for providing cache resilience in the face of failure.

ResilienceStrategyProvider - Interface in org.ehcache.spi.resilience

A Service that creates ResilienceStrategy instances.

ResourcePool - Interface in org.ehcache.config

A resource providing capacity to be used by Caches.

ResourcePools - Interface in org.ehcache.config

A collection of resource pools that a Cache has at its disposal to store its mappings.

ResourcePoolsBuilder - Class in org.ehcache.config.builders

The ResourcePoolsBuilder enables building ResourcePools configurations using a fluent style.

ResourceType<T extends ResourcePool> - Interface in org.ehcache.config

A resource type.

ResourceType.Core - Enum in org.ehcache.config

An enumeration of core ResourceTypes in Ehcache.

ResourceUnit - Interface in org.ehcache.config

Represents a unit in which quantity is expressed in a SizedResourcePool.

S

SerializationProvider - Interface in org.ehcache.spi.serialization

A Service providing Serializer instances.

serialize(T) - Method in interface org.ehcache.spi.serialization.Serializer

Transforms the given instance into its serial form.

Serializer<T> - Interface in org.ehcache.spi.serialization

Defines the contract used to transform type instances to and from a serial form.

SerializerException - Exception in org.ehcache.spi.serialization

Thrown by a Serializer when it cannot serialize or deserialize an instance.

SerializerException() - Constructor for exception org.ehcache.spi.serialization.SerializerException

Creates a SerializerException.

SerializerException(String) - Constructor for exception org.ehcache.spi.serialization.SerializerException

Creates a SerializerException with the provided message.

SerializerException(String, Throwable) - Constructor for exception org.ehcache.spi.serialization.SerializerException

Creates a SerializerException with the provided message and cause.

SerializerException(Throwable) - Constructor for exception org.ehcache.spi.serialization.SerializerException

Creates a SerializerException with the provided cause.

Service - Interface in org.ehcache.spi.service

A life-cycled service that supports cache functionality.

ServiceConfiguration<T extends Service> - Interface in org.ehcache.spi.service

A configuration type to be used when interacting with a Service.

ServiceCreationConfiguration<T extends Service> - Interface in org.ehcache.spi.service

A configuration type used when creating a Service.

ServiceDependencies - Annotation Type in org.ehcache.spi.service

Annotation that allows a Service implementation to declare a dependency on other Services.

ServiceProvider<T extends Service> - Interface in org.ehcache.spi.service

A repository of Service instances that can be used to look them up by type.

setAccess(Duration) - Method in class org.ehcache.expiry.Expirations.ExpiryBuilder

Deprecated.

Set TTL since last access

setCreate(Duration) - Method in class org.ehcache.expiry.Expirations.ExpiryBuilder

Deprecated.

Set TTL since creation

setUpdate(Duration) - Method in class org.ehcache.expiry.Expirations.ExpiryBuilder

Deprecated.

Set TTL since last update

SizedResourcePool - Interface in org.ehcache.config

A ResourcePool that is explicitly sized.

start(ServiceProvider<Service>) - Method in interface org.ehcache.spi.service.Service

Start this service using the provided configuration and ServiceProvider.

startForMaintenance(ServiceProvider<? super MaintainableService>, MaintainableService.MaintenanceScope) - Method in interface org.ehcache.spi.service.MaintainableService

Start this service for maintenance, based on its default configuration.

StatefulSerializer<T> - Interface in org.ehcache.spi.serialization

Implementations of this interface can have their state maintained in a StateRepository.

StateHolder<K,V> - Interface in org.ehcache.spi.persistence

A Map like structure that can hold key value mappings.

StateRepository - Interface in org.ehcache.spi.persistence

A repository allowing to preserve state in the context of a Cache.

StateTransitionException - Exception in org.ehcache

Indicates that a state transition failed.

StateTransitionException(Throwable) - Constructor for exception org.ehcache.StateTransitionException

Creates a StateTransitionException with the provided cause.

Status - Enum in org.ehcache

Enumeration of CacheManager and UserManagedCache statuses.

stop() - Method in interface org.ehcache.spi.service.Service

Stops this service.

StoreAccessException - Exception in org.ehcache.spi.resilience

Generic exception used when an internal operation fails on a Cache.

StoreAccessException(Throwable) - Constructor for exception org.ehcache.spi.resilience.StoreAccessException

Creates a new exception wrapping the cause passed in.

StoreAccessException(String, Throwable) - Constructor for exception org.ehcache.spi.resilience.StoreAccessException

Creates a new exception wrapping the cause passed in and with the provided message.

StoreAccessException(String) - Constructor for exception org.ehcache.spi.resilience.StoreAccessException

Creates a new exception with the provided message.

synchronous() - Method in class org.ehcache.config.builders.CacheEventListenerConfigurationBuilder

Sets the returned builder for synchronous event processing.

T

threadPoolAlias - Variable in class org.ehcache.config.builders.WriteBehindConfigurationBuilder

timeToIdleExpiration(Duration) - Static method in class org.ehcache.config.builders.ExpiryPolicyBuilder

Get a time-to-idle (TTI) ExpiryPolicy instance for the given Duration.

timeToIdleExpiration(Duration) - Static method in class org.ehcache.expiry.Expirations

Deprecated.

Use org.ehcache.config.builders.ExpiryPolicyBuilder#timeToIdleExpiration(java.time.Duration) instead

timeToLiveExpiration(Duration) - Static method in class org.ehcache.config.builders.ExpiryPolicyBuilder

Get a time-to-live (TTL) ExpiryPolicy instance for the given Duration.

timeToLiveExpiration(Duration) - Static method in class org.ehcache.expiry.Expirations

Deprecated.

Use org.ehcache.config.builders.ExpiryPolicyBuilder#timeToLiveExpiration(java.time.Duration) instead

toBytes(long) - Method in enum org.ehcache.config.units.MemoryUnit

Converts quantity in this unit to bytes.

toString() - Method in enum org.ehcache.config.ResourceType.Core

toString() - Method in enum org.ehcache.config.units.MemoryUnit

toString() - Method in class org.ehcache.expiry.Duration

Deprecated.

U

unordered() - Method in class org.ehcache.config.builders.CacheEventListenerConfigurationBuilder

Sets the returned builder for unordered event processing.

UnsupportedTypeException - Exception in org.ehcache.spi.serialization

Exception thrown by the SerializationProvider to indicate a Serializer could not be created for a given type.

UnsupportedTypeException(String) - Constructor for exception org.ehcache.spi.serialization.UnsupportedTypeException

Constructs a new exception with the specified detail message.

update(Duration) - Method in class org.ehcache.config.builders.ExpiryPolicyBuilder

Set TTL since last update

updateResourcePools(ResourcePools) - Method in interface org.ehcache.config.CacheRuntimeConfiguration

Updates the ResourcePools used by the Cache.

UserManagedCache<K,V> - Interface in org.ehcache

Represents a Cache that is not managed by a CacheManager.

UserManagedCacheBuilder<K,V,T extends UserManagedCache<K,V>> - Class in org.ehcache.config.builders

The UserManagedCacheBuilder enables building UserManagedCaches using a fluent style.

UserManagedCacheConfiguration<K,V,T extends UserManagedCache<K,V>> - Interface in org.ehcache.config.builders

A configuration type that enables to further specify the type of UserManagedCache in a UserManagedCacheBuilder.

useThreadPool(String) - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder.BatchedWriteBehindConfigurationBuilder

Sets the thread pool to use for write behind on the returned builder.

useThreadPool(String) - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder.UnBatchedWriteBehindConfigurationBuilder

Sets the thread pool to use for write behind on the returned builder.

useThreadPool(String) - Method in class org.ehcache.config.builders.WriteBehindConfigurationBuilder

Sets the thread pool to use for write behind on the returned builder.

using(Service) - Method in class org.ehcache.config.builders.CacheManagerBuilder

Adds a Service instance to the returned builder.

using(ServiceCreationConfiguration<?>) - Method in class org.ehcache.config.builders.CacheManagerBuilder

Adds a ServiceCreationConfiguration to the returned builder.

using(Service) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Adds a Service to be made available to the returned builder.

using(ServiceCreationConfiguration<?>) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Adds a ServiceCreationConfiguration, to trigger a service loading and its configuration, to the returned builder.

V

validateAndMerge(ResourcePools) - Method in interface org.ehcache.config.ResourcePools

Get a copy of this ResourcePools merged with the given ResourcePools, validating that the updates to the contained ResourcePools are legal.

validateUpdate(ResourcePool) - Method in interface org.ehcache.config.ResourcePool

Validates whether or not a new ResourcePool can replace this ResourcePool on a running Cache.

value() - Method in interface org.ehcache.ValueSupplier

Deprecated.

Computes the value behind this instance.

valueOf(String) - Static method in enum org.ehcache.config.ResourceType.Core

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.ehcache.config.units.EntryUnit

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.ehcache.config.units.MemoryUnit

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.ehcache.event.EventFiring

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.ehcache.event.EventOrdering

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.ehcache.event.EventType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.ehcache.spi.service.MaintainableService.MaintenanceScope

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.ehcache.Status

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.ehcache.config.ResourceType.Core

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.ehcache.config.units.EntryUnit

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.ehcache.config.units.MemoryUnit

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.ehcache.event.EventFiring

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.ehcache.event.EventOrdering

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.ehcache.event.EventType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.ehcache.spi.service.MaintainableService.MaintenanceScope

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.ehcache.Status

Returns an array containing the constants of this enum type, in the order they are declared.

ValueSupplier<V> - Interface in org.ehcache

Deprecated.

Now using Supplier for ExpiryPolicy

W

with(CacheManagerConfiguration<N>) - Method in class org.ehcache.config.builders.CacheManagerBuilder

Specializes the returned CacheManager subtype through a specific CacheManagerConfiguration which will optionally add configurations to the returned builder.

with(Builder<? extends CacheManagerConfiguration<N>>) - Method in class org.ehcache.config.builders.CacheManagerBuilder

Convenience method to specialize the returned CacheManager subtype through a CacheManagerConfiguration built using the provided Builder.

with(ResourcePool) - Method in class org.ehcache.config.builders.ResourcePoolsBuilder

Add the ResourcePool of ResourceType in the returned builder.

with(ResourceType<SizedResourcePool>, long, ResourceUnit, boolean) - Method in class org.ehcache.config.builders.ResourcePoolsBuilder

Add the ResourcePool of ResourceType in the returned builder.

with(UserManagedCacheConfiguration<K, V, N>) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Specifies the returned UserManagedCache subtype through a specific UserManagedCacheConfiguration which will optionally add configurations to the returned builder.

withCache(String, CacheConfiguration<K, V>) - Method in class org.ehcache.config.builders.CacheManagerBuilder

Adds a CacheConfiguration linked to the specified alias to the returned builder.

withCache(String, Builder<? extends CacheConfiguration<K, V>>) - Method in class org.ehcache.config.builders.CacheManagerBuilder

Convenience method to add a CacheConfiguration linked to the specified alias to the returned builder by building it from the provided Builder.

withClassLoader(ClassLoader) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Adds a ClassLoader to the returned builder.

withClassLoader(ClassLoader) - Method in class org.ehcache.config.builders.CacheManagerBuilder

Adds a ClassLoader, to use for non Ehcache types, to the returned builder

withClassLoader(ClassLoader) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Adds a ClassLoader, to load non Ehcache types, to the returned builder.

withCopier(Class<C>, Class<? extends Copier<C>>) - Method in class org.ehcache.config.builders.CacheManagerBuilder

Adds a default Copier for the specified type to the returned builder.

withDefaultDiskStoreThreadPool(String) - Method in class org.ehcache.config.builders.CacheManagerBuilder

Adds a OffHeapDiskStoreProviderConfiguration, that specifies the thread pool to use, to the returned builder.

withDefaultEventListenersThreadPool(String) - Method in class org.ehcache.config.builders.CacheManagerBuilder

Adds a CacheEventDispatcherFactoryConfiguration, that specifies the thread pool to use, to the returned builder.

withDefaultSizeOfMaxObjectGraph(long) - Method in class org.ehcache.config.builders.CacheManagerBuilder

Adds a default SizeOfEngine configuration, that limits the max object graph to size, to the returned builder.

withDefaultSizeOfMaxObjectSize(long, MemoryUnit) - Method in class org.ehcache.config.builders.CacheManagerBuilder

Adds a default SizeOfEngine configuration, that limits the max object size, to the returned builder.

withDefaultWriteBehindThreadPool(String) - Method in class org.ehcache.config.builders.CacheManagerBuilder

Adds a WriteBehindProviderConfiguration, that specifies the thread pool to use, to the returned builder.

withDiskStoreThreadPool(String, int) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Adds a ServiceConfiguration for the OffHeapDiskStore.Provider indicating thread pool alias and write concurrency.

withDispatcherConcurrency(int) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Adds StoreEventSourceConfiguration with the specified dispatcher concurrency to the configured builder.

withDispatcherConcurrency(int) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Adds a configuration for dispatcher concurrency in event processing.

withEventDispatcher(CacheEventDispatcher<K, V>) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Adds an CacheEventDispatcher to the returned builder.

withEventExecutors(ExecutorService, ExecutorService) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Adds the default CacheEventDispatcher using the provided ExecutorService to the returned builder.

withEventListeners(CacheEventListenerConfigurationBuilder) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Convenience method to add a CacheEventListenerConfiguration based on the provided CacheEventListenerConfigurationBuilder to the returned builder.

withEventListeners(CacheEventListenerConfiguration...) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Adds one or more CacheEventListenerConfiguration to the returned builder.

withEventListenersThreadPool(String) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Adds a ServiceConfiguration for the CacheEventDispatcherFactory specifying the thread pool alias to use.

withEvictionAdvisor(EvictionAdvisor<? super K, ? super V>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Adds an EvictionAdvisor to the returned builder.

withEvictionAdvisor(EvictionAdvisor<K, V>) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Adds an EvictionAdvisor to the returned builder.

withExpiry(Expiry<? super K, ? super V>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Deprecated.

Use CacheConfigurationBuilder.withExpiry(ExpiryPolicy) instead

withExpiry(ExpiryPolicy<? super K, ? super V>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Adds ExpiryPolicy configuration to the returned builder.

withExpiry(Expiry<? super K, ? super V>) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Deprecated.

Use UserManagedCacheBuilder.withExpiry(ExpiryPolicy) instead

withExpiry(ExpiryPolicy<? super K, ? super V>) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Adds ExpiryPolicy configuration to the returned builder.

withKeyCopier(Copier<K>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Adds by-value semantic using the provided Copier for the key on heap.

withKeyCopier(Class<? extends Copier<K>>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Adds by-value semantic using the provided Copier class for the key on heap.

withKeyCopier(Copier<K>) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Adds a configuration for key Copier to the returned builder.

withKeySerializer(Serializer<K>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Adds a Serializer for cache keys to the configured builder.

withKeySerializer(Class<? extends Serializer<K>>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Adds a Serializer class for cache keys to the configured builder.

withKeySerializer(Serializer<K>) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Adds a configuration for key Serializer to the returned builder.

withKeySerializingCopier() - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Adds by-value semantic using the cache key serializer for the key on heap.

withKeySerializingCopier() - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Adds a configuration for key copying using the key Serializer to the returned builder.

withLoaderWriter(CacheLoaderWriter<K, V>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Adds a CacheLoaderWriter to the configured builder.

withLoaderWriter(Class<CacheLoaderWriter<K, V>>, Object...) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Adds a CacheLoaderWriter configured through a class and optional constructor arguments to the configured builder.

withLoaderWriter(CacheLoaderWriter<K, V>) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Adds a CacheLoaderWriter to the returned builder.

withReplacing(ResourcePool) - Method in class org.ehcache.config.builders.ResourcePoolsBuilder

Add or replace the ResourcePool of ResourceType in the returned builder.

withResilienceStrategy(ResilienceStrategy<K, V>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Adds a ResilienceStrategy to the configured builder.

withResilienceStrategy(Class<? extends ResilienceStrategy>, Object...) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Adds a ResilienceStrategy configured through a class and optional constructor arguments to the configured builder.

withResourcePools(ResourcePools) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Adds the ResourcePools to the returned builder.

withResourcePools(ResourcePoolsBuilder) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Convenience method to add a ResourcePools through a ResourcePoolsBuilder to the returned builder.

withResourcePools(ResourcePools) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Adds a ResourcePools configuration to the returned builder.

withResourcePools(ResourcePoolsBuilder) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Convenience method to add a ResourcePools configuration based on the provided ResourcePoolsBuilder to the returned builder.

withSerializer(Class<C>, Class<? extends Serializer<C>>) - Method in class org.ehcache.config.builders.CacheManagerBuilder

Adds a default Serializer for the specified type to the returned builder.

withSizeOfMaxObjectGraph(long) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Adds or updates the DefaultSizeOfEngineConfiguration with the specified object graph maximum size to the configured builder.

withSizeOfMaxObjectGraph(long) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Adds or updates the DefaultSizeOfEngineProviderConfiguration with the specified object graph maximum size to the configured builder.

withSizeOfMaxObjectSize(long, MemoryUnit) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Adds or updates the DefaultSizeOfEngineConfiguration with the specified maximum mapping size to the configured builder.

withSizeOfMaxObjectSize(long, MemoryUnit) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Adds or updates the DefaultSizeOfEngineProviderConfiguration with the specified maximum mapping size to the configured builder.

withValueCopier(Copier<V>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Adds by-value semantic using the provided Copier for the value on heap.

withValueCopier(Class<? extends Copier<V>>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Adds by-value semantic using the provided Copier class for the value on heap.

withValueCopier(Copier<V>) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Adds a configuration for value Copier to the returned builder.

withValueSerializer(Serializer<V>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Adds a Serializer for cache values to the configured builder.

withValueSerializer(Class<? extends Serializer<V>>) - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Adds a Serializer class for cache values to the configured builder.

withValueSerializer(Serializer<V>) - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Adds a configuration for value Serializer to the returned builder.

withValueSerializingCopier() - Method in class org.ehcache.config.builders.CacheConfigurationBuilder

Adds by-value semantic using the cache value serializer for the value on heap.

withValueSerializingCopier() - Method in class org.ehcache.config.builders.UserManagedCacheBuilder

Adds a configuration for value copying using the key Serializer to the returned builder.

write(K, V) - Method in interface org.ehcache.spi.loaderwriter.CacheLoaderWriter

Writes a single mapping.

writeAll(Iterable<? extends Map.Entry<? extends K, ? extends V>>) - Method in interface org.ehcache.spi.loaderwriter.CacheLoaderWriter

Writes multiple mappings.

WriteBehindConfiguration - Interface in org.ehcache.spi.loaderwriter

ServiceConfiguration for the WriteBehindProvider.

WriteBehindConfiguration.BatchingConfiguration - Interface in org.ehcache.spi.loaderwriter

The batching specific part of WriteBehindConfiguration.

WriteBehindConfigurationBuilder - Class in org.ehcache.config.builders

The WriteBehindConfigurationBuilder enables building WriteBehindConfigurations using a fluent style.

WriteBehindConfigurationBuilder.BatchedWriteBehindConfigurationBuilder - Class in org.ehcache.config.builders

Specialized WriteBehindConfigurationBuilder for WriteBehindConfigurations that supports batching

WriteBehindConfigurationBuilder.UnBatchedWriteBehindConfigurationBuilder - Class in org.ehcache.config.builders

Specialized WriteBehindConfigurationBuilder for WriteBehindConfigurations without batching support

WriteBehindProvider - Interface in org.ehcache.spi.loaderwriter

A Service that provides write-behind functionality.

Z

ZERO - Static variable in class org.ehcache.expiry.Duration

Deprecated.

The zero Duration.

A B C D E F G H I L M N O P Q R S T U V W Z