Package com.google.common.cache

Class LocalCache.LoadingValueReference<K,V>

java.lang.Object

com.google.common.cache.LocalCache.LoadingValueReference<K,V>

All Implemented Interfaces:

LocalCache.ValueReference<K,V>

Enclosing class:

LocalCache<K,V>

static class LocalCache.LoadingValueReference<K,V>
extends java.lang.Object
implements LocalCache.ValueReference<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
(package private) SettableFuture<V>	futureValue
(package private) LocalCache.ValueReference<K,V>	oldValue
(package private) Stopwatch	stopwatch

Constructor Summary

Constructors

Constructor	Description
LoadingValueReference()
LoadingValueReference(LocalCache.ValueReference<K,V> oldValue)

Method Summary

Modifier and Type	Method	Description
V	compute(K key, java.util.function.BiFunction<? super K,? super V,? extends V> function)
LocalCache.ValueReference<K,V>	copyFor(java.lang.ref.ReferenceQueue<V> queue, V value, ReferenceEntry<K,V> entry)	Creates a copy of this reference for the given entry.
long	elapsedNanos()
private ListenableFuture<V>	fullyFailedFuture(java.lang.Throwable t)
V	get()	Returns the value.
ReferenceEntry<K,V>	getEntry()	Returns the entry associated with this value reference, or null if this value reference is independent of any entry.
LocalCache.ValueReference<K,V>	getOldValue()
int	getWeight()	Returns the weight of this entry.
boolean	isActive()	Returns true if this reference contains an active value, meaning one that is still considered present in the cache.
boolean	isLoading()	Returns true if a new value is currently loading, regardless of whether or not there is an existing value.
ListenableFuture<V>	loadFuture(K key, CacheLoader<? super K,V> loader)
void	notifyNewValue(V newValue)	Notify pending loads that a new value was set.
boolean	set(V newValue)
boolean	setException(java.lang.Throwable t)
V	waitForValue()	Waits for a value that may still be loading.

Methods inherited from class java.lang.Object

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

Field Detail

oldValue

volatile LocalCache.ValueReference<K,V> oldValue

futureValue

final SettableFuture<V> futureValue

stopwatch

final Stopwatch stopwatch

Constructor Detail

LoadingValueReference

public LoadingValueReference()

LoadingValueReference

public LoadingValueReference(LocalCache.ValueReference<K,V> oldValue)

Method Detail

isLoading

public boolean isLoading()

Description copied from interface: LocalCache.ValueReference

Returns true if a new value is currently loading, regardless of whether or not there is an existing value. It is assumed that the return value of this method is constant for any given ValueReference instance.

Specified by:

isLoading in interface LocalCache.ValueReference<K,V>

isActive

public boolean isActive()

Description copied from interface: LocalCache.ValueReference

Returns true if this reference contains an active value, meaning one that is still considered present in the cache. Active values consist of live values, which are returned by cache lookups, and dead values, which have been evicted but awaiting removal. Non-active values consist strictly of loading values, though during refresh a value may be both active and loading.

Specified by:

isActive in interface LocalCache.ValueReference<K,V>

getWeight

public int getWeight()

Description copied from interface: LocalCache.ValueReference

Returns the weight of this entry. This is assumed to be static between calls to setValue.

Specified by:

getWeight in interface LocalCache.ValueReference<K,V>

set

public boolean set(V newValue)

setException

public boolean setException(java.lang.Throwable t)

fullyFailedFuture

private ListenableFuture<V> fullyFailedFuture(java.lang.Throwable t)

notifyNewValue

public void notifyNewValue(V newValue)

Description copied from interface: LocalCache.ValueReference

Notify pending loads that a new value was set. This is only relevant to loading value references.

Specified by:

notifyNewValue in interface LocalCache.ValueReference<K,V>

loadFuture

public ListenableFuture<V> loadFuture(K key,
                                      CacheLoader<? super K,V> loader)

compute

public V compute(K key,
                 java.util.function.BiFunction<? super K,? super V,? extends V> function)

elapsedNanos

public long elapsedNanos()

waitForValue

public V waitForValue()
               throws java.util.concurrent.ExecutionException

Description copied from interface: LocalCache.ValueReference

Waits for a value that may still be loading. Unlike get(), this method can block (in the case of FutureValueReference).

Specified by:

waitForValue in interface LocalCache.ValueReference<K,V>

Throws:

java.util.concurrent.ExecutionException - if the loading thread throws an exception

get

public V get()

Description copied from interface: LocalCache.ValueReference

Returns the value. Does not block or throw exceptions.

Specified by:

get in interface LocalCache.ValueReference<K,V>

getOldValue

public LocalCache.ValueReference<K,V> getOldValue()

getEntry

public ReferenceEntry<K,V> getEntry()

Description copied from interface: LocalCache.ValueReference

Returns the entry associated with this value reference, or null if this value reference is independent of any entry.

Specified by:

getEntry in interface LocalCache.ValueReference<K,V>

copyFor

public LocalCache.ValueReference<K,V> copyFor(java.lang.ref.ReferenceQueue<V> queue,
                                                    V value,
                                                    ReferenceEntry<K,V> entry)

Description copied from interface: LocalCache.ValueReference

Creates a copy of this reference for the given entry.

value may be null only for a loading reference.

Specified by:

copyFor in interface LocalCache.ValueReference<K,V>