Package com.google.common.cache
Interface LocalCache.ValueReference<K,V>
- All Known Implementing Classes:
LocalCache.ComputingValueReference
,LocalCache.LoadingValueReference
,LocalCache.SoftValueReference
,LocalCache.StrongValueReference
,LocalCache.WeakValueReference
,LocalCache.WeightedSoftValueReference
,LocalCache.WeightedStrongValueReference
,LocalCache.WeightedWeakValueReference
- Enclosing class:
LocalCache<K,
V>
static interface LocalCache.ValueReference<K,V>
A reference to a value.
-
Method Summary
Modifier and TypeMethodDescriptioncopyFor
(ReferenceQueue<V> queue, V value, ReferenceEntry<K, V> entry) Creates a copy of this reference for the given entry.get()
Returns the value.getEntry()
Returns the entry associated with this value reference, ornull
if this value reference is independent of any entry.int
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
Returns true if a new value is currently loading, regardless of whether there is an existing value.void
notifyNewValue
(V newValue) Notify pending loads that a new value was set.Waits for a value that may still be loading.
-
Method Details
-
get
Returns the value. Does not block or throw exceptions. -
waitForValue
Waits for a value that may still be loading. Unlike get(), this method can block (in the case of FutureValueReference).- Throws:
ExecutionException
- if the loading thread throws an exceptionExecutionError
- if the loading thread throws an error
-
getWeight
int getWeight()Returns the weight of this entry. This is assumed to be static between calls to setValue. -
getEntry
Returns the entry associated with this value reference, ornull
if this value reference is independent of any entry. -
copyFor
LocalCache.ValueReference<K,V> copyFor(ReferenceQueue<V> queue, @CheckForNull V value, ReferenceEntry<K, V> entry) Creates a copy of this reference for the given entry.value
may be null only for a loading reference. -
notifyNewValue
Notify pending loads that a new value was set. This is only relevant to loading value references. -
isLoading
boolean isLoading()Returns true if a new value is currently loading, regardless of whether there is an existing value. It is assumed that the return value of this method is constant for any given ValueReference instance. -
isActive
boolean isActive()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.
-