com.cloudant.common

Class ValueListMap<K,V>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.concurrent.ConcurrentHashMap<K,java.util.List<V>>

com.cloudant.common.ValueListMap<K,V>

Type Parameters:

K - the type of key

V - the type of values

All Implemented Interfaces:

java.io.Serializable, java.util.concurrent.ConcurrentMap<K,java.util.List<V>>, java.util.Map<K,java.util.List<V>>

public class ValueListMap<K,V>
extends java.util.concurrent.ConcurrentHashMap<K,java.util.List<V>>

A map implementation that stores a list of values for each key. To remain consistent with existing Map interfaces the put* methods perform replacement of keys with new lists of values, the addValue* methods should be used to add new values to the existing keys.

Note that when using put to add a list of values for a key that later calls to addValue* will modify the original list. Consequently if the list is not modifiable then these operations will fail (typically with an UnsupportedOperationException).

This implementation does not currently support removing some values from a key.

See Also:

Serialized Form

API Status: Private - API users are discouraged from using this class as fields, method signatures, and implementation details may be subject to change

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.ConcurrentHashMap

java.util.concurrent.ConcurrentHashMap.KeySetView<K,V>

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

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

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

Constructor Summary

Constructors

Constructor and Description
ValueListMap()

Method Summary

Modifier and Type	Method and Description
void	addValuesToKey(K key, java.util.Collection<V> valueCollection) Add a collection of one or more values to the map under the existing key or creating a new key if it does not yet exist in the map.
void	addValueToKey(K key, V value) Add a value to the map under the existing key or creating a new key if it does not yet exist.

Methods inherited from class java.util.concurrent.ConcurrentHashMap

clear, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, forEach, forEach, forEachEntry, forEachEntry, forEachKey, forEachKey, forEachValue, forEachValue, get, getOrDefault, hashCode, isEmpty, keys, keySet, keySet, mappingCount, merge, newKeySet, newKeySet, put, putAll, putIfAbsent, reduce, reduceEntries, reduceEntries, reduceEntriesToDouble, reduceEntriesToInt, reduceEntriesToLong, reduceKeys, reduceKeys, reduceKeysToDouble, reduceKeysToInt, reduceKeysToLong, reduceToDouble, reduceToInt, reduceToLong, reduceValues, reduceValues, reduceValuesToDouble, reduceValuesToInt, reduceValuesToLong, remove, remove, replace, replace, replaceAll, search, searchEntries, searchKeys, searchValues, size, toString, values

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ValueListMap

public ValueListMap()

Method Detail

addValueToKey

public void addValueToKey(K key,
                          V value)

Add a value to the map under the existing key or creating a new key if it does not yet exist.

Parameters:

key - the key to associate the values with

value - the value to add to the key

addValuesToKey

public void addValuesToKey(K key,
                           java.util.Collection<V> valueCollection)

Add a collection of one or more values to the map under the existing key or creating a new key if it does not yet exist in the map.

Parameters:

key - the key to associate the values with

valueCollection - a collection of values to add to the key