io.micronaut.cache.ehcache

Class EhcacheSyncCache

java.lang.Object

io.micronaut.cache.ehcache.EhcacheSyncCache

All Implemented Interfaces:

Cache<org.ehcache.Cache>, SyncCache<org.ehcache.Cache>

public class EhcacheSyncCache
extends java.lang.Object
implements SyncCache<org.ehcache.Cache>

A SyncCache implementation based on Ehcache.

Since:

1.0.0

Author:

Álvaro Sánchez-Mariscal

Constructor Summary

Constructors

Constructor and Description
EhcacheSyncCache(io.micronaut.core.convert.ConversionService<?> conversionService, EhcacheConfiguration configuration, org.ehcache.Cache nativeCache, java.util.concurrent.ExecutorService executorService, org.ehcache.core.spi.service.StatisticsService statisticsService)

Method Summary

Modifier and Type	Method and Description
<T> java.util.Optional<T>	get(java.lang.Object key, io.micronaut.core.type.Argument<T> requiredType) Resolve the given value for the given key.
<T> T	get(java.lang.Object key, io.micronaut.core.type.Argument<T> requiredType, java.util.function.Supplier<T> supplier) Resolve the given value for the given key.
org.reactivestreams.Publisher<CacheInfo>	getCacheInfo()
java.util.concurrent.ExecutorService	getExecutorService()
java.lang.String	getName()
org.ehcache.Cache	getNativeCache()
void	invalidate(java.lang.Object key) Invalidate the value for the given key.
void	invalidateAll() Invalidate all cached values within this cache.
void	put(java.lang.Object key, java.lang.Object value) Cache the specified value using the specified key.
<T> java.util.Optional<T>	putIfAbsent(java.lang.Object key, T value) Cache the specified value using the specified key if it is not already present.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.cache.SyncCache

async, get, get, putIfAbsent

Constructor Detail

EhcacheSyncCache

public EhcacheSyncCache(io.micronaut.core.convert.ConversionService<?> conversionService,
                        EhcacheConfiguration configuration,
                        org.ehcache.Cache nativeCache,
                        @Named(value="io")
                        java.util.concurrent.ExecutorService executorService,
                        org.ehcache.core.spi.service.StatisticsService statisticsService)

Parameters:

conversionService - the conversion service

configuration - the configuration

nativeCache - the native cache

executorService - the executor service to offload synchronous operations

statisticsService - th Ehcache statistics service

Method Detail

getExecutorService

public java.util.concurrent.ExecutorService getExecutorService()

Specified by:

getExecutorService in interface SyncCache<org.ehcache.Cache>

Returns:

The executor service used to construct the default asynchronous cache.

get

@Nonnull
public <T> java.util.Optional<T> get(@Nonnull
                                              java.lang.Object key,
                                              @Nonnull
                                              io.micronaut.core.type.Argument<T> requiredType)

Description copied from interface: SyncCache

Resolve the given value for the given key.

Specified by:

get in interface SyncCache<org.ehcache.Cache>

Type Parameters:

T - The concrete type

Parameters:

key - The cache key

requiredType - The required type

Returns:

An optional containing the value if it exists and is able to be converted to the specified type

get

public <T> T get(@Nonnull
                 java.lang.Object key,
                 @Nonnull
                 io.micronaut.core.type.Argument<T> requiredType,
                 @Nonnull
                 java.util.function.Supplier<T> supplier)

Description copied from interface: SyncCache

Resolve the given value for the given key. If the value is not found the specified Supplier will be invoked and the return value cached.

Specified by:

get in interface SyncCache<org.ehcache.Cache>

Type Parameters:

T - The concrete type

Parameters:

key - The cache key

requiredType - The required type

supplier - The supplier that should be invoked if the value is not found

Returns:

An optional containing the value if it exists and is able to be converted to the specified type

putIfAbsent

@Nonnull
public <T> java.util.Optional<T> putIfAbsent(@Nonnull
                                                      java.lang.Object key,
                                                      @Nonnull
                                                      T value)

Description copied from interface: SyncCache

Cache the specified value using the specified key if it is not already present.

Specified by:

putIfAbsent in interface SyncCache<org.ehcache.Cache>

Type Parameters:

T - The concrete type

Parameters:

key - the key with which the specified value is to be associated

value - the value to be associated with the specified key

Returns:

An optional of the existing value or Optional.empty() if the specified value parameter was cached

put

public void put(@Nonnull
                java.lang.Object key,
                @Nonnull
                java.lang.Object value)

Description copied from interface: SyncCache

Cache the specified value using the specified key.

Specified by:

put in interface SyncCache<org.ehcache.Cache>

Parameters:

key - the key with which the specified value is to be associated

value - the value to be associated with the specified key

invalidate

public void invalidate(@Nonnull
                       java.lang.Object key)

Description copied from interface: SyncCache

Invalidate the value for the given key.

Specified by:

invalidate in interface SyncCache<org.ehcache.Cache>

Parameters:

key - The key to invalid

invalidateAll

public void invalidateAll()

Description copied from interface: SyncCache

Invalidate all cached values within this cache.

Specified by:

invalidateAll in interface SyncCache<org.ehcache.Cache>

getName

public java.lang.String getName()

Specified by:

getName in interface Cache<org.ehcache.Cache>

Returns:

The name of the cache

getNativeCache

public org.ehcache.Cache getNativeCache()

Specified by:

getNativeCache in interface Cache<org.ehcache.Cache>

Returns:

The native cache implementation

getCacheInfo

public org.reactivestreams.Publisher<CacheInfo> getCacheInfo()

Specified by:

getCacheInfo in interface Cache<org.ehcache.Cache>

Returns:

The cache information.