CollectionMap (Teamscale Check Framework API)

java.lang.Object
- org.conqat.lib.commons.collections.CollectionMap<K,V,C>

Type Parameters:

K - the key type.

V - the value type (i.e. the values stored in the collections).

C - the collection type, which is made explicit at the interface.

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<java.util.Map.Entry<K,C>>

Direct Known Subclasses:

ListMap, SetMap
```
public abstract class CollectionMap<K,V,C extends java.util.Collection<V>>
extends java.lang.Object
implements java.io.Serializable, java.lang.Iterable<java.util.Map.Entry<K,C>>
```
A collection map deals with a map of collections, i.e. each key can store multiple elements. Depending on the collection implementation chosen, this can also be interpreted as a multi map.
If you deal with the basic case of Maps and Lists, use the ListMap, which is much easier to apply.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CollectionMap()
Constructor.

Constructors
Constructor and Description
`CollectionMap()` Constructor.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(K key, V value)` Adds a value to the collection associated with the given key.
`void`	`addAll(CollectionMap<K,V,C> other)` Adds all elements from another collection map.
`boolean`	`addAll(K key, java.util.Collection<? extends V> values)` Adds all values to the collection associated with the given key.
`void`	`addAll(java.util.Map<K,C> other)` Adds all elements from a Java map.
`void`	`clear()` Clears the underlying map and thus all contents.
`java.util.Map<K,V[]>`	`collectionsToArrays(java.lang.Class<V> type)` Converts the `CollectionMap` to a map with arrays
`boolean`	`contains(K key, V value)` Returns whether an element is contained.
`boolean`	`containsCollection(K key)` Check if a (possibly empty) collection is present for a given key.
`protected abstract C`	`createNewCollection()` Returns a new instance of the underlying collection to be used as value for the underlaying map.
`protected java.util.Map<K,C>`	`createUnderlyingMap()` Create a new instance of the underlying map, called exactly once during the constructor.
`static <K,V,C extends java.util.Collection<V>> CollectionMap<K,V,C>`	`createWithCollectionSupplier(java.util.function.Supplier<C> collectionInitializer)` Helper method to create a new CollectionMap with a given type of Collection initializer.
`C`	`getCollection(K key)` Returns the collection stored under the given key (or null).
`C`	`getCollectionOrElse(K key, C defaultCollection)` Returns the collection stored under the given key (or the given default if no collection is stored).
`C`	`getCollectionOrEmpty(K key)` Returns the collection stored under the given key (or an empty collection).
`UnmodifiableSet<K>`	`getKeys()` Get the keys.
`int`	`getValueCount()` Return the total count of values over all collections.
`C`	`getValues()` Return all values from all collections.
`java.util.Iterator<java.util.Map.Entry<K,C>>`	`iterator()`
`boolean`	`remove(K key, V value)` Removes an element.
`boolean`	`removeCollection(K key)` Removes the collection stored for a key.
`int`	`size()` Returns the size of this map, i.e.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - CollectionMap
```
public CollectionMap()
```
    Constructor.
- Method Detail
  - createUnderlyingMap
```
protected java.util.Map<K,C> createUnderlyingMap()
```
    Create a new instance of the underlying map, called exactly once during the constructor. Can be used to prepopulate the list with values if necessary.
  - createNewCollection
```
protected abstract C createNewCollection()
```
    Returns a new instance of the underlying collection to be used as value for the underlaying map.
  - getCollection
```
public C getCollection(K key)
```
    Returns the collection stored under the given key (or null). Modifying the collection will directly affect this object.
  - getCollectionOrElse
```
public C getCollectionOrElse(K key,
                             C defaultCollection)
```
    Returns the collection stored under the given key (or the given default if no collection is stored). Modifying the collection will directly affect this object.
  - getCollectionOrEmpty
```
public C getCollectionOrEmpty(K key)
```
    Returns the collection stored under the given key (or an empty collection). If there was a collection stored under the key, modifying the collection will directly affect this object.
  - add
```
public boolean add(K key,
                   V value)
```
    Adds a value to the collection associated with the given key.
    
    Returns:
    
    true if the collection associated with the given key changed as a result of the call.
  - addAll
```
public boolean addAll(K key,
                      java.util.Collection<? extends V> values)
```
    Adds all values to the collection associated with the given key.
    
    Returns:
    
    true if the collection associated with the given key changed as a result of the call.
  - addAll
```
public void addAll(CollectionMap<K,V,C> other)
```
    Adds all elements from another collection map.
  - addAll
```
public void addAll(java.util.Map<K,C> other)
```
    Adds all elements from a Java map.
  - contains
```
public boolean contains(K key,
                        V value)
```
    Returns whether an element is contained.
  - remove
```
public boolean remove(K key,
                      V value)
```
    Removes an element.
    
    Returns:
    
    true if an element was removed as a result of this call.
  - containsCollection
```
public boolean containsCollection(K key)
```
    Check if a (possibly empty) collection is present for a given key.
  - removeCollection
```
public boolean removeCollection(K key)
```
    Removes the collection stored for a key.
    
    Returns:
    
    true if a collection was removed as a result of this call.
  - getKeys
```
public UnmodifiableSet<K> getKeys()
```
    Get the keys.
  - getValues
```
public C getValues()
```
    Return all values from all collections.
  - size
```
public int size()
```
    Returns the size of this map, i.e. number of key-value mappings in this map.
  - getValueCount
```
public int getValueCount()
```
    Return the total count of values over all collections.
  - clear
```
public void clear()
```
    Clears the underlying map and thus all contents.
  - collectionsToArrays
```
public java.util.Map<K,V[]> collectionsToArrays(java.lang.Class<V> type)
```
    Converts the CollectionMap to a map with arrays
    
    Parameters:
    
    type - Type of the target array
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - iterator
```
public java.util.Iterator<java.util.Map.Entry<K,C>> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<java.util.Map.Entry<K,C extends java.util.Collection<V>>>
  - createWithCollectionSupplier
```
public static <K,V,C extends java.util.Collection<V>> CollectionMap<K,V,C> createWithCollectionSupplier(java.util.function.Supplier<C> collectionInitializer)
```
    Helper method to create a new CollectionMap with a given type of Collection initializer. Usage e.g.: CollectionMap.createWithCollectionInitializer(() -> new LinkedList());

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

CollectionMap

Method Detail

createUnderlyingMap

createNewCollection

getCollection

getCollectionOrElse

getCollectionOrEmpty

add

addAll

addAll

addAll

contains

remove

containsCollection

removeCollection

getKeys

getValues

size

getValueCount

clear

collectionsToArrays

toString

iterator

createWithCollectionSupplier