com.helger.commons.collection.impl

Interface ICommonsOrderedMap<KEYTYPE,VALUETYPE>

Type Parameters:

KEYTYPE - May key type

VALUETYPE - Map value type

All Superinterfaces:

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

All Known Implementing Classes:

AttributeContainer, AttributeContainerAny, CommonsLinkedHashMap, LoggingLRUMap, LRUMap, NonBlockingProperties, StringMap

public interface ICommonsOrderedMap<KEYTYPE,VALUETYPE>
extends ICommonsMap<KEYTYPE,VALUETYPE>

A special Map interface for ordered maps (like CommonsLinkedHashMap) based on ICommonsMap.

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
default ICommonsOrderedSet<Map.Entry<KEYTYPE,VALUETYPE>>	copyOfEntrySet()
default ICommonsOrderedSet<KEYTYPE>	copyOfKeySet()
default ICommonsOrderedSet<KEYTYPE>	copyOfKeySet(Predicate<? super KEYTYPE> aFilter) Create a copy of all values matching the passed filter.
default <K,V> ICommonsOrderedMap<K,V>	createInstance() Create a new empty map.
ICommonsOrderedMap<KEYTYPE,VALUETYPE>	getClone()
default KEYTYPE	getLastKey()
default KEYTYPE	getLastKey(KEYTYPE aDefault)
default VALUETYPE	getLastValue()
default VALUETYPE	getLastValue(VALUETYPE aDefault)

Methods inherited from interface com.helger.commons.collection.impl.ICommonsMap

addAll, containsAnyEntry, containsAnyKey, containsAnyValue, copyOfValues, copyOfValues, copyOfValuesMapped, copyOfValuesMapped, findFirstEntry, findFirstKey, findFirstValue, forEach, forEachKey, forEachKey, forEachValue, forEachValue, getAsUnmodifiable, getFirstEntry, getFirstEntry, getFirstKey, getFirstKey, getFirstValue, getFirstValue, getSortedByKey, getSortedByValue, getSwappedKeyValues, isNotEmpty, put, putAll, putAll, putAllMapped, putAllMapped, putAllMapped, putIf, putIfNotNull, removeAll, removeIf, removeIfKey, removeIfValue, removeObject, setAll

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

createInstance

@Nonnull
 @ReturnsMutableCopy
default <K,V> ICommonsOrderedMap<K,V> createInstance()

Description copied from interface: ICommonsMap

Create a new empty map. Overwrite this if you don't want to use CommonsHashMap.

Specified by:

createInstance in interface ICommonsMap<KEYTYPE,VALUETYPE>

Type Parameters:

K - Map key type

V - Map value type

Returns:

A new empty map. Never null.

copyOfKeySet

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

Specified by:

copyOfKeySet in interface ICommonsMap<KEYTYPE,VALUETYPE>

Returns:

A new non-null set with all keys.

See Also:

Map.keySet(), ICommonsMap.copyOfKeySet(Predicate)

copyOfKeySet

@Nonnull
 @ReturnsMutableCopy
default ICommonsOrderedSet<KEYTYPE> copyOfKeySet(@Nullable
                                                                                 Predicate<? super KEYTYPE> aFilter)

Description copied from interface: ICommonsMap

Create a copy of all values matching the passed filter.

Specified by:

copyOfKeySet in interface ICommonsMap<KEYTYPE,VALUETYPE>

Parameters:

aFilter - The filter to be applied. May be null.

Returns:

A new non-null set with all matching keys.

See Also:

Map.keySet(), ICommonsMap.copyOfKeySet()

copyOfEntrySet

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

Specified by:

copyOfEntrySet in interface ICommonsMap<KEYTYPE,VALUETYPE>

Returns:

A new non-null copy of the entry set.

getLastKey

@Nullable
default KEYTYPE getLastKey()

getLastKey

@Nullable
default KEYTYPE getLastKey(@Nullable
                                      KEYTYPE aDefault)

getLastValue

@Nullable
default VALUETYPE getLastValue()

getLastValue

@Nullable
default VALUETYPE getLastValue(@Nullable
                                          VALUETYPE aDefault)

getClone

@Nonnull
 @ReturnsMutableCopy
ICommonsOrderedMap<KEYTYPE,VALUETYPE> getClone()

Specified by:

getClone in interface ICloneable<ICommonsMap<KEYTYPE,VALUETYPE>>

Returns:

A 100% deep-copy of the implementing class.