Package software.xdev.caching

Class ExpiringLimitedCache<K,V>

java.lang.Object

software.xdev.caching.ExpiringLimitedCache<K,V>

public class ExpiringLimitedCache<K,V>
extends Object

Caches values until

• a specific time (>=1s) elapses (is cleared in batches by a timer so it may stick around a bit longer) - expirationTime
• a maximum number (>=1) of items is reached - ExpiringLimitedCache.LimitedLinkedHashMap
• the JVM needs memory - SoftReference)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ExpiringLimitedCache.CacheValue<V>
static class	ExpiringLimitedCache.LimitedLinkedHashMap<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<K,SoftReference<ExpiringLimitedCache.CacheValue<V>>>	cache
protected ScheduledExecutorService	cleanUpExecutor
protected final AtomicInteger	cleanUpExecutorCounter
protected final Object	cleanUpExecutorLock
protected final ThreadFactory	cleanUpExecutorThreadFactory
protected final Duration	expirationTime
protected Consumer<String>	logConsumer

Constructor Summary

Constructors

Constructor	Description
ExpiringLimitedCache(String cacheName, Duration expirationTime, int maxSize)

Method Summary

Modifier and Type	Method	Description
int	cacheSize()
protected static LocalDateTime	currentUtcTime()
V	get(K key)
protected void	log(String s)
void	put(K key, V value)
void	setLogConsumer(Consumer<String> logConsumer)
protected void	shutdownCleanupExecutorIfRequired()

Methods inherited from class java.lang.Object

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

Field Details

expirationTime

protected final Duration expirationTime

cleanUpExecutorCounter

protected final AtomicInteger cleanUpExecutorCounter

cleanUpExecutorThreadFactory

protected final ThreadFactory cleanUpExecutorThreadFactory

cleanUpExecutor

protected ScheduledExecutorService cleanUpExecutor

cleanUpExecutorLock

protected final Object cleanUpExecutorLock

logConsumer

protected Consumer<String> logConsumer

cache

protected final Map<K,SoftReference<ExpiringLimitedCache.CacheValue<V>>> cache

Constructor Details

ExpiringLimitedCache

public ExpiringLimitedCache(String cacheName,
 Duration expirationTime,
 int maxSize)

Method Details

setLogConsumer

public void setLogConsumer(Consumer<String> logConsumer)

log

protected void log(String s)

put

public void put(K key,
 V value)

get

public V get(K key)

shutdownCleanupExecutorIfRequired

protected void shutdownCleanupExecutorIfRequired()

cacheSize

public int cacheSize()

currentUtcTime

protected static LocalDateTime currentUtcTime()