Class BoundedLocalCache.BoundedPolicy<K,V>

java.lang.Object

com.github.benmanes.caffeine.cache.BoundedLocalCache.BoundedPolicy<K,V>

All Implemented Interfaces:

Policy<K,V>

Enclosing class:

BoundedLocalCache<K,V>

static final class BoundedLocalCache.BoundedPolicy<K,V>
extends Object
implements Policy<K,V>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) final class	BoundedLocalCache.BoundedPolicy.BoundedEviction
(package private) final class	BoundedLocalCache.BoundedPolicy.BoundedExpireAfterAccess
(package private) final class	BoundedLocalCache.BoundedPolicy.BoundedExpireAfterWrite
(package private) final class	BoundedLocalCache.BoundedPolicy.BoundedRefreshAfterWrite
(package private) final class	BoundedLocalCache.BoundedPolicy.BoundedVarExpiration

Nested classes/interfaces inherited from interface Policy

Policy.Eviction<K,V>, Policy.Expiration<K,V>, Policy.VarExpiration<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
(package private) @Nullable Optional<Policy.Expiration<K,V>>	afterAccess
(package private) @Nullable Optional<Policy.Expiration<K,V>>	afterWrite
(package private) final BoundedLocalCache<K,V>	cache
(package private) @Nullable Optional<Policy.Eviction<K,V>>	eviction
(package private) final boolean	isWeighted
(package private) @Nullable Optional<Policy.Expiration<K,V>>	refreshes
(package private) final Function<V,V>	transformer
(package private) @Nullable Optional<Policy.VarExpiration<K,V>>	variable

Constructor Summary

Constructors

Constructor	Description
BoundedPolicy(BoundedLocalCache<K,V> cache, Function<V,V> transformer, boolean isWeighted)

Method Summary

Modifier and Type	Method	Description
Optional<Policy.Eviction<K,V>>	eviction()	Returns access to perform operations based on the maximum size or maximum weight eviction policy.
Optional<Policy.Expiration<K,V>>	expireAfterAccess()	Returns access to perform operations based on the time-to-idle expiration policy.
Optional<Policy.Expiration<K,V>>	expireAfterWrite()	Returns access to perform operations based on the time-to-live expiration policy.
Optional<Policy.VarExpiration<K,V>>	expireVariably()	Returns access to perform operations based on the variable expiration policy.
@Nullable V	getIfPresentQuietly(Object key)	Returns the value associated with the key in this cache, or null if there is no cached value for the key.
boolean	isRecordingStats()	Returns whether the cache statistics are being accumulated.
Optional<Policy.Expiration<K,V>>	refreshAfterWrite()	Returns access to perform operations based on the time-to-live refresh policy.

Methods inherited from class Object

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

Field Details

cache

final BoundedLocalCache<K,V> cache

transformer

final Function<V,V> transformer

isWeighted

final boolean isWeighted

eviction

@Nullable Optional<Policy.Eviction<K,V>> eviction

refreshes

@Nullable Optional<Policy.Expiration<K,V>> refreshes

afterWrite

@Nullable Optional<Policy.Expiration<K,V>> afterWrite

afterAccess

@Nullable Optional<Policy.Expiration<K,V>> afterAccess

variable

@Nullable Optional<Policy.VarExpiration<K,V>> variable

Constructor Details

BoundedPolicy

BoundedPolicy(BoundedLocalCache<K,V> cache,
 Function<V,V> transformer,
 boolean isWeighted)

Method Details

isRecordingStats

public boolean isRecordingStats()

Description copied from interface: Policy

Returns whether the cache statistics are being accumulated.

Specified by:

isRecordingStats in interface Policy<K,V>

Returns:

if cache statistics are being recorded

getIfPresentQuietly

public @Nullable V getIfPresentQuietly(Object key)

Description copied from interface: Policy

Returns the value associated with the key in this cache, or null if there is no cached value for the key. Unlike Cache.getIfPresent(Object), this method does not produce any side effects such as updating statistics, the eviction policy, reseting the expiration time, or triggering a refresh.

Specified by:

getIfPresentQuietly in interface Policy<K,V>

Parameters:

key - the key whose associated value is to be returned

Returns:

the value to which the specified key is mapped, or null if this cache contains no mapping for the key

eviction

public Optional<Policy.Eviction<K,V>> eviction()

Description copied from interface: Policy

Returns access to perform operations based on the maximum size or maximum weight eviction policy. If the cache was not constructed with a size-based bound or the implementation does not support these operations, an empty Optional is returned.

Specified by:

eviction in interface Policy<K,V>

Returns:

access to low-level operations for this cache if an eviction policy is used

expireAfterAccess

public Optional<Policy.Expiration<K,V>> expireAfterAccess()

Description copied from interface: Policy

Returns access to perform operations based on the time-to-idle expiration policy. This policy determines that an entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, the most recent replacement of its value, or its last access. Access time is reset by all cache read and write operations (including Cache.asMap().get(Object) and Cache.asMap().put(K, V)), but not by operations on the collection-views of Cache.asMap().

If the cache was not constructed with access-based expiration or the implementation does not support these operations, an empty Optional is returned.

Specified by:

expireAfterAccess in interface Policy<K,V>

Returns:

access to low-level operations for this cache if a time-to-idle expiration policy is used

expireAfterWrite

public Optional<Policy.Expiration<K,V>> expireAfterWrite()

Description copied from interface: Policy

Returns access to perform operations based on the time-to-live expiration policy. This policy determines that an entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, or the most recent replacement of its value.

If the cache was not constructed with write-based expiration or the implementation does not support these operations, an empty Optional is returned.

Specified by:

expireAfterWrite in interface Policy<K,V>

Returns:

access to low-level operations for this cache if a time-to-live expiration policy is used

expireVariably

public Optional<Policy.VarExpiration<K,V>> expireVariably()

Description copied from interface: Policy

Returns access to perform operations based on the variable expiration policy. This policy determines that an entry should be automatically removed from the cache once a per-entry duration has elapsed.

If the cache was not constructed with variable expiration or the implementation does not support these operations, an empty Optional is returned.

Specified by:

expireVariably in interface Policy<K,V>

Returns:

access to low-level operations for this cache if a variable expiration policy is used

refreshAfterWrite

public Optional<Policy.Expiration<K,V>> refreshAfterWrite()

Description copied from interface: Policy

Returns access to perform operations based on the time-to-live refresh policy. This policy determines that an entry should be automatically reloaded once a fixed duration has elapsed after the entry's creation, or the most recent replacement of its value.

If the cache was not constructed with write-based refresh or the implementation does not support these operations, an empty Optional is returned.

Specified by:

refreshAfterWrite in interface Policy<K,V>

Returns:

access to low-level operations for this cache if a time-to-live refresh policy is used