io.micronaut.cache.hazelcast

Class HazelcastAsyncCache

java.lang.Object

io.micronaut.cache.hazelcast.HazelcastAsyncCache

All Implemented Interfaces:

AsyncCache<com.hazelcast.map.IMap<Object,Object>>, Cache<com.hazelcast.map.IMap<Object,Object>>

public class HazelcastAsyncCache
extends Object
implements AsyncCache<com.hazelcast.map.IMap<Object,Object>>

A AsyncCache implementation based on Hazelcast.

Since:

1.0.0

Author:

Nirav Assar

Constructor Summary

Constructors

Constructor and Description
HazelcastAsyncCache(io.micronaut.core.convert.ConversionService<?> conversionService, com.hazelcast.map.IMap<Object,Object> nativeCache, ExecutorService executorService)

Method Summary

Modifier and Type	Method and Description
<T> CompletableFuture<Optional<T>>	get(Object key, io.micronaut.core.type.Argument<T> requiredType) Resolve the given value for the given key.
<T> CompletableFuture<T>	get(Object key, io.micronaut.core.type.Argument<T> requiredType, Supplier<T> supplier) Resolve the given value for the given key.
String	getName()
com.hazelcast.map.IMap	getNativeCache()
CompletableFuture<Boolean>	invalidate(Object key) Invalidate the value for the given key.
CompletableFuture<Boolean>	invalidateAll() Invalidate all cached values within this cache.
CompletableFuture<Boolean>	put(Object key, Object value) Cache the specified value using the specified key.
<T> CompletableFuture<Optional<T>>	putIfAbsent(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.AsyncCache

get, get

Methods inherited from interface io.micronaut.cache.Cache

getCacheInfo

Constructor Detail

HazelcastAsyncCache

public HazelcastAsyncCache(io.micronaut.core.convert.ConversionService<?> conversionService,
                           com.hazelcast.map.IMap<Object,Object> nativeCache,
                           ExecutorService executorService)

Parameters:

conversionService - the conversion service

nativeCache - the native cache

executorService - managers the pool of executors

Method Detail

get

@NonNull
public <T> CompletableFuture<Optional<T>> get(@NonNull
                                                       Object key,
                                                       @NonNull
                                                       io.micronaut.core.type.Argument<T> requiredType)

Description copied from interface: AsyncCache

Resolve the given value for the given key.

Specified by:

get in interface AsyncCache<com.hazelcast.map.IMap<Object,Object>>

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> CompletableFuture<T> get(@NonNull
                                    Object key,
                                    @NonNull
                                    io.micronaut.core.type.Argument<T> requiredType,
                                    @NonNull
                                    Supplier<T> supplier)

Description copied from interface: AsyncCache

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 AsyncCache<com.hazelcast.map.IMap<Object,Object>>

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> CompletableFuture<Optional<T>> putIfAbsent(@NonNull
                                                               Object key,
                                                               @NonNull
                                                               T value)

Description copied from interface: AsyncCache

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

Specified by:

putIfAbsent in interface AsyncCache<com.hazelcast.map.IMap<Object,Object>>

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 CompletableFuture<Boolean> put(@NonNull
                                      Object key,
                                      @NonNull
                                      Object value)

Description copied from interface: AsyncCache

Cache the specified value using the specified key.

Specified by:

put in interface AsyncCache<com.hazelcast.map.IMap<Object,Object>>

Parameters:

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

value - The value to be associated with the specified key

Returns:

A future with a boolean indicating whether the operation was successful or not

invalidate

public CompletableFuture<Boolean> invalidate(@NonNull
                                             Object key)

Description copied from interface: AsyncCache

Invalidate the value for the given key.

Specified by:

invalidate in interface AsyncCache<com.hazelcast.map.IMap<Object,Object>>

Parameters:

key - The key to invalid

Returns:

A future with a boolean indicating whether the operation was succesful or not

invalidateAll

public CompletableFuture<Boolean> invalidateAll()

Description copied from interface: AsyncCache

Invalidate all cached values within this cache.

Specified by:

invalidateAll in interface AsyncCache<com.hazelcast.map.IMap<Object,Object>>

Returns:

A future with a boolean indicating whether the operation was succesful or not

getName

public String getName()

Specified by:

getName in interface Cache<com.hazelcast.map.IMap<Object,Object>>

Returns:

The name of the cache

getNativeCache

public com.hazelcast.map.IMap getNativeCache()

Specified by:

getNativeCache in interface Cache<com.hazelcast.map.IMap<Object,Object>>

Returns:

The native cache implementation