Index
All Classes and Interfaces|All Packages|Serialized Form
A
- adviseAgainstEviction(K, V) - Method in interface org.ehcache.config.EvictionAdvisor
-
Returns
trueif the given key value pair should not be evicted if possible. - ASYNCHRONOUS - Enum constant in enum class org.ehcache.event.EventFiring
-
Events will fire asynchronously.
- AVAILABLE - Enum constant in enum class org.ehcache.Status
-
Available, indicates it is ready for use.
B
- B - Enum constant in enum class org.ehcache.config.units.MemoryUnit
-
Bytes.
- build() - Method in interface org.ehcache.config.Builder
-
Builds an instance.
- build() - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Builds a new
CacheConfiguration. - build() - Method in class org.ehcache.expiry.Expirations.ExpiryBuilder
-
Deprecated.
- build(R) - Method in interface org.ehcache.spi.service.ServiceConfiguration
-
Construct a new configuration from the given detached representation.
- build(R) - Method in interface org.ehcache.spi.service.ServiceCreationConfiguration
-
Construct a new configuration from the given detached representation.
- builder() - Static method in class org.ehcache.expiry.Expirations
-
Deprecated.
- Builder<T> - Interface in org.ehcache.config
-
A builder of
Ts. - BulkCacheLoadingException - Exception in org.ehcache.spi.loaderwriter
-
Thrown by a
Cachewhen itsCacheLoaderWriterfails while bulk loading values. - 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.
- BulkCacheLoadingException(Map<?, Exception>, Map<?, ?>) - Constructor for exception org.ehcache.spi.loaderwriter.BulkCacheLoadingException
-
Constructs a
BulkCacheLoadingExceptioninstance with the given maps. - BulkCacheWritingException - Exception in org.ehcache.spi.loaderwriter
-
Thrown by a
Cachewhen itsCacheLoaderWriterfails while bulk mutating values. - BulkCacheWritingException(Map<?, Exception>, Set<?>) - Constructor for exception org.ehcache.spi.loaderwriter.BulkCacheWritingException
-
Constructs a
BulkCacheWritingExceptioninstance 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 - Enum constant in enum class org.ehcache.spi.service.MaintainableService.MaintenanceScope
-
Will impact one or many caches
- CACHE_MANAGER - Enum constant in enum class org.ehcache.spi.service.MaintainableService.MaintenanceScope
-
Will impact the cache manager
- 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. - CacheEvent<K,
V> - Interface in org.ehcache.event -
An event resulting from a mutative
Cacheoperation. - CacheEventListener<K,
V> - Interface in org.ehcache.event -
Definition of the contract for implementing listeners to receive
CacheEvents from aCache. - 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
CacheIterationExceptionwith the provided message. - CacheIterationException(String, Throwable) - Constructor for exception org.ehcache.CacheIterationException
-
Creates a
CacheIterationExceptionwith the provided message and cause. - CacheIterationException(Throwable) - Constructor for exception org.ehcache.CacheIterationException
-
Creates a
CacheIterationExceptionwith the provided cause. - CacheLoaderWriter<K,
V> - Interface in org.ehcache.spi.loaderwriter -
A CacheLoaderWriter is used to keep a
Cachein sync with another system. - CacheLoaderWriterConfiguration<R> - Interface in org.ehcache.spi.loaderwriter
- CacheLoaderWriterProvider - Interface in org.ehcache.spi.loaderwriter
-
A
Servicethat createsCacheLoaderWriterinstances. - CacheLoadingException - Exception in org.ehcache.spi.loaderwriter
-
Thrown by a
Cachewhen theCacheLoaderWriterfails 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
CacheLoadingExceptionwith the provided message. - CacheLoadingException(String, Throwable) - Constructor for exception org.ehcache.spi.loaderwriter.CacheLoadingException
-
Constructs a
CacheLoadingExceptionwrapping thecausepassed in and with the provided message. - CacheLoadingException(Throwable) - Constructor for exception org.ehcache.spi.loaderwriter.CacheLoadingException
-
Constructs a
CacheLoadingExceptionwrapping thecausepassed in. - CacheManager - Interface in org.ehcache
- CachePersistenceException - Exception in org.ehcache
-
Thrown when failures occur during operations on
PersistentCacheManager. - CachePersistenceException(String) - Constructor for exception org.ehcache.CachePersistenceException
-
Creates a
CachePersistenceExceptionwith the provided message. - CachePersistenceException(String, Throwable) - Constructor for exception org.ehcache.CachePersistenceException
-
Creates a
CachePersistenceExceptionwith 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
Cachewhen theCacheLoaderWriterfails 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
CacheWritingExceptionwith the provided message. - CacheWritingException(String, Throwable) - Constructor for exception org.ehcache.spi.loaderwriter.CacheWritingException
-
Constructs a
CacheWritingExceptionwrapping thecausepassed in and with the provided message. - CacheWritingException(Throwable) - Constructor for exception org.ehcache.spi.loaderwriter.CacheWritingException
-
Constructs a
CacheWritingExceptionwrapping thecausepassed in. - clear() - Method in interface org.ehcache.Cache
-
Removes all mappings currently present in the
Cache. - 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
CacheManagertoUNINITIALIZED. - close() - Method in interface org.ehcache.UserManagedCache
-
Transitions this
UserManagedCachetoUNINITIALIZED. - compareTo(long, long, ResourceUnit) - Method in interface org.ehcache.config.ResourceUnit
-
Compares
thisSizein this unit tothatSizeinthatUnit. - compareTo(long, long, ResourceUnit) - Method in enum class org.ehcache.config.units.MemoryUnit
-
Compares
thisSizein this unit tothatSizeinthatUnit. - compatibleWith(ServiceConfiguration<?, ?>) - Method in interface org.ehcache.spi.service.ServiceConfiguration
-
Returns true if this configuration can co-exist with
otherin the same cache configuration. - compatibleWith(ServiceCreationConfiguration<?, ?>) - Method in interface org.ehcache.spi.service.ServiceCreationConfiguration
-
Returns true if this configuration can co-exist with
otherin the same manager configuration. - Configuration - Interface in org.ehcache.config
-
Represents the configuration for a
CacheManager. - 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 class org.ehcache.config.units.MemoryUnit
-
Converts
quantityinunitinto 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
- createCache(String, Builder<? extends CacheConfiguration<K, V>>) - Method in interface org.ehcache.CacheManager
-
Creates a
Cachein thisCacheManageraccording to the specifiedCacheConfigurationprovided through aBuilder. - createCache(String, CacheConfiguration<K, V>) - Method in interface org.ehcache.CacheManager
- createCacheLoaderWriter(String, CacheConfiguration<K, V>) - Method in interface org.ehcache.spi.loaderwriter.CacheLoaderWriterProvider
-
Creates a
CacheLoaderWriterfor use with theCacheof the given alias and configuration. - CREATED - Enum constant in enum class org.ehcache.event.EventType
-
Represents a new
cache entrybeing installed for a given key - createKeyCopier(Class<T>, Serializer<T>, ServiceConfiguration<?, ?>...) - Method in interface org.ehcache.spi.copy.CopyProvider
-
Creates a key
Copierwith the given parameters. - createKeySerializer(Class<T>, ClassLoader, ServiceConfiguration<?, ?>...) - Method in interface org.ehcache.spi.serialization.SerializationProvider
-
Creates a key
Serializerwith the given parameters. - createResilienceStrategy(String, CacheConfiguration<K, V>, RecoveryStore<K>) - Method in interface org.ehcache.spi.resilience.ResilienceStrategyProvider
-
Creates a
ResilienceStrategyfor theCachewith the given alias and configuration using the givenRecoveryStore. - createResilienceStrategy(String, CacheConfiguration<K, V>, RecoveryStore<K>, CacheLoaderWriter<? super K, V>) - Method in interface org.ehcache.spi.resilience.ResilienceStrategyProvider
-
Creates a
ResilienceStrategyfor theCachewith the given alias and configuration using the givenRecoveryStoreandCacheLoaderWriter - createValueCopier(Class<T>, Serializer<T>, ServiceConfiguration<?, ?>...) - Method in interface org.ehcache.spi.copy.CopyProvider
-
Creates a value
Copierwith the given parameters. - createValueSerializer(Class<T>, ClassLoader, ServiceConfiguration<?, ?>...) - Method in interface org.ehcache.spi.serialization.SerializationProvider
-
Creates a value
Serializerwith the given parameters. - createWriteBehindLoaderWriter(Consumer<K>, CacheLoaderWriter<K, V>, WriteBehindConfiguration<?>) - Method in interface org.ehcache.spi.loaderwriter.WriteBehindProvider
-
Creates write-behind decorated
CacheLoaderWriteraccording to the given configuration.
D
- 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
CacheEventListenerinstance. - derive() - Method in interface org.ehcache.config.CacheConfiguration
-
Create a builder seeded with this configuration.
- derive() - Method in interface org.ehcache.config.Configuration
-
Creates a builder seeded with this configuration.
- derive() - Method in interface org.ehcache.spi.service.ServiceConfiguration
-
Derive a detached representation from this configuration
- derive() - Method in interface org.ehcache.spi.service.ServiceCreationConfiguration
-
Derive a detached representation from this configuration
- 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
Cacheinstance managed by thisCacheManager. - DISK - Enum constant in enum class org.ehcache.config.ResourceType.Core
-
Disk: persistable,
serializationrequired. - Duration - Class in org.ehcache.expiry
-
Deprecated.Replaced with
Duration - Duration(long, TimeUnit) - Constructor for class org.ehcache.expiry.Duration
-
Deprecated.Instantiates a new
Durationof the given length andTimeUnit.
E
- ENTRIES - Enum constant in enum class org.ehcache.config.units.EntryUnit
-
The only possible value of
EntryUnit - entrySet() - Method in interface org.ehcache.spi.persistence.StateHolder
-
Retrieves all the entries in the
StateHolderas aSetofMap.Entryinstances. - EntryUnit - Enum Class in org.ehcache.config.units
-
A
ResourceUnitthat designates a count by entries. - equals(Object) - Method in class org.ehcache.config.ResourceType.SharedResource
- 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
representthe same instance. - EventFiring - Enum Class in org.ehcache.event
-
The supported event firing modes.
- EventOrdering - Enum Class in org.ehcache.event
-
The supported event ordering modes.
- EventType - Enum Class in org.ehcache.event
-
The different event types.
- EVICTED - Enum constant in enum class org.ehcache.event.EventType
-
Represents a
cache entrybeing evicted - Eviction - Class in org.ehcache.config
-
Utility class for getting predefined
EvictionAdvisorinstances. - 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.
- EXPIRED - Enum constant in enum class org.ehcache.event.EventType
-
Represents a
cache entryexpiring - Expiry<K,
V> - Interface in org.ehcache.expiry -
Deprecated.Replaced with
ExpiryPolicythat builds on thejava.timetypes. - ExpiryPolicy<K,
V> - Interface in org.ehcache.expiry -
A policy object that governs expiration for mappings in a
Cache.
F
- FluentCacheConfigurationBuilder<K,
V, B extends FluentCacheConfigurationBuilder<K, V, ?>> - Interface in org.ehcache.config -
A fluent builder of
CacheConfigurationinstances. - FluentConfigurationBuilder<B extends FluentConfigurationBuilder<?>> - Interface in org.ehcache.config
-
A fluent builder of
Configurationinstances.
G
- GB - Enum constant in enum class org.ehcache.config.units.MemoryUnit
-
Gigabytes.
- 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
nullif batching is not enabled. - getBatchSize() - Method in interface org.ehcache.spi.loaderwriter.WriteBehindConfiguration.BatchingConfiguration
-
The recommended size of a batch of operations.
- getCache(String) - Method in interface org.ehcache.config.FluentConfigurationBuilder
-
Return the cache configuration for the given alias.
- getCache(String, Class<K>, Class<V>) - Method in interface org.ehcache.CacheManager
-
Retrieves the
Cacheassociated with the given alias, if one is known. - getCacheConfigurations() - Method in interface org.ehcache.config.Configuration
-
Mapping of aliases to
CacheConfigurations, used to configure theCaches managed by theCacheManager. - getClassLoader() - Method in interface org.ehcache.config.CacheConfiguration
-
The
ClassLoaderfor theCache. - getClassLoader() - Method in interface org.ehcache.config.Configuration
-
The
ClassLoaderfor theCacheManager. - getClassLoader() - Method in interface org.ehcache.config.FluentConfigurationBuilder
-
Return the configured classloader instance.
- 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
EvictionAdvisorpredicate function. - getExpiry() - Method in interface org.ehcache.config.CacheConfiguration
-
Deprecated.
- getExpiryForAccess(K, Supplier<? extends V>) - Method in interface org.ehcache.expiry.ExpiryPolicy
- getExpiryForAccess(K, ValueSupplier<? extends V>) - Method in interface org.ehcache.expiry.Expiry
-
Deprecated.
- 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, Supplier<? extends V>, V) - Method in interface org.ehcache.expiry.ExpiryPolicy
- getExpiryForUpdate(K, ValueSupplier<? extends V>, V) - Method in interface org.ehcache.expiry.Expiry
-
Deprecated.
- getExpiryPolicy() - Method in interface org.ehcache.config.CacheConfiguration
-
The
ExpiryPolicyrules for theCache. - 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
Durationrepresents. - 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, ResourcePool) - Method in interface org.ehcache.spi.persistence.PersistableResourceService
-
Returns a
PersistableResourceService.PersistenceSpaceIdentifierfor 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
ResourcePoolbased on its type. - getPreConfiguredCacheLoaderWriterConfig(String) - Method in interface org.ehcache.spi.loaderwriter.CacheLoaderWriterProvider
-
Returns preconfigured
CacheLoaderWriterConfigurationfor the given alias - getResourcePoolClass() - Method in enum class org.ehcache.config.ResourceType.Core
- getResourcePoolClass() - Method in interface org.ehcache.config.ResourceType
-
Gets the
ResourcePooltype associated with thisResourceType. - getResourcePoolClass() - Method in class org.ehcache.config.ResourceType.SharedResource
- getResourcePools() - Method in interface org.ehcache.config.CacheConfiguration
-
The
ResourcePoolsfor theCache. - getResourceType() - Method in class org.ehcache.config.ResourceType.SharedResource
- getResourceTypeSet() - Method in interface org.ehcache.config.ResourcePools
-
Gets the set of
ResourceTypes present in theResourcePools. - getRuntimeConfiguration() - Method in interface org.ehcache.Cache
-
Exposes the
CacheRuntimeConfigurationassociated with this Cache instance. - getRuntimeConfiguration() - Method in interface org.ehcache.CacheManager
-
Returns the current
Configurationused by thisCacheManager. - getService(Class<C>) - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Return the unique service configuration of the given type.
- getService(Class<C>) - Method in interface org.ehcache.config.FluentConfigurationBuilder
-
Return the unique service creation configuration of the given type.
- getService(Class<U>) - Method in interface org.ehcache.spi.service.ServiceProvider
-
Looks up the
Serviceof the givenserviceType. - getServiceConfigurations() - Method in interface org.ehcache.config.CacheConfiguration
-
The service configurations defined for the
Cache. - getServiceCreationConfigurations() - Method in interface org.ehcache.config.Configuration
- getServices(Class<C>) - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Returns all the service configurations of the given type.
- getServices(Class<C>) - Method in interface org.ehcache.config.FluentConfigurationBuilder
-
Return the service creation configurations of the given type.
- getServicesOfType(Class<U>) - Method in interface org.ehcache.spi.service.ServiceProvider
-
Looks up all
Serviceinstances that are subtypes of the givenserviceTypesupplied. - getServiceType() - Method in interface org.ehcache.spi.loaderwriter.CacheLoaderWriterConfiguration
-
Indicates which service this configuration works with.
- 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.
- getSharedPersistenceSpaceIdentifier(ResourcePool) - Method in interface org.ehcache.spi.persistence.PersistableResourceService
-
Returns a
PersistableResourceService.PersistenceSpaceIdentifierfor a space shared across all caches. - getSharedResourcePools() - Method in interface org.ehcache.config.Configuration
-
Returns a mapping of
ResourceTypes toResourcePools, for all configured shared resource pools - 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 repositoryin the context of the givenidentifier. - getStatus() - Method in interface org.ehcache.CacheManager
-
Returns the current
Statusof thisCacheManager. - getStatus() - Method in interface org.ehcache.UserManagedCache
-
Returns the current
Statusof thisUserManagedCache. - 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 class org.ehcache.config.ResourceType.Core
- getTierHeight() - Method in interface org.ehcache.config.ResourceType
-
Indicates the level this resource sits in the tiering system.
- getTierHeight() - Method in class org.ehcache.config.ResourceType.SharedResource
- getTimeUnit() - Method in class org.ehcache.expiry.Duration
-
Deprecated.Gets the
TimeUnitof thisDuration. - getType() - Method in interface org.ehcache.config.ResourcePool
-
Get the
ResourceType. - getType() - Method in interface org.ehcache.event.CacheEvent
-
Gets the
EventTypeof 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
trueif this service handles the given resource type. - hashCode() - Method in class org.ehcache.config.ResourceType.SharedResource
- hashCode() - Method in class org.ehcache.expiry.Duration
-
Deprecated.
- HEAP - Enum constant in enum class org.ehcache.config.ResourceType.Core
-
Heap: not persistable,
serializationnot required.
I
- INFINITE - Static variable in class org.ehcache.expiry.Duration
-
Deprecated.The infinite
Duration. - INFINITE - Static variable in interface org.ehcache.expiry.ExpiryPolicy
-
A
durationthat represents an infinite time. - init() - Method in interface org.ehcache.CacheManager
-
Transitions this
CacheManagertoAVAILABLE. - init() - Method in interface org.ehcache.UserManagedCache
-
Transitions this
UserManagedCachetoAVAILABLE. - init(StateRepository) - Method in interface org.ehcache.spi.serialization.StatefulSerializer
-
This method is used to inject a
StateRepositoryto the serializer by the authoritative tier of a cache during the cache initialization. - 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.INFINITEor an infiniteDuration. - isLoaderJsrProvided(String) - Method in interface org.ehcache.spi.loaderwriter.CacheLoaderWriterProvider
-
Checks whether
CacheLoaderWriterwas provided using jsr api - isOrdered() - Method in enum class org.ehcache.event.EventOrdering
-
Indicates if the mode obeys ordering.
- isPersistable() - Method in enum class org.ehcache.config.ResourceType.Core
- isPersistable() - Method in interface org.ehcache.config.ResourceType
-
Indicates whether this
ResourceTypesupports persistence. - isPersistable() - Method in class org.ehcache.config.ResourceType.SharedResource
- isPersistent() - Method in interface org.ehcache.config.ResourcePool
-
Indicates whether the underlying resource is persistent.
- iterator() - Method in interface org.ehcache.Cache
-
Returns an iterator over the cache entries.
- iteratorFailure(StoreAccessException) - Method in interface org.ehcache.spi.resilience.ResilienceStrategy
-
Called when a cache iterator advancement fails due to an underlying store failure.
K
- KB - Enum constant in enum class org.ehcache.config.units.MemoryUnit
-
Kilobytes.
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
-
Serviceinterface that indicates that implementing services participate inMAINTENANCEmode. - MaintainableService.MaintenanceScope - Enum Class in org.ehcache.spi.service
-
Defines Maintenance scope
- MAINTENANCE - Enum constant in enum class org.ehcache.Status
-
Maintenance, indicates exclusive access to allow for restricted operations.
- MB - Enum constant in enum class org.ehcache.config.units.MemoryUnit
-
Megabytes.
- MemoryUnit - Enum Class in org.ehcache.config.units
-
A
ResourceUnitthat designates memory quantity.
N
- NO_EXPIRY - Static variable in interface org.ehcache.expiry.ExpiryPolicy
-
An
ExpiryPolicythat represents a no expiration policy - noAdvice() - Static method in class org.ehcache.config.Eviction
-
Returns an
EvictionAdvisorwhere no mappings are advised against eviction. - 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(Iterable<? extends K>) - Method in interface org.ehcache.spi.resilience.RecoveryStore
-
Obliterate a list of keys.
- obliterate(K) - Method in interface org.ehcache.spi.resilience.RecoveryStore
-
Obliterate a given key.
- of(long, TimeUnit) - Static method in class org.ehcache.expiry.Duration
-
Deprecated.Convenience method to create a
Durationwith the specified values. - OFFHEAP - Enum constant in enum class org.ehcache.config.ResourceType.Core
-
OffHeap: not persistable,
serializationrequired. - onEvent(CacheEvent<? extends K, ? extends V>) - Method in interface org.ehcache.event.CacheEventListener
-
Invoked on
CacheEventfiring. - OptionalServiceDependencies - Annotation Interface in org.ehcache.spi.service
-
Annotation that allows a
Serviceimplementation to declare an optional dependency on otherServices. - ORDERED - Enum constant in enum class org.ehcache.event.EventOrdering
-
Ordering of events is guaranteed on a per-key basis.
- org.ehcache - package org.ehcache
-
Main Ehcache API, including
cache managersandcaches. - org.ehcache.config - package org.ehcache.config
-
CacheManager configuration,Cache configurationand other configuration classes. - org.ehcache.config.units - package org.ehcache.config.units
-
ResourceUnitimplementations - org.ehcache.event - package org.ehcache.event
-
CacheEventand related types. - org.ehcache.expiry - package org.ehcache.expiry
- org.ehcache.spi.copy - package org.ehcache.spi.copy
-
CopierSPI in Ehcache. - org.ehcache.spi.loaderwriter - package org.ehcache.spi.loaderwriter
-
CacheLoaderWriterSPI for aCache. - org.ehcache.spi.persistence - package org.ehcache.spi.persistence
-
PersistableResourceServiceand other persistence related SPI. - org.ehcache.spi.resilience - package org.ehcache.spi.resilience
-
ResilienceStrategyAPI of aCache. - org.ehcache.spi.serialization - package org.ehcache.spi.serialization
-
SerializerSPI in Ehcache. - org.ehcache.spi.service - package org.ehcache.spi.service
-
ServiceSPI related in Ehcache.
P
- PB - Enum constant in enum class org.ehcache.config.units.MemoryUnit
-
Petabytes.
- PersistableResourceService - Interface in org.ehcache.spi.persistence
- PersistableResourceService.PersistenceSpaceIdentifier<T extends PersistableResourceService> - Interface in org.ehcache.spi.persistence
-
An identifier for an existing persistable resource.
- PersistentCacheManager - Interface in org.ehcache
-
A
CacheManagerthat knows how to lifecycle caches that can outlive the JVM. - PersistentUserManagedCache<K,
V> - Interface in org.ehcache -
A
UserManagedCachethat holds data that can outlive the JVM. - PluralService - Annotation Interface in org.ehcache.spi.service
-
Indicates that a
Servicesubtype is permitted to have more than one concrete implementation registered with aServiceProvider. - 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 returnsnull, 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.
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
CacheEventListeneron the cache. - registerCacheEventListener(CacheEventListener<? super K, ? super V>, EventOrdering, EventFiring, EventType, EventType...) - Method in interface org.ehcache.config.CacheRuntimeConfiguration
-
Registers a
CacheEventListeneron the cache. - releaseCacheLoaderWriter(String, CacheLoaderWriter<?, ?>) - Method in interface org.ehcache.spi.loaderwriter.CacheLoaderWriterProvider
-
Releases a
CacheLoaderWriterwhen the associatedCacheis finished with it. - releaseCopier(Copier<?>) - Method in interface org.ehcache.spi.copy.CopyProvider
-
Releases the provided
Copierinstance. - 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
Serializerinstance. - releaseWriteBehindLoaderWriter(CacheLoaderWriter<?, ?>) - Method in interface org.ehcache.spi.loaderwriter.WriteBehindProvider
-
Releases a write-behind decorator when the associated
Cacheis 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(K, V) - Method in interface org.ehcache.spi.persistence.StateHolder
-
Removes the entry for a key only if currently mapped to a given value.
- 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
Cacheassociated with the alias provided, if one is known. - REMOVED - Enum constant in enum class org.ehcache.event.EventType
-
Represents a
cache entrybeing removed - 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. - requiresSerialization() - Method in enum class org.ehcache.config.ResourceType.Core
- requiresSerialization() - Method in interface org.ehcache.config.ResourceType
-
Indicates whether this
ResourceTyperequiresserializationsupport. - requiresSerialization() - Method in class org.ehcache.config.ResourceType.SharedResource
- 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
Servicethat createsResilienceStrategyinstances. - 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 poolsthat aCachehas at its disposal to store its mappings. - ResourceType<T extends ResourcePool> - Interface in org.ehcache.config
-
A resource type.
- ResourceType.Core - Enum Class in org.ehcache.config
-
An enumeration of core
ResourceTypes in Ehcache. - ResourceType.SharedResource<T extends ResourceType<?>> - Class in org.ehcache.config
- 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
ServiceprovidingSerializerinstances. - 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
Serializerwhen 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
SerializerExceptionwith the provided message. - SerializerException(String, Throwable) - Constructor for exception org.ehcache.spi.serialization.SerializerException
-
Creates a
SerializerExceptionwith the provided message and cause. - SerializerException(Throwable) - Constructor for exception org.ehcache.spi.serialization.SerializerException
-
Creates a
SerializerExceptionwith the provided cause. - Service - Interface in org.ehcache.spi.service
-
A life-cycled service that supports cache functionality.
- ServiceConfiguration<T extends Service,
R> - Interface in org.ehcache.spi.service -
A configuration type to be used when interacting with a
Service. - ServiceCreationConfiguration<T extends Service,
R> - Interface in org.ehcache.spi.service -
A configuration type used when creating a
Service. - ServiceDependencies - Annotation Interface in org.ehcache.spi.service
-
Annotation that allows a
Serviceimplementation to declare a dependency on otherServices. - ServiceProvider<T extends Service> - Interface in org.ehcache.spi.service
-
A repository of
Serviceinstances 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
- SharedResource(T) - Constructor for class org.ehcache.config.ResourceType.SharedResource
- SizedResourcePool - Interface in org.ehcache.config
-
A
ResourcePoolthat 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
Maplike 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
StateTransitionExceptionwith the provided cause. - Status - Enum Class in org.ehcache
-
Enumeration of
CacheManagerandUserManagedCachestatuses. - 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(String) - Constructor for exception org.ehcache.spi.resilience.StoreAccessException
-
Creates a new exception with the provided message.
- StoreAccessException(String, Throwable) - Constructor for exception org.ehcache.spi.resilience.StoreAccessException
-
Creates a new exception wrapping the
causepassed in and with the provided message. - StoreAccessException(Throwable) - Constructor for exception org.ehcache.spi.resilience.StoreAccessException
-
Creates a new exception wrapping the
causepassed in. - SYNCHRONOUS - Enum constant in enum class org.ehcache.event.EventFiring
-
Events will fire synchronously.
T
- TB - Enum constant in enum class org.ehcache.config.units.MemoryUnit
-
Terabytes.
- 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.expiry.Expirations
-
Deprecated.Use
org.ehcache.config.builders.ExpiryPolicyBuilder#timeToLiveExpiration(java.time.Duration)instead - toBytes(long) - Method in enum class org.ehcache.config.units.MemoryUnit
-
Converts
quantityin this unit to bytes. - toString() - Method in enum class org.ehcache.config.ResourceType.Core
- toString() - Method in class org.ehcache.config.ResourceType.SharedResource
- toString() - Method in enum class org.ehcache.config.units.MemoryUnit
- toString() - Method in class org.ehcache.expiry.Duration
-
Deprecated.
U
- UNINITIALIZED - Enum constant in enum class org.ehcache.Status
-
Uninitialized, indicates it is not ready for use.
- UNORDERED - Enum constant in enum class org.ehcache.event.EventOrdering
-
Events may be observed out of order.
- UnsupportedTypeException - Exception in org.ehcache.spi.serialization
-
Exception thrown by the
SerializationProviderto indicate aSerializercould 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.
- updateCache(String, UnaryOperator<FluentCacheConfigurationBuilder<?, ?, ?>>) - Method in interface org.ehcache.config.FluentConfigurationBuilder
-
Updates the configuration of the identified cache.
- updateCaches(UnaryOperator<FluentCacheConfigurationBuilder<?, ?, ?>>) - Method in interface org.ehcache.config.FluentConfigurationBuilder
-
Updates the configuration of the all caches.
- UPDATED - Enum constant in enum class org.ehcache.event.EventType
-
Represents an existing
cache entrybeing updated for a given key - updateResourcePools(UnaryOperator<ResourcePools>) - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Updates the configured resource pools.
- updateResourcePools(ResourcePools) - Method in interface org.ehcache.config.CacheRuntimeConfiguration
-
Updates the
ResourcePoolsused by theCache. - updateServices(Class<C>, UnaryOperator<R>) - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Updates all service configurations of the given type.
- updateServices(Class<C>, UnaryOperator<R>) - Method in interface org.ehcache.config.FluentConfigurationBuilder
-
Updates all service creation configurations of the given type.
- updateSharedResources(UnaryOperator<ResourcePools>) - Method in interface org.ehcache.config.FluentConfigurationBuilder
-
Updates the configured shared resource pools.
- UserManagedCache<K,
V> - Interface in org.ehcache -
Represents a
Cachethat is not managed by aCacheManager.
V
- validateAndMerge(ResourcePools) - Method in interface org.ehcache.config.ResourcePools
-
Get a copy of this
ResourcePoolsmerged with the givenResourcePools, validating that the updates to the containedResourcePools are legal. - validateUpdate(ResourcePool) - Method in interface org.ehcache.config.ResourcePool
- value() - Element in annotation interface org.ehcache.spi.service.OptionalServiceDependencies
-
Array of
Servicedependency classes - value() - Element in annotation interface org.ehcache.spi.service.ServiceDependencies
-
Array of
Servicedependency classes - value() - Method in interface org.ehcache.ValueSupplier
-
Deprecated.Computes the value behind this instance.
- valueOf(String) - Static method in enum class org.ehcache.config.ResourceType.Core
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.ehcache.config.units.EntryUnit
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.ehcache.config.units.MemoryUnit
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.ehcache.event.EventFiring
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.ehcache.event.EventOrdering
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.ehcache.event.EventType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.ehcache.spi.service.MaintainableService.MaintenanceScope
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.ehcache.Status
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.ehcache.config.ResourceType.Core
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.ehcache.config.units.EntryUnit
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.ehcache.config.units.MemoryUnit
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.ehcache.event.EventFiring
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.ehcache.event.EventOrdering
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.ehcache.event.EventType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.ehcache.spi.service.MaintainableService.MaintenanceScope
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.ehcache.Status
-
Returns an array containing the constants of this enum class, in the order they are declared.
- ValueSupplier<V> - Interface in org.ehcache
-
Deprecated.Now using
SupplierforExpiryPolicy
W
- withCache(String, Builder<? extends CacheConfiguration<?, ?>>) - Method in interface org.ehcache.config.FluentConfigurationBuilder
-
Adds the cache configuration built by a builder to this configuration.
- withCache(String, CacheConfiguration<?, ?>) - Method in interface org.ehcache.config.FluentConfigurationBuilder
-
Adds the given cache to this configuration.
- withClassLoader(ClassLoader) - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Sets the
ClassLoaderin the returned builder. - withClassLoader(ClassLoader) - Method in interface org.ehcache.config.FluentConfigurationBuilder
-
Sets the given class loader as the cache manager classloader
- withDefaultClassLoader() - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Removes any previously installed custom class loader
- withDefaultClassLoader() - Method in interface org.ehcache.config.FluentConfigurationBuilder
-
Removes any provided class loader returning to default behavior
- withDefaultKeySerializer() - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Removes any explicitly configured
Serializerfor cache keys. - withDefaultResilienceStrategy() - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Restores configuration of the implementations default resilience strategy.
- withDefaultValueSerializer() - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Removes any explicitly configured
Serializerfor cache values. - withEvictionAdvisor(EvictionAdvisor<? super K, ? super V>) - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Sets the
EvictionAdvisorin the returned builder. - withExpiry(ExpiryPolicy<? super K, ? super V>) - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Sets the
ExpiryPolicyconfiguration in the returned builder. - withKeyCopier(Class<? extends Copier<K>>) - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Adds by-value semantics using the provided
Copierclass for the key on heap. - withKeyCopier(Copier<K>) - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Adds by-value semantics using the provided
Copierfor the key on heap. - withKeySerializer(Class<? extends Serializer<K>>) - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Sets the
Serializerclass for cache keys in the returned builder. - withKeySerializer(Serializer<K>) - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Sets the
Serializerfor cache keys in the returned builder. - withKeySerializingCopier() - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Adds by-value semantics using the cache key serializer for the key on heap.
- withLoaderWriter(Class<CacheLoaderWriter<K, V>>, Object...) - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Sets the
CacheLoaderWriter(using a class and constructor arguments) in the returned builder. - withLoaderWriter(CacheLoaderWriter<K, V>) - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Sets the
CacheLoaderWriterin the returned builder. - withoutCache(String) - Method in interface org.ehcache.config.FluentConfigurationBuilder
-
Removes the given cache from this configuration.
- withoutKeyCopier() - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Removes any configured
Copierfor keys on heap. - withoutLoaderWriter() - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Removes any configured loader-writer.
- withoutServices(Class<? extends ServiceConfiguration<?, ?>>) - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Removes all service configurations of the given type from this configuration.
- withoutServices(Class<? extends ServiceCreationConfiguration<?, ?>>) - Method in interface org.ehcache.config.FluentConfigurationBuilder
-
Removes all service creation configurations of the given type from this configuration.
- withoutServices(Class<C>, Predicate<? super C>) - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Removes all service configurations of the given type that pass the predicate.
- withoutServices(Class<C>, Predicate<? super C>) - Method in interface org.ehcache.config.FluentConfigurationBuilder
-
Removes all service creation configurations of the given type that pass the predicate.
- withoutValueCopier() - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Removes any configured
Copierfor values on heap. - withResilienceStrategy(Class<? extends ResilienceStrategy>, Object...) - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Sets the
ResilienceStrategy(using a class and constructor arguments) in the returned builder. - withResilienceStrategy(ResilienceStrategy<K, V>) - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Sets the
ResilienceStrategyin the returned builder. - withResourcePools(Builder<? extends ResourcePools>) - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Convenience method to set the
ResourcePoolsthrough aBuilder. - withResourcePools(ResourcePools) - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Sets the
ResourcePoolsin the returned builder. - withService(Builder<? extends ServiceConfiguration<?, ?>>) - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Adds a service configuration built by the given builder to this configuration.
- withService(Builder<? extends ServiceCreationConfiguration<?, ?>>) - Method in interface org.ehcache.config.FluentConfigurationBuilder
-
Adds a service creation configuration built by the given builder to this configuration.
- withService(ServiceConfiguration<?, ?>) - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Adds a service configuration to this configuration.
- withService(ServiceCreationConfiguration<?, ?>) - Method in interface org.ehcache.config.FluentConfigurationBuilder
-
Adds a service creation configuration to this configuration.
- withSharedResources(Builder<? extends ResourcePools>) - Method in interface org.ehcache.config.FluentConfigurationBuilder
-
Convenience method to set the shared
ResourcePoolsthrough aBuilder. - withSharedResources(ResourcePools) - Method in interface org.ehcache.config.FluentConfigurationBuilder
-
Sets the shared
ResourcePoolsin the returned builder. - withValueCopier(Class<? extends Copier<V>>) - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Adds by-value semantics using the provided
Copierclass for the value on heap. - withValueCopier(Copier<V>) - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Adds by-value semantics using the provided
Copierfor the value on heap. - withValueSerializer(Class<? extends Serializer<V>>) - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Sets the
Serializerclass for cache values in the returned builder. - withValueSerializer(Serializer<V>) - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Sets the
Serializerfor cache values in the returned builder. - withValueSerializingCopier() - Method in interface org.ehcache.config.FluentCacheConfigurationBuilder
-
Adds by-value semantics using the cache value serializer for the value on heap.
- 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<R> - Interface in org.ehcache.spi.loaderwriter
-
ServiceConfigurationfor theWriteBehindProvider. - WriteBehindConfiguration.BatchingConfiguration - Interface in org.ehcache.spi.loaderwriter
-
The batching specific part of
WriteBehindConfiguration. - WriteBehindProvider - Interface in org.ehcache.spi.loaderwriter
-
A
Servicethat provides write-behind functionality.
Z
A B C D E F G H I K L M N O P R S T U V W ZAll Classes and Interfaces|All Packages|Serialized Form
org.ehcache.config.builders.ExpiryPolicyBuilder#expiry()instead