net.kuujo.copycat.collections.internal.map

Interface MultiMapState<K,V>

All Known Implementing Classes:

DefaultMultiMapState

public interface MultiMapState<K,V>

Asynchronous multimap state.

Author:

Jordan Halterman

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the map.
boolean	containsEntry(K key, V value) Returns a boolean indicating whether the map contains an entry.
boolean	containsKey(K key) Returns a boolean indicating whether the map contains a key.
boolean	containsValue(V value) Returns a boolean indicating whether the map contains a value.
Set<Map.Entry<K,V>>	entrySet() Returns a set of entries in the map.
Collection<V>	get(K key) Gets a value from the map.
Collection<V>	getOrDefault(K key, Collection<V> defaultValue) Gets a key from the map or returns a default value.
void	init(StateContext<MultiMapState<K,V>> context) Initializes the multimap state.
boolean	isEmpty() Returns a boolean indicating whether the map is empty.
Set<K>	keySet() Returns a set of keys in the map.
Collection<V>	put(K key, V value) Puts a value in the map.
void	putAll(Map<? extends K,? extends Collection<V>> m) Puts a collection of values in the map.
Collection<V>	remove(K key) Removes a key from the map.
boolean	remove(K key, V value) Removes an entry from the map.
Collection<V>	replace(K key, Collection<V> value) Replaces a key in the map.
boolean	replace(K key, V oldValue, V newValue) Replaces a value in the map.
void	replaceAll(java.util.function.BiFunction<? super K,? super Collection<V>,? extends Collection<V>> function) Replaces a set of keys in the map.
int	size() Returns the map size.
Collection<V>	values() Returns a set of values in the map.

Method Detail

init

void init(StateContext<MultiMapState<K,V>> context)

Initializes the multimap state.

Parameters:

context - The multimap state context.

size

int size()

Returns the map size.

isEmpty

boolean isEmpty()

Returns a boolean indicating whether the map is empty.

containsKey

boolean containsKey(K key)

Returns a boolean indicating whether the map contains a key.

containsValue

boolean containsValue(V value)

Returns a boolean indicating whether the map contains a value.

containsEntry

boolean containsEntry(K key,
                      V value)

Returns a boolean indicating whether the map contains an entry.

get

Collection<V> get(K key)

Gets a value from the map.

put

Collection<V> put(K key,
                  V value)

Puts a value in the map.

remove

Collection<V> remove(K key)

Removes a key from the map.

remove

boolean remove(K key,
               V value)

Removes an entry from the map.

putAll

void putAll(Map<? extends K,? extends Collection<V>> m)

Puts a collection of values in the map.

clear

void clear()

Clears the map.

keySet

Set<K> keySet()

Returns a set of keys in the map.

values

Collection<V> values()

Returns a set of values in the map.

entrySet

Set<Map.Entry<K,V>> entrySet()

Returns a set of entries in the map.

getOrDefault

Collection<V> getOrDefault(K key,
                           Collection<V> defaultValue)

Gets a key from the map or returns a default value.

replaceAll

void replaceAll(java.util.function.BiFunction<? super K,? super Collection<V>,? extends Collection<V>> function)

Replaces a set of keys in the map.

replace

boolean replace(K key,
                V oldValue,
                V newValue)

Replaces a value in the map.

replace

Collection<V> replace(K key,
                      Collection<V> value)

Replaces a key in the map.