com.helger.commons.collection.ext

Interface ICommonsSortedMap<KEYTYPE,VALUETYPE>

All Superinterfaces:

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

All Known Subinterfaces:

ICommonsNavigableMap<KEYTYPE,VALUETYPE>

All Known Implementing Classes:

AbstractMultiTreeMap, AbstractMultiTreeMapListBased, AbstractMultiTreeMapMapBased, AbstractMultiTreeMapSetBased, CommonsTreeMap, MultiTreeMapArrayListBased, MultiTreeMapHashMapBased, MultiTreeMapHashSetBased, MultiTreeMapLinkedHashMapBased, MultiTreeMapLinkedHashSetBased, MultiTreeMapTreeMapBased, MultiTreeMapTreeSetBased, MultiTreeMapVectorBased, MultiTreeMapWeakHashMapBased, NonBlockingProperties

public interface ICommonsSortedMap<KEYTYPE,VALUETYPE>
extends SortedMap<KEYTYPE,VALUETYPE>, ICommonsMap<KEYTYPE,VALUETYPE>

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 SortedMap<KEYTYPE,VALUETYPE>	getAsUnmodifiable()
ICommonsSortedMap<KEYTYPE,VALUETYPE>	getClone()
default KEYTYPE	getFirstKey() Get the first key of this map.
default VALUETYPE	getFirstValue() Get the first value of this map.
default KEYTYPE	getLastKey()
default VALUETYPE	getLastValue()

Methods inherited from interface java.util.SortedMap

comparator, entrySet, firstKey, headMap, keySet, lastKey, subMap, tailMap, values

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

addAll, copyOfEntrySet, copyOfKeySet, copyOfValues, copyOfValues, copyOfValuesMapped, copyOfValuesMapped, findFirstEntry, findFirstKey, findFirstValue, getFirstEntry, getSortedByKey, getSortedByValue, getSwappedKeyValues, isNotEmpty, putIf, putIfNotNull, removeAll, setAll

Methods inherited from interface java.util.Map

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

Method Detail

getFirstKey

@Nullable
default KEYTYPE getFirstKey()

Description copied from interface: ICommonsMap

Get the first key of this map.

Specified by:

getFirstKey in interface ICommonsMap<KEYTYPE,VALUETYPE>

Returns:

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

getFirstValue

@Nullable
default VALUETYPE getFirstValue()

Description copied from interface: ICommonsMap

Get the first value of this map.

Specified by:

getFirstValue in interface ICommonsMap<KEYTYPE,VALUETYPE>

Returns:

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

getLastKey

@Nullable
default KEYTYPE getLastKey()

getLastValue

@Nullable
default VALUETYPE getLastValue()

getAsUnmodifiable

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

Specified by:

getAsUnmodifiable in interface ICommonsMap<KEYTYPE,VALUETYPE>

getClone

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

Specified by:

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

Returns:

A 100% deep-copy of the implementing class.