com.helger.commons.collection.multimap

Interface IMultiMapListBased<KEYTYPE,VALUETYPE>

Type Parameters:

KEYTYPE - Key type

VALUETYPE - Value type

All Superinterfaces:

IMultiMap<KEYTYPE,VALUETYPE,List<VALUETYPE>>, Map<KEYTYPE,List<VALUETYPE>>

All Known Implementing Classes:

AbstractMultiConcurrentHashMapListBased, AbstractMultiHashMapListBased, AbstractMultiLinkedHashMapListBased, AbstractMultiTreeMapListBased, AbstractMultiWeakHashMapListBased, MultiConcurrentHashMapArrayListBased, MultiConcurrentHashMapVectorBased, MultiHashMapArrayListBased, MultiHashMapVectorBased, MultiLinkedHashMapArrayListBased, MultiLinkedHashMapVectorBased, MultiTreeMapArrayListBased, MultiTreeMapVectorBased, MultiWeakHashMapArrayListBased, MultiWeakHashMapVectorBased

public interface IMultiMapListBased<KEYTYPE,VALUETYPE>
extends IMultiMap<KEYTYPE,VALUETYPE,List<VALUETYPE>>

Interface for a multi map that uses a List for the storage.

Author:

Philip Helger

Nested Class Summary

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

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
EChange	putSingle(KEYTYPE aKey, VALUETYPE aValue, int nIndex) Add a single value into the container identified by the passed key at the specified index.

Methods inherited from interface com.helger.commons.collection.multimap.IMultiMap

containsSingle, getOrCreate, getTotalValueCount, putAllIn, putSingle, removeSingle

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

putSingle

@Nonnull
EChange putSingle(@Nonnull
                            KEYTYPE aKey,
                            @Nullable
                            VALUETYPE aValue,
                            @Nonnegative
                            int nIndex)

Add a single value into the container identified by the passed key at the specified index.

Parameters:

aKey - The key to use. May not be null.

aValue - The value to be added. May be null.

nIndex - The index to add the element to the list. Must be ≥ 0.

Returns:

EChange