org.opendaylight.infrautils.caches

Interface CachePolicy

All Known Implementing Classes:

NoopCachePolicy

@Value.Immutable
public interface CachePolicy

Policy of a Cache (or CheckedCache).

Author:

Michael Vorburger.ch

Field Summary

Fields

Modifier and Type	Field and Description
static long	UNLIMITED_ENTRIES

Method Summary

Modifier and Type	Method and Description
default long	maxEntries() Specifies the maximum number of entries the cache may contain.
default boolean	statsEnabled() Whether this cache has it statics enabled.

Field Detail

UNLIMITED_ENTRIES

static final long UNLIMITED_ENTRIES

See Also:

Constant Field Values

Method Detail

statsEnabled

@Value.Default
default boolean statsEnabled()

Whether this cache has it statics enabled. This may cause it to have a bit more runtime overhead than it would have if it does not. CacheStats are obtained via CacheManager.getStats()

maxEntries

@Value.Default
default long maxEntries()

Specifies the maximum number of entries the cache may contain. When this limit is reached, existing entries are evicted to accomodate new entries.

The default is UNLIMITED_ENTRIES.

Users are encourage to set the maximum entries policy suitable to their actual usage of the cache; either programmatically in code, or by runtime configuration.