com.atlassian.cache

Interface CachedReference<V>

@PublicApi
public interface CachedReference<V>

A Resettable reference.

Since:

2.0

Method Summary

Modifier and Type	Method and Description
void	addListener(CachedReferenceListener<V> listener, boolean includeValues) Deprecated. since 2.9 may not be supported in all implementations
V	get() Get a value from the cache.
void	removeListener(CachedReferenceListener<V> listener) Deprecated. since 2.9 may not be supported in all implementations
void	reset() Resets (clears/invalidates) this reference.

Method Detail

get

@Nonnull
V get()

Get a value from the cache.

Returns:

the cached value

reset

void reset()

Resets (clears/invalidates) this reference.

addListener

@Deprecated
void addListener(@Nonnull
                             CachedReferenceListener<V> listener,
                             boolean includeValues)

Deprecated. since 2.9 may not be supported in all implementations

Adds a CachedReferenceListener

Parameters:

listener - the listener

includeValues - if the events sent to this listener will include old/new value. This can be used in cases when the cost of finding these values is big (network sync) but the listener is not interested in the concrete values for events its getting. The support for this parameter is optional and implementation dependent

Throws:

UnsupportedOperationException - if not supported

Since:

2.4

removeListener

@Deprecated
void removeListener(@Nonnull
                                CachedReferenceListener<V> listener)

Deprecated. since 2.9 may not be supported in all implementations

Removes a CachedReferenceListener

Parameters:

listener - the listener

Throws:

UnsupportedOperationException - if not supported

Since:

2.4