speiger.src.collections.longs.utils.maps

Class Long2ObjectMaps.UnmodifyableNavigableMap<V>

java.lang.Object

java.util.AbstractMap<java.lang.Long,V>

speiger.src.collections.longs.maps.abstracts.AbstractLong2ObjectMap<V>

speiger.src.collections.longs.utils.maps.Long2ObjectMaps.UnmodifyableMap<V>

speiger.src.collections.longs.utils.maps.Long2ObjectMaps.UnmodifyableSortedMap<V>

speiger.src.collections.longs.utils.maps.Long2ObjectMaps.UnmodifyableNavigableMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.LongFunction<V>, java.util.Map<java.lang.Long,V>, java.util.NavigableMap<java.lang.Long,V>, java.util.SortedMap<java.lang.Long,V>, Long2ObjectFunction<V>, Long2ObjectMap<V>, Long2ObjectNavigableMap<V>, Long2ObjectSortedMap<V>

Enclosing class:

Long2ObjectMaps

public static class Long2ObjectMaps.UnmodifyableNavigableMap<V>
extends Long2ObjectMaps.UnmodifyableSortedMap<V>
implements Long2ObjectNavigableMap<V>

The Unmodifyable Navigable Map implementation that is sued for the unmodifyableMap function

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.longs.maps.abstracts.AbstractLong2ObjectMap

AbstractLong2ObjectMap.BasicEntry<V>

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

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

Nested classes/interfaces inherited from interface speiger.src.collections.longs.maps.interfaces.Long2ObjectSortedMap

Long2ObjectSortedMap.FastSortedSet<V>

Nested classes/interfaces inherited from interface speiger.src.collections.longs.maps.interfaces.Long2ObjectMap

Long2ObjectMap.BuilderCache<V>, Long2ObjectMap.Entry<V>, Long2ObjectMap.FastEntrySet<V>, Long2ObjectMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
Long2ObjectMap.Entry<V>	ceilingEntry(long key) A Type Specific ceilingEntry method to reduce boxing/unboxing.
long	ceilingKey(long key) A Type Specific ceilingKey method to reduce boxing/unboxing.
Long2ObjectNavigableMap<V>	copy() A Function that does a shallow clone of the Map itself.
LongNavigableSet	descendingKeySet()
Long2ObjectNavigableMap<V>	descendingMap()
Long2ObjectMap.Entry<V>	firstEntry()
Long2ObjectMap.Entry<V>	floorEntry(long key) A Type Specific floorEntry method to reduce boxing/unboxing.
long	floorKey(long key) A Type Specific floorKey method to reduce boxing/unboxing.
long	getDefaultMaxValue() A Helper method to get the max value for SubMaps.
long	getDefaultMinValue() A Helper method to get the min value for SubMaps.
Long2ObjectNavigableMap<V>	headMap(long toKey) A Type Specific HeadMap method to reduce boxing/unboxing
Long2ObjectNavigableMap<V>	headMap(long toKey, boolean inclusive) A Type Specific HeadMap method to reduce boxing/unboxing
Long2ObjectMap.Entry<V>	higherEntry(long key) A Type Specific higherEntry method to reduce boxing/unboxing.
long	higherKey(long key) A Type Specific higherKey method to reduce boxing/unboxing.
LongNavigableSet	keySet()
Long2ObjectMap.Entry<V>	lastEntry()
Long2ObjectMap.Entry<V>	lowerEntry(long key) A Type Specific lowerEntry method to reduce boxing/unboxing.
long	lowerKey(long key) A Type Specific lowerKey method to reduce boxing/unboxing.
LongNavigableSet	navigableKeySet()
Long2ObjectMap.Entry<V>	pollFirstEntry()
Long2ObjectMap.Entry<V>	pollLastEntry()
void	setDefaultMaxValue(long e) A Helper method to set the max value for SubMaps.
void	setDefaultMinValue(long e) A Helper method to set the min value for SubMaps.
Long2ObjectNavigableMap<V>	subMap(long fromKey, boolean fromInclusive, long toKey, boolean toInclusive) A Type Specific SubMap method to reduce boxing/unboxing
Long2ObjectNavigableMap<V>	subMap(long fromKey, long toKey) A Type Specific SubMap method to reduce boxing/unboxing
Long2ObjectNavigableMap<V>	tailMap(long fromKey) A Type Specific TailMap method to reduce boxing/unboxing
Long2ObjectNavigableMap<V>	tailMap(long fromKey, boolean inclusive) A Type Specific TailMap method to reduce boxing/unboxing

Methods inherited from class speiger.src.collections.longs.utils.maps.Long2ObjectMaps.UnmodifyableSortedMap

comparator, firstLongKey, firstValue, lastLongKey, lastValue, pollFirstLongKey, pollLastLongKey

Methods inherited from class speiger.src.collections.longs.utils.maps.Long2ObjectMaps.UnmodifyableMap

clear, compute, computeIfAbsent, computeIfPresent, get, getOrDefault, long2ObjectEntrySet, merge, mergeAll, put, putIfAbsent, remove, remove, removeOrDefault, replaceObjects, replaceObjects, supplyIfAbsent, values

Methods inherited from class speiger.src.collections.longs.maps.abstracts.AbstractLong2ObjectMap

containsKey, containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, remove, replace, replace, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap

containsKey, isEmpty, size, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.longs.maps.interfaces.Long2ObjectNavigableMap

ceilingEntry, ceilingKey, floorEntry, floorKey, headMap, headMap, higherEntry, higherKey, lowerEntry, lowerKey, subMap, subMap, synchronize, synchronize, tailMap, tailMap, unmodifiable

Methods inherited from interface speiger.src.collections.longs.maps.interfaces.Long2ObjectSortedMap

comparator, firstKey, firstLongKey, firstValue, lastKey, lastLongKey, lastValue, pollFirstLongKey, pollLastLongKey, values

Methods inherited from interface speiger.src.collections.longs.maps.interfaces.Long2ObjectMap

builder, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, long2ObjectEntrySet, merge, merge, mergeAll, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue, supplyIfAbsent

Methods inherited from interface speiger.src.collections.longs.functions.function.Long2ObjectFunction

apply

Methods inherited from interface java.util.SortedMap

entrySet

Methods inherited from interface java.util.Map

clear, containsValue, equals, hashCode, isEmpty, putAll, size

Method Detail

descendingMap

public Long2ObjectNavigableMap<V> descendingMap()

Specified by:

descendingMap in interface java.util.NavigableMap<java.lang.Long,V>

Specified by:

descendingMap in interface Long2ObjectNavigableMap<V>

Returns:

a Type Specific desendingMap

navigableKeySet

public LongNavigableSet navigableKeySet()

Specified by:

navigableKeySet in interface java.util.NavigableMap<java.lang.Long,V>

Specified by:

navigableKeySet in interface Long2ObjectNavigableMap<V>

Returns:

a Type Specific Navigable Key Set

keySet

public LongNavigableSet keySet()

Specified by:

keySet in interface java.util.Map<java.lang.Long,V>

Specified by:

keySet in interface java.util.SortedMap<java.lang.Long,V>

Specified by:

keySet in interface Long2ObjectMap<V>

Specified by:

keySet in interface Long2ObjectNavigableMap<V>

Specified by:

keySet in interface Long2ObjectSortedMap<V>

Overrides:

keySet in class Long2ObjectMaps.UnmodifyableSortedMap<V>

Returns:

a Type Specific Navigable Key Set

descendingKeySet

public LongNavigableSet descendingKeySet()

Specified by:

descendingKeySet in interface java.util.NavigableMap<java.lang.Long,V>

Specified by:

descendingKeySet in interface Long2ObjectNavigableMap<V>

Returns:

a Type Specific Desending Key Set

firstEntry

public Long2ObjectMap.Entry<V> firstEntry()

Specified by:

firstEntry in interface java.util.NavigableMap<java.lang.Long,V>

Specified by:

firstEntry in interface Long2ObjectNavigableMap<V>

Returns:

a Type Specific firstEntry

lastEntry

public Long2ObjectMap.Entry<V> lastEntry()

Specified by:

lastEntry in interface java.util.NavigableMap<java.lang.Long,V>

Specified by:

lastEntry in interface Long2ObjectNavigableMap<V>

Returns:

a Type Specific lastEntry

pollFirstEntry

public Long2ObjectMap.Entry<V> pollFirstEntry()

Specified by:

pollFirstEntry in interface java.util.NavigableMap<java.lang.Long,V>

Specified by:

pollFirstEntry in interface Long2ObjectNavigableMap<V>

Returns:

a Type Specific pollFirstEntry

pollLastEntry

public Long2ObjectMap.Entry<V> pollLastEntry()

Specified by:

pollLastEntry in interface java.util.NavigableMap<java.lang.Long,V>

Specified by:

pollLastEntry in interface Long2ObjectNavigableMap<V>

Returns:

a Type Specific pollLastEntry

subMap

public Long2ObjectNavigableMap<V> subMap(long fromKey,
                                         boolean fromInclusive,
                                         long toKey,
                                         boolean toInclusive)

Description copied from interface: Long2ObjectNavigableMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Long2ObjectNavigableMap<V>

Parameters:

fromKey - where the submap should start

fromInclusive - if the fromKey is inclusive or not

toKey - where the subMap should end

toInclusive - if the toKey is inclusive or not

Returns:

a SubMap that is within the range of the desired range

headMap

public Long2ObjectNavigableMap<V> headMap(long toKey,
                                          boolean inclusive)

Description copied from interface: Long2ObjectNavigableMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Long2ObjectNavigableMap<V>

Parameters:

toKey - where the HeadMap should end

inclusive - if the toKey is inclusive or not

Returns:

a HeadMap that is within the range of the desired range

tailMap

public Long2ObjectNavigableMap<V> tailMap(long fromKey,
                                          boolean inclusive)

Description copied from interface: Long2ObjectNavigableMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Long2ObjectNavigableMap<V>

Parameters:

fromKey - where the TailMap should start

inclusive - if the fromKey is inclusive or not

Returns:

a TailMap that is within the range of the desired range

subMap

public Long2ObjectNavigableMap<V> subMap(long fromKey,
                                         long toKey)

Description copied from interface: Long2ObjectSortedMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Long2ObjectNavigableMap<V>

Specified by:

subMap in interface Long2ObjectSortedMap<V>

Overrides:

subMap in class Long2ObjectMaps.UnmodifyableSortedMap<V>

Parameters:

fromKey - where the submap should start

toKey - where the subMap should end

Returns:

a SubMap that is within the range of the desired range

headMap

public Long2ObjectNavigableMap<V> headMap(long toKey)

Description copied from interface: Long2ObjectSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Long2ObjectNavigableMap<V>

Specified by:

headMap in interface Long2ObjectSortedMap<V>

Overrides:

headMap in class Long2ObjectMaps.UnmodifyableSortedMap<V>

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

public Long2ObjectNavigableMap<V> tailMap(long fromKey)

Description copied from interface: Long2ObjectSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Long2ObjectNavigableMap<V>

Specified by:

tailMap in interface Long2ObjectSortedMap<V>

Overrides:

tailMap in class Long2ObjectMaps.UnmodifyableSortedMap<V>

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range

setDefaultMaxValue

public void setDefaultMaxValue(long e)

Description copied from interface: Long2ObjectNavigableMap

A Helper method to set the max value for SubMaps. (Default: long.MIN_VALUE)

Specified by:

setDefaultMaxValue in interface Long2ObjectNavigableMap<V>

Parameters:

e - the new max value

getDefaultMaxValue

public long getDefaultMaxValue()

Description copied from interface: Long2ObjectNavigableMap

A Helper method to get the max value for SubMaps.

Specified by:

getDefaultMaxValue in interface Long2ObjectNavigableMap<V>

Returns:

the default max value.

setDefaultMinValue

public void setDefaultMinValue(long e)

Description copied from interface: Long2ObjectNavigableMap

A Helper method to set the min value for SubMaps. (Default: long.MAX_VALUE)

Specified by:

setDefaultMinValue in interface Long2ObjectNavigableMap<V>

Parameters:

e - the new min value

getDefaultMinValue

public long getDefaultMinValue()

Description copied from interface: Long2ObjectNavigableMap

A Helper method to get the min value for SubMaps.

Specified by:

getDefaultMinValue in interface Long2ObjectNavigableMap<V>

Returns:

the default min value.

lowerKey

public long lowerKey(long key)

Description copied from interface: Long2ObjectNavigableMap

A Type Specific lowerKey method to reduce boxing/unboxing.

Specified by:

lowerKey in interface Long2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the greatest lower key that can be found

higherKey

public long higherKey(long key)

Description copied from interface: Long2ObjectNavigableMap

A Type Specific higherKey method to reduce boxing/unboxing.

Specified by:

higherKey in interface Long2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the lowest higher key that can be found

floorKey

public long floorKey(long key)

Description copied from interface: Long2ObjectNavigableMap

A Type Specific floorKey method to reduce boxing/unboxing.

Specified by:

floorKey in interface Long2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the greatest lower or equal key that can be found

ceilingKey

public long ceilingKey(long key)

Description copied from interface: Long2ObjectNavigableMap

A Type Specific ceilingKey method to reduce boxing/unboxing.

Specified by:

ceilingKey in interface Long2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the lowest higher or equal key that can be found

lowerEntry

public Long2ObjectMap.Entry<V> lowerEntry(long key)

Description copied from interface: Long2ObjectNavigableMap

A Type Specific lowerEntry method to reduce boxing/unboxing.

Specified by:

lowerEntry in interface Long2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the greatest lower entry that can be found, or null

higherEntry

public Long2ObjectMap.Entry<V> higherEntry(long key)

Description copied from interface: Long2ObjectNavigableMap

A Type Specific higherEntry method to reduce boxing/unboxing.

Specified by:

higherEntry in interface Long2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the lowest higher entry that can be found, or null

floorEntry

public Long2ObjectMap.Entry<V> floorEntry(long key)

Description copied from interface: Long2ObjectNavigableMap

A Type Specific floorEntry method to reduce boxing/unboxing.

Specified by:

floorEntry in interface Long2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the greatest lower or equal entry that can be found, or null

ceilingEntry

public Long2ObjectMap.Entry<V> ceilingEntry(long key)

Description copied from interface: Long2ObjectNavigableMap

A Type Specific ceilingEntry method to reduce boxing/unboxing.

Specified by:

ceilingEntry in interface Long2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the lowest higher or equal entry that can be found, or null

copy

public Long2ObjectNavigableMap<V> copy()

Description copied from interface: Long2ObjectMap

A Function that does a shallow clone of the Map itself. This function is more optimized then a copy constructor since the Map does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk

Specified by:

copy in interface Long2ObjectMap<V>

Specified by:

copy in interface Long2ObjectNavigableMap<V>

Specified by:

copy in interface Long2ObjectSortedMap<V>

Overrides:

copy in class Long2ObjectMaps.UnmodifyableSortedMap<V>

Returns:

a Shallow Copy of the Map