io.werval.api.cache

Interface Cache

All Known Implementing Classes:

CacheAdapter, MapCache

public interface Cache

Cache.

Method Summary

Modifier and Type	Method and Description
<T> T	get(String key) Fetch cached object for a given key.
<T> Optional<T>	getOptional(String key) Optionaly fetch cached object for a given key.
<T> T	getOrSetDefault(String key, int ttlSeconds, Supplier<T> defaultValueSupplier) Fetch cached object for a given key or set an expiring default value.
<T> T	getOrSetDefault(String key, int ttlSeconds, T defaultValue) Fetch cached object for a given key or set an expiring default value.
<T> T	getOrSetDefault(String key, Supplier<T> defaultValueSupplier) Fetch cached object for a given key or set a non-expiring default value.
<T> T	getOrSetDefault(String key, T defaultValue) Fetch cached object for a given key or set a non-expiring default value.
boolean	has(String key) Check if the Cache has an object for a given key.
void	remove(String key) Remove a Cache entry.
<T> void	set(int ttlSeconds, String key, T value) Set an expiring object for a given key in the Cache.
<T> void	set(String key, T value) Set a non-expiring object for a given key in the Cache.

Method Detail

has

boolean has(String key)

Check if the Cache has an object for a given key.

Parameters:

key - Cache Key

Returns:

true if the cache has an object for the given key

get

<T> T get(String key)

Fetch cached object for a given key.

Type Parameters:

T - Object Type

Parameters:

key - Cache Key

Returns:

The cached object for the given key, or null if absent

getOptional

<T> Optional<T> getOptional(String key)

Optionaly fetch cached object for a given key.

Type Parameters:

T - Object Type

Parameters:

key - Cache Key

Returns:

An Optional of the cached object for the given key

getOrSetDefault

<T> T getOrSetDefault(String key,
                      T defaultValue)

Fetch cached object for a given key or set a non-expiring default value.

If the cache has a non-expired object for the given key, it is returned.

Otherwise, the given default value is set in the cache and returned.

Type Parameters:

T - Object Type

Parameters:

key - Cache Key

defaultValue - Default Value

Returns:

The existing cached object for the given key, or the given default value, never return null

getOrSetDefault

<T> T getOrSetDefault(String key,
                      Supplier<T> defaultValueSupplier)

Fetch cached object for a given key or set a non-expiring default value.

If the cache has a non-expired object for the given key, it is returned.

Otherwise, the given default value is set in the cache and returned.

Type Parameters:

T - Object Type

Parameters:

key - Cache Key

defaultValueSupplier - Default Value Supplier

Returns:

The existing cached object for the given key, or the given default value, never return null

getOrSetDefault

<T> T getOrSetDefault(String key,
                      int ttlSeconds,
                      T defaultValue)

Fetch cached object for a given key or set an expiring default value.

If the cache has a non-expired object for the given key, it is returned.

Otherwise, the given default value is set in the cache and returned.

Type Parameters:

T - Object Type

Parameters:

key - Cache Key

ttlSeconds - Default Value Time To Live in seconds. If 0 (ZERO), then the entry will never expire

defaultValue - Default Value

Returns:

The existing cached object for the given key, or the given default value, never return null

getOrSetDefault

<T> T getOrSetDefault(String key,
                      int ttlSeconds,
                      Supplier<T> defaultValueSupplier)

Fetch cached object for a given key or set an expiring default value.

If the cache has a non-expired object for the given key, it is returned.

Otherwise, the given default value is set in the cache and returned.

Type Parameters:

T - Object Type

Parameters:

key - Cache Key

ttlSeconds - Default Value Time To Live in seconds. If 0 (ZERO), then the entry will never expire

defaultValueSupplier - Default Value Supplier

Returns:

The existing cached object for the given key, or the given default value, never return null

set

<T> void set(String key,
             T value)

Set a non-expiring object for a given key in the Cache.

Type Parameters:

T - Object Type

Parameters:

key - Cache Key

value - Value Object

set

<T> void set(int ttlSeconds,
             String key,
             T value)

Set an expiring object for a given key in the Cache.

Type Parameters:

T - Object Type

Parameters:

ttlSeconds - Time To Live in seconds. If 0 (ZERO), then the entry will not expire

key - Cache Key

value - Value Object

remove

void remove(String key)

Remove a Cache entry.

Parameters:

key - Key of the entry to remove