Package com.helger.commons.collection.impl

Class CommonsTreeMap<KEYTYPE,VALUETYPE>

java.lang.Object

java.util.AbstractMap<KEYTYPE,VALUETYPE>

java.util.TreeMap<KEYTYPE,VALUETYPE>

com.helger.commons.collection.impl.CommonsTreeMap<KEYTYPE,VALUETYPE>

Type Parameters:

KEYTYPE - Map key type

VALUETYPE - Map value type

All Implemented Interfaces:

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

public class CommonsTreeMap<KEYTYPE,VALUETYPE>
extends TreeMap<KEYTYPE,VALUETYPE>
implements ICommonsNavigableMap<KEYTYPE,VALUETYPE>

A special TreeMap implementation based on ICommonsNavigableMap.

Author:

Philip Helger

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor	Description
CommonsTreeMap()
CommonsTreeMap(COLLTYPE[] aValues, Function<? super COLLTYPE,? extends KEYTYPE> aKeyMapper, Function<? super COLLTYPE,? extends VALUETYPE> aValueMapper)
CommonsTreeMap(Collection<? extends COLLTYPE> aValues, Function<? super COLLTYPE,? extends KEYTYPE> aKeyMapper, Function<? super COLLTYPE,? extends VALUETYPE> aValueMapper)
CommonsTreeMap(Comparator<? super KEYTYPE> aComparator)
CommonsTreeMap(Map<? extends KEYTYPE,? extends VALUETYPE> aMap)
CommonsTreeMap(Map<? extends SRCKEYTYPE,? extends SRCVALUETYPE> aValues, Function<? super SRCKEYTYPE,? extends KEYTYPE> aKeyMapper, Function<? super SRCVALUETYPE,? extends VALUETYPE> aValueMapper)

Method Summary

Modifier and Type	Method	Description
<K, V> CommonsTreeMap<K,V>	createInstance()	Create a new CommonsTreeMap.
CommonsTreeMap<KEYTYPE,VALUETYPE>	getClone()

Methods inherited from class java.util.TreeMap

ceilingEntry, ceilingKey, clear, clone, comparator, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, forEach, get, headMap, headMap, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, merge, navigableKeySet, pollFirstEntry, pollLastEntry, put, putAll, putFirst, putIfAbsent, putLast, remove, replace, replace, replaceAll, size, subMap, subMap, tailMap, tailMap, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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 com.helger.commons.collection.impl.ICommonsNavigableMap

getAsUnmodifiable

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

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

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

Methods inherited from interface java.util.NavigableMap

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

Methods inherited from interface java.util.SequencedMap

sequencedEntrySet, sequencedKeySet, sequencedValues

Methods inherited from interface java.util.SortedMap

comparator, entrySet, firstKey, keySet, lastKey, putFirst, putLast, values

Constructor Details

CommonsTreeMap

public CommonsTreeMap()

CommonsTreeMap

public CommonsTreeMap(@Nullable
 Comparator<? super KEYTYPE> aComparator)

CommonsTreeMap

public CommonsTreeMap(@Nullable
 Map<? extends KEYTYPE,? extends VALUETYPE> aMap)

CommonsTreeMap

public CommonsTreeMap(@Nullable
 COLLTYPE[] aValues,
 @Nonnull
 Function<? super COLLTYPE,? extends KEYTYPE> aKeyMapper,
 @Nonnull
 Function<? super COLLTYPE,? extends VALUETYPE> aValueMapper)

CommonsTreeMap

public CommonsTreeMap(@Nullable
 Collection<? extends COLLTYPE> aValues,
 @Nonnull
 Function<? super COLLTYPE,? extends KEYTYPE> aKeyMapper,
 @Nonnull
 Function<? super COLLTYPE,? extends VALUETYPE> aValueMapper)

CommonsTreeMap

public CommonsTreeMap(@Nullable
 Map<? extends SRCKEYTYPE,? extends SRCVALUETYPE> aValues,
 @Nonnull
 Function<? super SRCKEYTYPE,? extends KEYTYPE> aKeyMapper,
 @Nonnull
 Function<? super SRCVALUETYPE,? extends VALUETYPE> aValueMapper)

Method Details

createInstance

@Nonnull
@ReturnsMutableCopy
public <K,
V> CommonsTreeMap<K,V> createInstance()

Description copied from interface: ICommonsSortedMap

Create a new CommonsTreeMap.

Specified by:

createInstance in interface ICommonsMap<KEYTYPE,VALUETYPE>

Specified by:

createInstance in interface ICommonsSortedMap<KEYTYPE,VALUETYPE>

Type Parameters:

K - Map key type

V - Map value type

Returns:

A new empty map. Never null.

getClone

@Nonnull
@ReturnsMutableCopy
public CommonsTreeMap<KEYTYPE,VALUETYPE> getClone()

Specified by:

getClone in interface ICloneable<KEYTYPE>

Specified by:

getClone in interface ICommonsNavigableMap<KEYTYPE,VALUETYPE>

Specified by:

getClone in interface ICommonsSortedMap<KEYTYPE,VALUETYPE>

Returns:

A 100% deep-copy of the implementing class.