Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv static class	Async.AsyncEvictionListener<K, V> An eviction listener that forwards the value stored in a `CompletableFuture` to the user-supplied eviction listener.
pack-priv static class	Async.AsyncExpiry<K, V> An expiry for asynchronous computations.
pack-priv static class	Async.AsyncRemovalListener<K, V> A removal listener that asynchronously forwards the value stored in a `CompletableFuture` if successful to the user-supplied removal listener.
pack-priv static class	Async.AsyncWeigher<K, V> A weigher for asynchronous computations.

Field Summary

Modifier and Type	Field and Description
pack-priv static final long	ASYNC_EXPIRY

Access	Constructor and Description
private	Async()

Method Summary

Modifier and Type	Method and Description
pack-priv static <V> @Nullable V	getIfReady(@Nullable CompletableFuture<V> future) Returns the current value or null if either not done or failed.
pack-priv static <V> @Nullable V	getWhenSuccessful(@Nullable CompletableFuture<V> future) Returns the value when completed successfully or null if failed.
pack-priv static boolean	isReady(@Nullable CompletableFuture<?> future) Returns if the future has successfully completed.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ASYNC_EXPIRY	back to summary
pack-priv static final long ASYNC_EXPIRY

Async	back to summary
private Async()

Method Detail

getIfReady	back to summary
pack-priv static <V> @Nullable V getIfReady(@Nullable CompletableFuture<V> future) Returns the current value or null if either not done or failed. Annotations @SuppressWarnings:NullAway

getIfReady

back to summary

pack-priv static <V> @Nullable V getIfReady(@Nullable CompletableFuture<V> future)

Returns the current value or null if either not done or failed.

Annotations

@SuppressWarnings:NullAway

getWhenSuccessful	back to summary
pack-priv static <V> @Nullable V getWhenSuccessful(@Nullable CompletableFuture<V> future) Returns the value when completed successfully or null if failed.

isReady	back to summary
pack-priv static boolean isReady(@Nullable CompletableFuture<?> future) Returns if the future has successfully completed.

com.github.benmanes.caffeine.cache back to summary

pack-priv final Class Async.AsyncEvictionListener<K, V>

Class Inheritance

extends Object
implements RemovalListener<K, CompletableFuture<V>>, Serializable

java.lang.Object
com.github.benmanes.caffeine.cache.Async.AsyncEvictionListener

All Implemented Interfaces

java.io.Serializable, com.github.benmanes.caffeine.cache.RemovalListener

An eviction listener that forwards the value stored in a CompletableFuture to the user-supplied eviction listener.

Field Summary

Modifier and Type	Field and Description
pack-priv final RemovalListener<K, V>	delegate
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
pack-priv	AsyncEvictionListener(RemovalListener<K, V> delegate)

Method Summary

Modifier and Type	Method and Description
public void	onRemoval(@Nullable K key, @Nullable CompletableFuture<V> future, RemovalCause cause)
pack-priv Object	writeReplace()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

delegate	back to summary
pack-priv final RemovalListener<K, V> delegate

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

AsyncEvictionListener	back to summary
pack-priv AsyncEvictionListener(RemovalListener<K, V> delegate)

Method Detail

onRemoval	back to summary
public void onRemoval(@Nullable K key, @Nullable CompletableFuture<V> future, RemovalCause cause) Annotations @Override

writeReplace	back to summary
pack-priv Object writeReplace()

com.github.benmanes.caffeine.cache back to summary

pack-priv final Class Async.AsyncExpiry<K, V>

Class Inheritance

extends Object
implements Expiry<K, CompletableFuture<V>>, Serializable

java.lang.Object
com.github.benmanes.caffeine.cache.Async.AsyncExpiry

All Implemented Interfaces

java.io.Serializable, com.github.benmanes.caffeine.cache.Expiry

An expiry for asynchronous computations. When the value is being loaded this expiry returns ASYNC_EXPIRY to indicate that the entry should not be evicted due to an expiry constraint. If the value is computed successfully then the entry must be reinserted so that the expiration is updated and the expiration timeouts reflect the value once present. The duration's maximum range is reserved to coordinate with the asynchronous life cycle.

Field Summary

Modifier and Type	Field and Description
pack-priv final Expiry<? super K, ? super V>	delegate
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
pack-priv	AsyncExpiry(Expiry<? super K, ? super V> delegate)

Method Summary

Modifier and Type	Method and Description
public long	expireAfterCreate(K the key represented by this entry key, CompletableFuture<V> the value represented by this entry future, long the current time, in nanoseconds currentTime) Implements com.github.benmanes.caffeine.cache.Expiry.expireAfterCreate. Specifies that the entry should be automatically removed from the cache once the duration has elapsed after the entry's creation.
public long	expireAfterRead(K key, CompletableFuture<V> future, long currentTime, long currentDuration)
public long	expireAfterUpdate(K key, CompletableFuture<V> future, long currentTime, long currentDuration)
pack-priv Object	writeReplace()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

delegate	back to summary
pack-priv final Expiry<? super K, ? super V> delegate

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

AsyncExpiry	back to summary
pack-priv AsyncExpiry(Expiry<? super K, ? super V> delegate)

Method Detail

expireAfterCreate back to summary

expireAfterCreate	back to summary
public long expireAfterCreate(K key, CompletableFuture<V> future, long currentTime) Implements com.github.benmanes.caffeine.cache.Expiry.expireAfterCreate. Doc from com.github.benmanes.caffeine.cache.Expiry.expireAfterCreate. Specifies that the entry should be automatically removed from the cache once the duration has elapsed after the entry's creation. To indicate no expiration, an entry may be given an excessively long period, such as `Long#MAX_VALUE`. Note The `currentTime` is supplied by the configured `Ticker` and by default does not relate to system or wall-clock time. When calculating the duration based on a timestamp, the current time should be obtained independently. Parameters key:K the key represented by this entry future:CompletableFuture<V> the value represented by this entry currentTime:long the current time, in nanoseconds Returns:long the length of time before the entry expires, in nanoseconds Annotations @Override

public long expireAfterCreate(K key, CompletableFuture<V> future, long currentTime)

Implements com.github.benmanes.caffeine.cache.Expiry.expireAfterCreate.

Doc from com.github.benmanes.caffeine.cache.Expiry.expireAfterCreate.

Specifies that the entry should be automatically removed from the cache once the duration has elapsed after the entry's creation. To indicate no expiration, an entry may be given an excessively long period, such as Long#MAX_VALUE.

Note

The currentTime is supplied by the configured Ticker and by default does not relate to system or wall-clock time. When calculating the duration based on a timestamp, the current time should be obtained independently.

Parameters

key:K: the key represented by this entry
future:CompletableFuture<V>: the value represented by this entry
currentTime:long: the current time, in nanoseconds

Returns:long

the length of time before the entry expires, in nanoseconds

Annotations

@Override

expireAfterRead	back to summary
public long expireAfterRead(K key, CompletableFuture<V> future, long currentTime, long currentDuration) Annotations @Override

expireAfterUpdate	back to summary
public long expireAfterUpdate(K key, CompletableFuture<V> future, long currentTime, long currentDuration) Annotations @Override

writeReplace	back to summary
pack-priv Object writeReplace()

com.github.benmanes.caffeine.cache back to summary

pack-priv final Class Async.AsyncRemovalListener<K, V>

Class Inheritance

extends Object
implements RemovalListener<K, CompletableFuture<V>>, Serializable

java.lang.Object
com.github.benmanes.caffeine.cache.Async.AsyncRemovalListener

All Implemented Interfaces

java.io.Serializable, com.github.benmanes.caffeine.cache.RemovalListener

A removal listener that asynchronously forwards the value stored in a CompletableFuture if successful to the user-supplied removal listener.

Field Summary

Modifier and Type	Field and Description
pack-priv final RemovalListener<K, V>	delegate
pack-priv final Executor	executor
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
pack-priv	AsyncRemovalListener(RemovalListener<K, V> delegate, Executor executor)

Method Summary

Modifier and Type	Method and Description
public void	onRemoval(@Nullable K key, @Nullable CompletableFuture<V> future, RemovalCause cause)
pack-priv Object	writeReplace()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

delegate	back to summary
pack-priv final RemovalListener<K, V> delegate

executor	back to summary
pack-priv final Executor executor

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

AsyncRemovalListener	back to summary
pack-priv AsyncRemovalListener(RemovalListener<K, V> delegate, Executor executor)

Method Detail

onRemoval	back to summary
public void onRemoval(@Nullable K key, @Nullable CompletableFuture<V> future, RemovalCause cause) Annotations @Override @SuppressWarnings:FutureReturnValueIgnored

writeReplace	back to summary
pack-priv Object writeReplace()

com.github.benmanes.caffeine.cache back to summary

pack-priv final Class Async.AsyncWeigher<K, V>

Class Inheritance

extends Object
implements Weigher<K, CompletableFuture<V>>, Serializable

java.lang.Object
com.github.benmanes.caffeine.cache.Async.AsyncWeigher

All Implemented Interfaces

java.io.Serializable, com.github.benmanes.caffeine.cache.Weigher

A weigher for asynchronous computations. When the value is being loaded this weigher returns 0 to indicate that the entry should not be evicted due to a size constraint. If the value is computed successfully then the entry must be reinserted so that the weight is updated and the expiration timeouts reflect the value once present. This can be done safely using Map#replace(Object, Object, Object).

Field Summary

Modifier and Type	Field and Description
pack-priv final Weigher<K, V>	delegate
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
pack-priv	AsyncWeigher(Weigher<K, V> delegate)

Method Summary

Modifier and Type	Method and Description
public int	weigh(K the key to weigh key, CompletableFuture<V> the value to weigh future) Implements com.github.benmanes.caffeine.cache.Weigher.weigh. Returns the weight of a cache entry.
pack-priv Object	writeReplace()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

delegate	back to summary
pack-priv final Weigher<K, V> delegate

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

AsyncWeigher	back to summary
pack-priv AsyncWeigher(Weigher<K, V> delegate)

Method Detail

weigh	back to summary
public int weigh(K key, CompletableFuture<V> future) Implements com.github.benmanes.caffeine.cache.Weigher.weigh. Doc from com.github.benmanes.caffeine.cache.Weigher.weigh. Returns the weight of a cache entry. There is no unit for entry weights; rather they are simply relative to each other. Parameters key:K the key to weigh future:CompletableFuture<V> the value to weigh Returns:int the weight of the entry; must be non-negative Annotations @Override

weigh

back to summary

public int weigh(K key, CompletableFuture<V> future)

Implements com.github.benmanes.caffeine.cache.Weigher.weigh.

Doc from com.github.benmanes.caffeine.cache.Weigher.weigh.

Returns the weight of a cache entry. There is no unit for entry weights; rather they are simply relative to each other.

Parameters

key:K: the key to weigh
future:CompletableFuture<V>: the value to weigh

Returns:int

the weight of the entry; must be non-negative

Annotations

@Override

writeReplace	back to summary
pack-priv Object writeReplace()