Package org.sellcom.core.util.cache

Interface Cache<K,V>

All Known Implementing Classes:

ConcurrentSoftCache, SoftCache

public interface Cache<K,V>

Generic cache.

Since:

1.3

Method Summary

Modifier and Type	Method	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(java.util.function.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.
java.util.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.

Method Detail

evict

void evict(K key)

Evicts the entry with the given key from this cache.

Throws:

java.lang.IllegalArgumentException - if key is null

Since:

1.3

See Also:

Map.remove(Object)

evict

void evict(K key,
           V value)

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

Throws:

java.lang.IllegalArgumentException - if key is null

java.lang.IllegalArgumentException - if value is null

Since:

1.3

See Also:

Map.remove(Object, Object)

evictAll

void evictAll()

Evicts all entries from this cache.

Since:

1.3

See Also:

Map.clear()

forEach

void forEach(java.util.function.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. Exceptions thrown by the action are relayed to the caller.

Throws:

java.lang.IllegalArgumentException - if action is null

Since:

1.3

See Also:

Map.forEach(BiConsumer)

get

java.util.Optional<V> get(K key)

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

Throws:

java.lang.IllegalArgumentException - if key is null

Since:

1.3

See Also:

Map.get(Object)

getOrDefault

V getOrDefault(K key,
               V defaultValue)

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.

Throws:

java.lang.IllegalArgumentException - if key is null

Since:

1.3

See Also:

Map.getOrDefault(Object, Object)

isEmpty

boolean isEmpty()

Checks whether this cache is empty.

Since:

1.3

See Also:

Map.isEmpty()

put

void put(K key,
         V value)

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

Throws:

java.lang.IllegalArgumentException - if key is null

java.lang.IllegalArgumentException - if value is null

Since:

1.3

See Also:

Map.put(Object, Object)

putIfAbsent

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.

Throws:

java.lang.IllegalArgumentException - if key is null

java.lang.IllegalArgumentException - if value is null

Since:

1.3

See Also:

Map.putIfAbsent(Object, Object)

size

int size()

Returns the number of entries in this cache.

Since:

1.3

See Also:

Map.size()