discord4j.rest.util

Class Multimap<K,V>

java.lang.Object

discord4j.rest.util.Multimap<K,V>

Type Parameters:

K - the key type

V - the value type

All Implemented Interfaces:

Map<K,List<V>>

public class Multimap<K,V>
extends Object
implements Map<K,List<V>>

A simple multi-valued map that wraps a LinkedHashMap with LinkedList to store multiple values. This class is NOT thread-safe.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Multimap() Create an empty Multimap.
Multimap(int initialCapacity) Create an empty Multimap with a given initial capacity.

Method Summary

Modifier and Type	Method and Description
void	add(K key, V value) Add a value to the list of values under the given key.
void	addAll(K key, Collection<? extends V> values) Add multiple values to the list of values under the given key.
void	addAll(Multimap<K,V> values) Add all values from the given Multimap to the current ones.
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Multimap<K,V>	deepCopy() Clone this Multimap using a deep copy, including each stored value list.
Set<Map.Entry<K,List<V>>>	entrySet()
List<V>	get(Object key)
boolean	isEmpty()
Set<K>	keySet()
List<V>	put(K key, List<V> value)
void	putAll(Map<? extends K,? extends List<V>> m)
List<V>	remove(Object key)
void	set(K key, V value) Set a value under the given key, replacing any existing single or multiple values.
void	setAll(Map<K,V> values) Set multiple values under the given key, replacing any existing single or multiple values.
int	size()
Collection<List<V>>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Multimap

public Multimap()

Create an empty Multimap.

Multimap

public Multimap(int initialCapacity)

Create an empty Multimap with a given initial capacity.

Parameters:

initialCapacity - the initial capacity

Method Detail

add

public void add(K key,
                V value)

Add a value to the list of values under the given key.

Parameters:

key - the key

value - the value to add

addAll

public void addAll(K key,
                   Collection<? extends V> values)

Add multiple values to the list of values under the given key.

Parameters:

key - the key

values - the values to add

addAll

public void addAll(Multimap<K,V> values)

Add all values from the given Multimap to the current ones.

Parameters:

values - the values to add

set

public void set(K key,
                V value)

Set a value under the given key, replacing any existing single or multiple values.

Parameters:

key - the key

value - the value to set

setAll

public void setAll(Map<K,V> values)

Set multiple values under the given key, replacing any existing single or multiple values.

Parameters:

values - the values to set

deepCopy

public Multimap<K,V> deepCopy()

Clone this Multimap using a deep copy, including each stored value list.

Returns:

a deep copy of this Multimap

size

public int size()

Specified by:

size in interface Map<K,List<V>>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,List<V>>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,List<V>>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,List<V>>

get

public List<V> get(Object key)

Specified by:

get in interface Map<K,List<V>>

put

public List<V> put(K key,
                   List<V> value)

Specified by:

put in interface Map<K,List<V>>

remove

public List<V> remove(Object key)

Specified by:

remove in interface Map<K,List<V>>

putAll

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

Specified by:

putAll in interface Map<K,List<V>>

clear

public void clear()

Specified by:

clear in interface Map<K,List<V>>

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K,List<V>>

values

public Collection<List<V>> values()

Specified by:

values in interface Map<K,List<V>>

entrySet

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

Specified by:

entrySet in interface Map<K,List<V>>