Class AbstractMultimap<K, V, C extends Collection<V>>

java.lang.Object

org.greenrobot.essentials.collections.AbstractMultimap<K,V,C>

All Implemented Interfaces:

Map<K,C>

Direct Known Subclasses:

Multimap, MultimapSet

public abstract class AbstractMultimap<K, V, C extends Collection<V>>
extends Object
implements Map<K,C>

Combines a Map with List values to provide simple way to store multiple values for a key (multimap).

Threading note: All methods are synchronized

Nested Class Summary

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<K,C>	map

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMultimap(Map<K,C> map)

Method Summary

Modifier and Type	Method	Description
void	clear()
boolean	containsElement(K key, V value)
boolean	containsElement(V value)
boolean	containsKey(Object key)
boolean	containsValue(Object value)
int	countElements()
int	countElements(K key)
protected abstract C	createNewCollection()
Set<Map.Entry<K,C>>	entrySet()
boolean	equals(Object o)
C	get(Object key)
int	hashCode()
boolean	isEmpty()
Set<K>	keySet()
C	put(K key, C value)
void	putAll(Map<? extends K, ? extends C> m)
int	putElement(K key, V value)
boolean	putElements(K key, Collection<V> values)
C	remove(Object key)
boolean	removeElement(K key, V value)
int	size()
Collection<C>	values()
C	valuesElements()

Methods inherited from class Object

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

Methods inherited from interface Map

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

Field Details

map

protected Map<K, C extends Collection<V>> map

Constructor Details

AbstractMultimap

protected AbstractMultimap(Map<K,C> map)

Method Details

createNewCollection

protected abstract C createNewCollection()

putAll

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

Specified by:

putAll in interface Map<K,V>

size

public int size()

Specified by:

size in interface Map<K,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,V>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,V>

get

public C get(Object key)

Specified by:

get in interface Map<K,V>

remove

public C remove(Object key)

Specified by:

remove in interface Map<K,V>

clear

public void clear()

Specified by:

clear in interface Map<K,V>

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

values

public Collection<C> values()

Specified by:

values in interface Map<K,V>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<K,V>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<K,V>

Overrides:

hashCode in class Object

putElement

public int putElement(K key,
 V value)

Returns:

number of elements stored for given key after storing the given value.

put

public C put(K key,
 C value)

Specified by:

put in interface Map<K,V>

entrySet

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

Specified by:

entrySet in interface Map<K,V>

putElements

public boolean putElements(K key,
 Collection<V> values)

Returns:

true if the collection was changed.

removeElement

public boolean removeElement(K key,
 V value)

Returns:

true if the given element was removed.

countElements

public int countElements(K key)

countElements

public int countElements()

containsElement

public boolean containsElement(K key,
 V value)

containsElement

public boolean containsElement(V value)

valuesElements

public C valuesElements()