com.atlassian.jira.cache

Interface SingleValueLocalCache<V>

@ParametersAreNonnullByDefault
public interface SingleValueLocalCache<V>

Convenience class that allows to store a single value in an internal cache.

Since:

v7.1

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY

Method Summary

Modifier and Type	Method and Description
V	get() Gets a cached value or creates new one (using the supplier) and puts it into the cache if value does not exist.
static <V> SingleValueLocalCache<V>	of(com.atlassian.cache.CachedReference<V> cache) Creates single value cache wrapper over CachedReference.
static <V> SingleValueLocalCache<V>	of(com.atlassian.vcache.LocalCacheOperations<String,V> cache, java.util.function.Supplier<V> supplier) Creates single value cache wrapper over LocalCacheOperations.
void	reset() Removes a cached value from the cache if it is cached.

Field Detail

KEY

static final String KEY

See Also:

Constant Field Values

Method Detail

get

@Nonnull
V get()

Gets a cached value or creates new one (using the supplier) and puts it into the cache if value does not exist.

Returns:

cached value.

reset

void reset()

Removes a cached value from the cache if it is cached.

of

static <V> SingleValueLocalCache<V> of(com.atlassian.vcache.LocalCacheOperations<String,V> cache,
                                       java.util.function.Supplier<V> supplier)

Creates single value cache wrapper over LocalCacheOperations.

Parameters:

cache - that would used as a backend. It should not be used directly by anything else.

supplier - used to generate the value, if one does not exist already for the key. The supplier may not return null.

Returns:

SingleValueLocalCache backed by a supplied cache.

of

static <V> SingleValueLocalCache<V> of(com.atlassian.cache.CachedReference<V> cache)

Creates single value cache wrapper over CachedReference. This method is only here to make it easy to test the performance impacts of converting a CachedReference by using a dark feature flag.

This method WILL be removed once all atlassian caches have been replaced with vcache caches.

Parameters:

cache - that would used as a backend. It should not be used directly by anything else.

Returns:

SingleValueLocalCache backed by a supplied cache.