org.greenrobot.essentials.collections

Class AbstractMultimap<K,V,C extends java.util.Collection<V>>

java.lang.Object

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

All Implemented Interfaces:

java.util.Map<K,C>

Direct Known Subclasses:

Multimap, MultimapSet

public abstract class AbstractMultimap<K,V,C extends java.util.Collection<V>>
extends java.lang.Object
implements java.util.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 java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMultimap(java.util.Map<K,C> map)

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

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

Field Detail

map

protected java.util.Map<K,C extends java.util.Collection<V>> map

Constructor Detail

AbstractMultimap

protected AbstractMultimap(java.util.Map<K,C> map)

Method Detail

createNewCollection

protected abstract C createNewCollection()

putAll

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

Specified by:

putAll in interface java.util.Map<K,C extends java.util.Collection<V>>

size

public int size()

Specified by:

size in interface java.util.Map<K,C extends java.util.Collection<V>>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<K,C extends java.util.Collection<V>>

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<K,C extends java.util.Collection<V>>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<K,C extends java.util.Collection<V>>

get

public C get(java.lang.Object key)

Specified by:

get in interface java.util.Map<K,C extends java.util.Collection<V>>

remove

public C remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<K,C extends java.util.Collection<V>>

clear

public void clear()

Specified by:

clear in interface java.util.Map<K,C extends java.util.Collection<V>>

keySet

public java.util.Set<K> keySet()

Specified by:

keySet in interface java.util.Map<K,C extends java.util.Collection<V>>

values

public java.util.Collection<C> values()

Specified by:

values in interface java.util.Map<K,C extends java.util.Collection<V>>

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.Map<K,C extends java.util.Collection<V>>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map<K,C extends java.util.Collection<V>>

Overrides:

hashCode in class java.lang.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 java.util.Map<K,C extends java.util.Collection<V>>

entrySet

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

Specified by:

entrySet in interface java.util.Map<K,C extends java.util.Collection<V>>

putElements

public boolean putElements(K key,
                           java.util.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()