com.helger.commons.collection.ext

Interface ICommonsMap<KEYTYPE,VALUETYPE>

All Superinterfaces:

ICloneable<ICommonsMap<KEYTYPE,VALUETYPE>>, Map<KEYTYPE,VALUETYPE>, Serializable

All Known Subinterfaces:

ICommonsNavigableMap<KEYTYPE,VALUETYPE>, ICommonsOrderedMap<KEYTYPE,VALUETYPE>, ICommonsSortedMap<KEYTYPE,VALUETYPE>, IMultiMap<KEYTYPE,VALUETYPE,COLLTYPE>, IMultiMapListBased<KEYTYPE,VALUETYPE>, IMultiMapMapBased<KEYTYPE1,KEYTYPE2,VALUETYPE>, IMultiMapSetBased<KEYTYPE,VALUETYPE,COLLTYPE>

All Known Implementing Classes:

AbstractMultiConcurrentHashMap, AbstractMultiConcurrentHashMapListBased, AbstractMultiConcurrentHashMapSetBased, AbstractMultiHashMap, AbstractMultiHashMapListBased, AbstractMultiHashMapMapBased, AbstractMultiHashMapSetBased, AbstractMultiLinkedHashMap, AbstractMultiLinkedHashMapListBased, AbstractMultiLinkedHashMapMapBased, AbstractMultiLinkedHashMapSetBased, AbstractMultiTreeMap, AbstractMultiTreeMapListBased, AbstractMultiTreeMapMapBased, AbstractMultiTreeMapSetBased, AbstractMultiWeakHashMap, AbstractMultiWeakHashMapListBased, AbstractMultiWeakHashMapSetBased, CommonsConcurrentHashMap, CommonsEnumMap, CommonsHashMap, CommonsLinkedHashMap, CommonsTreeMap, CommonsWeakHashMap, LoggingLRUMap, LRUMap, MultiConcurrentHashMapArrayListBased, MultiConcurrentHashMapHashSetBased, MultiConcurrentHashMapLinkedHashSetBased, MultiConcurrentHashMapTreeSetBased, MultiConcurrentHashMapVectorBased, MultiHashMapArrayListBased, MultiHashMapHashMapBased, MultiHashMapHashSetBased, MultiHashMapLinkedHashMapBased, MultiHashMapLinkedHashSetBased, MultiHashMapTreeMapBased, MultiHashMapTreeSetBased, MultiHashMapVectorBased, MultiHashMapWeakHashMapBased, MultiLinkedHashMapArrayListBased, MultiLinkedHashMapHashMapBased, MultiLinkedHashMapHashSetBased, MultiLinkedHashMapLinkedHashMapBased, MultiLinkedHashMapLinkedHashSetBased, MultiLinkedHashMapTreeMapBased, MultiLinkedHashMapTreeSetBased, MultiLinkedHashMapVectorBased, MultiLinkedHashMapWeakHashMapBased, MultiTreeMapArrayListBased, MultiTreeMapHashMapBased, MultiTreeMapHashSetBased, MultiTreeMapLinkedHashMapBased, MultiTreeMapLinkedHashSetBased, MultiTreeMapTreeMapBased, MultiTreeMapTreeSetBased, MultiTreeMapVectorBased, MultiTreeMapWeakHashMapBased, MultiWeakHashMapArrayListBased, MultiWeakHashMapHashSetBased, MultiWeakHashMapLinkedHashSetBased, MultiWeakHashMapTreeSetBased, MultiWeakHashMapVectorBased, NonBlockingProperties, SingleElementMap, SMap

public interface ICommonsMap<KEYTYPE,VALUETYPE>
extends Map<KEYTYPE,VALUETYPE>, ICloneable<ICommonsMap<KEYTYPE,VALUETYPE>>, Serializable

Nested Class Summary

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

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
default void	addAll(Map<? extends KEYTYPE,? extends VALUETYPE> aValues) Add all provided values.
default ICommonsSet<Map.Entry<KEYTYPE,VALUETYPE>>	copyOfEntrySet()
default ICommonsSet<KEYTYPE>	copyOfKeySet()
default ICommonsList<VALUETYPE>	copyOfValues()
default ICommonsList<VALUETYPE>	copyOfValues(Predicate<? super VALUETYPE> aFilter)
default <DSTTYPE> ICommonsList<DSTTYPE>	copyOfValuesMapped(Function<? super VALUETYPE,? extends DSTTYPE> aMapper)
default <DSTTYPE> ICommonsList<DSTTYPE>	copyOfValuesMapped(Predicate<? super VALUETYPE> aFilter, Function<? super VALUETYPE,? extends DSTTYPE> aMapper)
default Map.Entry<KEYTYPE,VALUETYPE>	findFirstEntry(Predicate<? super Map.Entry<KEYTYPE,VALUETYPE>> aFilter)
default KEYTYPE	findFirstKey(Predicate<? super Map.Entry<KEYTYPE,VALUETYPE>> aFilter)
default VALUETYPE	findFirstValue(Predicate<? super Map.Entry<KEYTYPE,VALUETYPE>> aFilter)
default Map<KEYTYPE,VALUETYPE>	getAsUnmodifiable()
default Map.Entry<KEYTYPE,VALUETYPE>	getFirstEntry() Get the first element of this map.
default KEYTYPE	getFirstKey() Get the first key of this map.
default VALUETYPE	getFirstValue() Get the first value of this map.
default ICommonsMap<KEYTYPE,VALUETYPE>	getSortedByKey(Comparator<? super KEYTYPE> aKeyComparator) Get the map sorted by its keys.
default ICommonsMap<KEYTYPE,VALUETYPE>	getSortedByValue(Comparator<? super VALUETYPE> aValueComparator) Get the map sorted by its values.
default ICommonsMap<VALUETYPE,KEYTYPE>	getSwappedKeyValues() Get a map where keys and values are exchanged.
default boolean	isNotEmpty()
default void	putIf(KEYTYPE aKey, VALUETYPE aValue, Predicate<VALUETYPE> aFilter)
default void	putIfNotNull(KEYTYPE aKey, VALUETYPE aValue)
default EChange	removeAll()
default void	setAll(Map<? extends KEYTYPE,? extends VALUETYPE> aValues) Clear and add all provided values.

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

Methods inherited from interface com.helger.commons.lang.ICloneable

getClone

Method Detail

copyOfKeySet

@Nonnull
 @ReturnsMutableCopy
default ICommonsSet<KEYTYPE> copyOfKeySet()

copyOfValues

@Nonnull
 @ReturnsMutableCopy
default ICommonsList<VALUETYPE> copyOfValues()

copyOfValues

@Nonnull
 @ReturnsMutableCopy
default ICommonsList<VALUETYPE> copyOfValues(@Nullable
                                                                             Predicate<? super VALUETYPE> aFilter)

copyOfValuesMapped

@Nonnull
 @ReturnsMutableCopy
default <DSTTYPE> ICommonsList<DSTTYPE> copyOfValuesMapped(@Nonnull
                                                                                           Function<? super VALUETYPE,? extends DSTTYPE> aMapper)

copyOfValuesMapped

@Nonnull
 @ReturnsMutableCopy
default <DSTTYPE> ICommonsList<DSTTYPE> copyOfValuesMapped(@Nullable
                                                                                           Predicate<? super VALUETYPE> aFilter,
                                                                                           @Nonnull
                                                                                           Function<? super VALUETYPE,? extends DSTTYPE> aMapper)

copyOfEntrySet

@Nonnull
 @ReturnsMutableCopy
default ICommonsSet<Map.Entry<KEYTYPE,VALUETYPE>> copyOfEntrySet()

isNotEmpty

default boolean isNotEmpty()

Returns:

true if the map is not empty, false otherwise.

getFirstEntry

@Nullable
default Map.Entry<KEYTYPE,VALUETYPE> getFirstEntry()

Get the first element of this map.

Returns:

null if the map is null or empty, the first element otherwise.

getFirstKey

@Nullable
default KEYTYPE getFirstKey()

Get the first key of this map.

Returns:

null if the map is null or empty, the first key otherwise.

getFirstValue

@Nullable
default VALUETYPE getFirstValue()

Get the first value of this map.

Returns:

null if the map is empty, the first value otherwise.

findFirstEntry

@Nullable
default Map.Entry<KEYTYPE,VALUETYPE> findFirstEntry(@Nullable
                                                               Predicate<? super Map.Entry<KEYTYPE,VALUETYPE>> aFilter)

findFirstKey

@Nullable
default KEYTYPE findFirstKey(@Nullable
                                        Predicate<? super Map.Entry<KEYTYPE,VALUETYPE>> aFilter)

findFirstValue

@Nullable
default VALUETYPE findFirstValue(@Nullable
                                            Predicate<? super Map.Entry<KEYTYPE,VALUETYPE>> aFilter)

getSortedByKey

@Nonnull
 @ReturnsMutableCopy
default ICommonsMap<KEYTYPE,VALUETYPE> getSortedByKey(@Nonnull
                                                                                      Comparator<? super KEYTYPE> aKeyComparator)

Get the map sorted by its keys. The comparison order is defined by the passed comparator object.

Parameters:

aKeyComparator - The comparator to be used. May not be null.

Returns:

the sorted map and never null.

getSortedByValue

@Nonnull
 @ReturnsMutableCopy
default ICommonsMap<KEYTYPE,VALUETYPE> getSortedByValue(@Nonnull
                                                                                        Comparator<? super VALUETYPE> aValueComparator)

Get the map sorted by its values. The comparison order is defined by the passed comparator object.

Parameters:

aValueComparator - The comparator to be used. May not be null.

Returns:

the sorted map and never null.

getSwappedKeyValues

@Nullable
 @ReturnsMutableCopy
default ICommonsMap<VALUETYPE,KEYTYPE> getSwappedKeyValues()

Get a map where keys and values are exchanged.

Returns:

The swapped hash map (unsorted!)

putIf

@Nonnull
default void putIf(@Nonnull
                             KEYTYPE aKey,
                             @Nullable
                             VALUETYPE aValue,
                             @Nonnull
                             Predicate<VALUETYPE> aFilter)

putIfNotNull

@Nonnull
default void putIfNotNull(@Nonnull
                                    KEYTYPE aKey,
                                    @Nullable
                                    VALUETYPE aValue)

addAll

default void addAll(@Nullable
                    Map<? extends KEYTYPE,? extends VALUETYPE> aValues)

Add all provided values.

Parameters:

aValues - The values to be added. May be null.

setAll

default void setAll(@Nullable
                    Map<? extends KEYTYPE,? extends VALUETYPE> aValues)

Clear and add all provided values.

Parameters:

aValues - The values to be added. May be null.

removeAll

@Nonnull
default EChange removeAll()

getAsUnmodifiable

@Nonnull
default Map<KEYTYPE,VALUETYPE> getAsUnmodifiable()