com.helger.commons.collection.impl

Interface ICommonsSortedMap<KEYTYPE,VALUETYPE>

Type Parameters:

KEYTYPE - Map key type

VALUETYPE - Map value type

All Superinterfaces:

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

All Known Subinterfaces:

ICommonsNavigableMap<KEYTYPE,VALUETYPE>

All Known Implementing Classes:

CommonsTreeMap

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

A special SortedMap based interface with extended functionality 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 ICommonsSortedSet<Map.Entry<KEYTYPE,VALUETYPE>>	copyOfEntrySet()
default ICommonsSortedSet<KEYTYPE>	copyOfKeySet()
default ICommonsSortedSet<KEYTYPE>	copyOfKeySet(Predicate<? super KEYTYPE> aFilter) Create a copy of all values matching the passed filter.
default <K,V> ICommonsSortedMap<K,V>	createInstance() Create a new CommonsTreeMap.
default SortedMap<KEYTYPE,VALUETYPE>	getAsUnmodifiable()
ICommonsSortedMap<KEYTYPE,VALUETYPE>	getClone()
default KEYTYPE	getFirstKey(KEYTYPE aDefault) Get the first key of this map or the provided default value.
default VALUETYPE	getFirstValue(VALUETYPE aDefault) Get the first value of this map or the provided default value.
default KEYTYPE	getLastKey()
default KEYTYPE	getLastKey(KEYTYPE aDefault)
default VALUETYPE	getLastValue()
default VALUETYPE	getLastValue(VALUETYPE aDefault)

Methods inherited from interface java.util.SortedMap

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

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, getFirstEntry, getFirstEntry, getFirstKey, 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, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size

Method Detail

createInstance

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

Create a new CommonsTreeMap.

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 ICommonsSortedSet<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 ICommonsSortedSet<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 ICommonsSortedSet<Map.Entry<KEYTYPE,VALUETYPE>> copyOfEntrySet()

Specified by:

copyOfEntrySet in interface ICommonsMap<KEYTYPE,VALUETYPE>

Returns:

A new non-null copy of the entry set.

getFirstKey

@Nullable
default KEYTYPE getFirstKey(@Nullable
                                       KEYTYPE aDefault)

Description copied from interface: ICommonsMap

Get the first key of this map or the provided default value.

Specified by:

getFirstKey in interface ICommonsMap<KEYTYPE,VALUETYPE>

Parameters:

aDefault - The default value to be returned if this map is empty. May be null.

Returns:

The provided default value if the map is empty, the first key otherwise.

See Also:

ICommonsMap.getFirstKey()

getFirstValue

@Nullable
default VALUETYPE getFirstValue(@Nullable
                                           VALUETYPE aDefault)

Description copied from interface: ICommonsMap

Get the first value of this map or the provided default value.

Specified by:

getFirstValue in interface ICommonsMap<KEYTYPE,VALUETYPE>

Parameters:

aDefault - The default value to be returned if this map is empty. May be null.

Returns:

The provided default value if the map is empty, the first value otherwise.

See Also:

ICommonsMap.getFirstValue()

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)

getAsUnmodifiable

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

Specified by:

getAsUnmodifiable in interface ICommonsMap<KEYTYPE,VALUETYPE>

Returns:

An unmodifiable version of this map. Never null.

See Also:

Collections

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.