org.sellcom.core.util.cache

Class SoftCache<K,V>

java.lang.Object

org.sellcom.core.util.cache.SoftCache<K,V>

All Implemented Interfaces:

Cache<K,V>

public final class SoftCache<K,V>
extends Object
implements Cache<K,V>

Unbounded cache with soft-referenced values.

Since:

1.3

Constructor Summary

Constructors

Constructor and Description
SoftCache() Creates an unbounded cache with soft-referenced values.
SoftCache(Function<K,V> mappingFunction) Creates an unbounded cache with soft-referenced values that uses the given mapping function to create values from keys.

Method Summary

Modifier and Type	Method and Description
void	evict(K key) Evicts the entry with the given key from this cache.
void	evict(K key, V value) Evicts the entry with the given key and value from this cache.
void	evictAll() Evicts all entries from this cache.
void	forEach(BiConsumer<? super K,? super V> action) Performs the given action for each entry in this cache until all entries have been processed or the action throws an exception.
Optional<V>	get(K key) Returns the value associated with the given key in this cache.
V	getOrDefault(K key, V defaultValue) Returns the value associated with the given key in this cache.
boolean	isEmpty() Checks whether this cache is empty.
void	put(K key, V value) Creates an entry with the given key and value in this cache.
void	putIfAbsent(K key, V value) Creates an entry with the given key and value in this cache only if no entry with the same key already exists.
int	size() Returns the number of entries in this cache.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SoftCache

public SoftCache()

Creates an unbounded cache with soft-referenced values.

Since:

1.3

SoftCache

public SoftCache(Function<K,V> mappingFunction)

Creates an unbounded cache with soft-referenced values that uses the given mapping function to create values from keys.

Throws:

IllegalArgumentException - if mappingFunction is null

Since:

1.3

Method Detail

evict

public void evict(K key)

Description copied from interface: Cache

Evicts the entry with the given key from this cache.

Specified by:

evict in interface Cache<K,V>

See Also:

Map.remove(Object)

evict

public void evict(K key,
                  V value)

Description copied from interface: Cache

Evicts the entry with the given key and value from this cache.

Specified by:

evict in interface Cache<K,V>

See Also:

Map.remove(Object, Object)

evictAll

public void evictAll()

Description copied from interface: Cache

Evicts all entries from this cache.

Specified by:

evictAll in interface Cache<K,V>

See Also:

Map.clear()

forEach

public void forEach(BiConsumer<? super K,? super V> action)

Description copied from interface: Cache

Performs the given action for each entry in this cache until all entries have been processed or the action throws an exception. Exceptions thrown by the action are relayed to the caller.

Specified by:

forEach in interface Cache<K,V>

See Also:

Map.forEach(BiConsumer)

get

public Optional<V> get(K key)

Description copied from interface: Cache

Returns the value associated with the given key in this cache.

Specified by:

get in interface Cache<K,V>

See Also:

Map.get(Object)

getOrDefault

public V getOrDefault(K key,
                      V defaultValue)

Description copied from interface: Cache

Returns the value associated with the given key in this cache. Returns the given default value if this cache contains no entry with the key.

Specified by:

getOrDefault in interface Cache<K,V>

See Also:

Map.getOrDefault(Object, Object)

isEmpty

public boolean isEmpty()

Description copied from interface: Cache

Checks whether this cache is empty.

Specified by:

isEmpty in interface Cache<K,V>

See Also:

Map.isEmpty()

put

public void put(K key,
                V value)

Description copied from interface: Cache

Creates an entry with the given key and value in this cache. Overwrites the existing entry with the same key, if any.

Specified by:

put in interface Cache<K,V>

See Also:

Map.put(Object, Object)

putIfAbsent

public void putIfAbsent(K key,
                        V value)

Description copied from interface: Cache

Creates an entry with the given key and value in this cache only if no entry with the same key already exists.

Specified by:

putIfAbsent in interface Cache<K,V>

See Also:

Map.putIfAbsent(Object, Object)

size

public int size()

Description copied from interface: Cache

Returns the number of entries in this cache.

Specified by:

size in interface Cache<K,V>

See Also:

Map.size()

toString

public String toString()

Overrides:

toString in class Object