org.n52.sos.util

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

java.lang.Object

org.n52.sos.util.AbstractDelegatingMultiMap<K,V,C>

org.n52.sos.util.AbstractSynchronizedMultiMap<K,V,C>

Type Parameters:

K - the key type

V - the value type

C - the collection type

All Implemented Interfaces:

Serializable, Map<K,C>, MultiMap<K,V,C>

Direct Known Subclasses:

SynchronizedListMultiMap, SynchronizedSetMultiMap

public abstract class AbstractSynchronizedMultiMap<K,V,C extends Collection<V>>
extends AbstractDelegatingMultiMap<K,V,C>

Abstract implementation that delegates to synchronized HashMap

Since:

4.0.0

Author:

Christian Autermann

See Also:

Collections.synchronizedMap(java.util.Map), Serialized Form

Nested Class Summary

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

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
private Map<K,C>	delegate
private ReadWriteLock	lock
private Lock	read
private static long	serialVersionUID
private Lock	write

Constructor Summary

Constructors

Constructor and Description
AbstractSynchronizedMultiMap()
AbstractSynchronizedMultiMap(int initialCapacity)
AbstractSynchronizedMultiMap(int initialCapacity, float loadFactor)
AbstractSynchronizedMultiMap(Map<? extends K,? extends C> m)

Method Summary

Modifier and Type	Method and Description
C	add(K key, V value) Adds the specified value to the key.
C	addAll(K key, Collection<? extends V> values) Adds the specified values to the key.
C	allValues()
void	clear()
boolean	containsCollectionValue(V v) Checks if any collection of any key contains v.
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<K,C>>	entrySet()
boolean	equals(Object o)
C	get(Object key)
protected Map<K,C>	getDelegate()
int	hashCode()
boolean	hasValues(K key) Checks if the specified key is contained in this map and if the associated collection is not empty.
boolean	isEmpty()
Set<K>	keySet()
C	put(K key, C value)
void	putAll(Map<? extends K,? extends C> m)
boolean	remove(K key, Iterable<V> value) Removes the values of the collection for the specified key (if it exists).
C	remove(Object key)
boolean	remove(Object k, Object v) Removes the value of the collection for the specified key (if it exists).
boolean	removeWithKey(K key, Iterable<V> value) Removes the specified values of the collection for the specified key (if it exists).
boolean	removeWithKey(K key, V value) Removes the specified value of the collection for the specified key (if it exists).
int	size()
Collection<C>	values()

Methods inherited from class org.n52.sos.util.AbstractDelegatingMultiMap

newCollection

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, replace, replace, replaceAll

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

lock

private final ReadWriteLock lock

read

private final Lock read

write

private final Lock write

delegate

private final Map<K,C extends Collection<V>> delegate

Constructor Detail

AbstractSynchronizedMultiMap

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

AbstractSynchronizedMultiMap

public AbstractSynchronizedMultiMap(int initialCapacity)

AbstractSynchronizedMultiMap

public AbstractSynchronizedMultiMap(int initialCapacity,
                                    float loadFactor)

AbstractSynchronizedMultiMap

public AbstractSynchronizedMultiMap()

Method Detail

getDelegate

protected Map<K,C> getDelegate()

Specified by:

getDelegate in class AbstractDelegatingMultiMap<K,V,C extends Collection<V>>

Returns:

the delegate to operate on

size

public int size()

Specified by:

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

Overrides:

size in class AbstractDelegatingMultiMap<K,V,C extends Collection<V>>

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class AbstractDelegatingMultiMap<K,V,C extends Collection<V>>

containsKey

public boolean containsKey(Object key)

Specified by:

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

Overrides:

containsKey in class AbstractDelegatingMultiMap<K,V,C extends Collection<V>>

containsValue

public boolean containsValue(Object value)

Specified by:

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

Overrides:

containsValue in class AbstractDelegatingMultiMap<K,V,C extends Collection<V>>

get

public C get(Object key)

Specified by:

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

Overrides:

get in class AbstractDelegatingMultiMap<K,V,C extends Collection<V>>

put

public C put(K key,
             C value)

Specified by:

put in interface Map<K,C extends Collection<V>>

Overrides:

put in class AbstractDelegatingMultiMap<K,V,C extends Collection<V>>

add

public C add(K key,
             V value)

Description copied from interface: MultiMap

Adds the specified value to the key. If the collection for the key was null it will be created.

Specified by:

add in interface MultiMap<K,V,C extends Collection<V>>

Overrides:

add in class AbstractDelegatingMultiMap<K,V,C extends Collection<V>>

Parameters:

key - the key

value - the value

Returns:

the collection the value was added to

remove

public C remove(Object key)

Specified by:

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

Overrides:

remove in class AbstractDelegatingMultiMap<K,V,C extends Collection<V>>

remove

public boolean remove(Object k,
                      Object v)

Description copied from interface: MultiMap

Removes the value of the collection for the specified key (if it exists).

Specified by:

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

Specified by:

remove in interface MultiMap<K,V,C extends Collection<V>>

Overrides:

remove in class AbstractDelegatingMultiMap<K,V,C extends Collection<V>>

Parameters:

k - the key

v - the value to remove

Returns:

if the map was altered

putAll

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

Specified by:

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

Overrides:

putAll in class AbstractDelegatingMultiMap<K,V,C extends Collection<V>>

clear

public void clear()

Specified by:

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

Overrides:

clear in class AbstractDelegatingMultiMap<K,V,C extends Collection<V>>

keySet

public Set<K> keySet()

Specified by:

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

Overrides:

keySet in class AbstractDelegatingMultiMap<K,V,C extends Collection<V>>

values

public Collection<C> values()

Specified by:

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

Overrides:

values in class AbstractDelegatingMultiMap<K,V,C extends Collection<V>>

allValues

public C allValues()

Specified by:

allValues in interface MultiMap<K,V,C extends Collection<V>>

Overrides:

allValues in class AbstractDelegatingMultiMap<K,V,C extends Collection<V>>

Returns:

the values of all keys

entrySet

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

Specified by:

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

Overrides:

entrySet in class AbstractDelegatingMultiMap<K,V,C extends Collection<V>>

equals

public boolean equals(Object o)

Specified by:

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

Overrides:

equals in class AbstractDelegatingMultiMap<K,V,C extends Collection<V>>

hashCode

public int hashCode()

Specified by:

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

Overrides:

hashCode in class AbstractDelegatingMultiMap<K,V,C extends Collection<V>>

containsCollectionValue

public boolean containsCollectionValue(V v)

Description copied from interface: MultiMap

Checks if any collection of any key contains v.

Specified by:

containsCollectionValue in interface MultiMap<K,V,C extends Collection<V>>

Overrides:

containsCollectionValue in class AbstractDelegatingMultiMap<K,V,C extends Collection<V>>

Parameters:

v - the element to check

Returns:

if it is contained

remove

public boolean remove(K key,
                      Iterable<V> value)

Description copied from interface: MultiMap

Removes the values of the collection for the specified key (if it exists).

Specified by:

remove in interface MultiMap<K,V,C extends Collection<V>>

Overrides:

remove in class AbstractDelegatingMultiMap<K,V,C extends Collection<V>>

Parameters:

key - the key

value - the values to remove

Returns:

if the map was altered

hasValues

public boolean hasValues(K key)

Description copied from interface: MultiMap

Checks if the specified key is contained in this map and if the associated collection is not empty.

Specified by:

hasValues in interface MultiMap<K,V,C extends Collection<V>>

Overrides:

hasValues in class AbstractDelegatingMultiMap<K,V,C extends Collection<V>>

Parameters:

key - the key

Returns:

if the key has at least one value

addAll

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

Description copied from interface: MultiMap

Adds the specified values to the key. If the collection for the key was null it will be created.

Specified by:

addAll in interface MultiMap<K,V,C extends Collection<V>>

Overrides:

addAll in class AbstractDelegatingMultiMap<K,V,C extends Collection<V>>

Parameters:

key - the key

values - the values

Returns:

the collection the values were added to

removeWithKey

public boolean removeWithKey(K key,
                             V value)

Description copied from interface: MultiMap

Removes the specified value of the collection for the specified key (if it exists). If the collection for the key is empty after the removal the key is removed from the map.

Specified by:

removeWithKey in interface MultiMap<K,V,C extends Collection<V>>

Overrides:

removeWithKey in class AbstractDelegatingMultiMap<K,V,C extends Collection<V>>

Parameters:

key - the key

value - the value

Returns:

if the map was altered

removeWithKey

public boolean removeWithKey(K key,
                             Iterable<V> value)

Description copied from interface: MultiMap

Removes the specified values of the collection for the specified key (if it exists). If the collection for the key is empty after the removal the key is removed from the map.

Specified by:

removeWithKey in interface MultiMap<K,V,C extends Collection<V>>

Overrides:

removeWithKey in class AbstractDelegatingMultiMap<K,V,C extends Collection<V>>

Parameters:

key - the key

value - the value

Returns:

if the map was altered