org.conqat.lib.commons.collections

Class SetMap<K,V>

java.lang.Object

org.conqat.lib.commons.collections.CollectionMap<K,V,java.util.Set<V>>

org.conqat.lib.commons.collections.SetMap<K,V>

Type Parameters:

K - the key type.

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

All Implemented Interfaces:

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

public class SetMap<K,V>
extends CollectionMap<K,V,java.util.Set<V>>

Manages a map of sets, i.e. each key can store multiple elements.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SetMap()
SetMap(java.util.Map<K,java.util.Set<V>>... otherMaps)
SetMap(SetMap<K,V>... otherMaps)
SetMap(java.util.function.Supplier<java.util.Set<V>> setFactory)

Method Summary

Modifier and Type	Method and Description
protected java.util.Set<V>	createNewCollection() Returns a new instance of the underlying collection to be used as value for the underlaying map.
SetMap<V,K>	invert() Inverts this SetMap, i.e.
static <K,V> SetMap<K,V>	of(K key, V... values) Factory function for a SetMap with one entry.

Methods inherited from class org.conqat.lib.commons.collections.CollectionMap

add, addAll, addAll, addAll, clear, collectionsToArrays, contains, containsCollection, createUnderlyingMap, createWithCollectionSupplier, getCollection, getCollectionOrElse, getCollectionOrEmpty, getKeys, getValueCount, getValues, iterator, remove, removeCollection, size, 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

SetMap

public SetMap()

SetMap

public SetMap(java.util.function.Supplier<java.util.Set<V>> setFactory)

SetMap

@SafeVarargs
public SetMap(SetMap<K,V>... otherMaps)

SetMap

@SafeVarargs
public SetMap(java.util.Map<K,java.util.Set<V>>... otherMaps)

Method Detail

createNewCollection

protected java.util.Set<V> createNewCollection()

Description copied from class: CollectionMap

Returns a new instance of the underlying collection to be used as value for the underlaying map.

Specified by:

createNewCollection in class CollectionMap<K,V,java.util.Set<V>>

invert

public SetMap<V,K> invert()

Inverts this SetMap, i.e. switches the keys and values.

of

public static <K,V> SetMap<K,V> of(K key,
                                   V... values)

Factory function for a SetMap with one entry.