com.helger.commons.collection.impl

Interface ICommonsNavigableMap<KEYTYPE,VALUETYPE>

Type Parameters:

KEYTYPE - Map key type

VALUETYPE - Map value type

All Superinterfaces:

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

All Known Implementing Classes:

CommonsTreeMap

public interface ICommonsNavigableMap<KEYTYPE,VALUETYPE>
extends NavigableMap<KEYTYPE,VALUETYPE>, ICommonsSortedMap<KEYTYPE,VALUETYPE>

A special NavigableMap interface based on ICommonsSortedMap.

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 NavigableMap<KEYTYPE,VALUETYPE>	getAsUnmodifiable()
ICommonsNavigableMap<KEYTYPE,VALUETYPE>	getClone()

Methods inherited from interface java.util.NavigableMap

ceilingEntry, ceilingKey, descendingKeySet, descendingMap, firstEntry, floorEntry, floorKey, headMap, headMap, higherEntry, higherKey, lastEntry, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, subMap, subMap, tailMap, tailMap

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

copyOfEntrySet, copyOfKeySet, copyOfKeySet, createInstance, getFirstKey, getFirstValue, getLastKey, getLastKey, getLastValue, getLastValue

Methods inherited from interface java.util.SortedMap

comparator, entrySet, firstKey, keySet, lastKey, 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

getAsUnmodifiable

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

Specified by:

getAsUnmodifiable in interface ICommonsMap<KEYTYPE,VALUETYPE>

Specified by:

getAsUnmodifiable in interface ICommonsSortedMap<KEYTYPE,VALUETYPE>

Returns:

An unmodifiable version of this map. Never null.

See Also:

Collections

getClone

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

Specified by:

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

Specified by:

getClone in interface ICommonsSortedMap<KEYTYPE,VALUETYPE>

Returns:

A 100% deep-copy of the implementing class.