speiger.src.collections.longs.maps.interfaces

Interface Long2ObjectNavigableMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Superinterfaces:

Long2ObjectFunction<V>, Long2ObjectMap<V>, Long2ObjectSortedMap<V>, 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>

All Known Implementing Classes:

Long2ObjectAVLTreeMap, Long2ObjectMaps.SynchronizedNavigableMap, Long2ObjectMaps.UnmodifyableNavigableMap, Long2ObjectRBTreeMap

public interface Long2ObjectNavigableMap<V>
extends Long2ObjectSortedMap<V>, java.util.NavigableMap<java.lang.Long,V>

A Type Specific Navigable Map interface with a couple helper methods

Nested Class Summary

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.
default Long2ObjectMap.Entry<V>	ceilingEntry(java.lang.Long key) Deprecated.
long	ceilingKey(long key) A Type Specific ceilingKey method to reduce boxing/unboxing.
default java.lang.Long	ceilingKey(java.lang.Long key) Deprecated.
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.
default Long2ObjectMap.Entry<V>	floorEntry(java.lang.Long key) Deprecated.
long	floorKey(long key) A Type Specific floorKey method to reduce boxing/unboxing.
default java.lang.Long	floorKey(java.lang.Long key) Deprecated.
long	getDefaultMaxValue() A Helper method to get the max value for SubMaps.
long	getDefaultMinValue() A Helper method to get the min value for SubMaps.
default Long2ObjectNavigableMap<V>	headMap(long toKey) A Type Specific HeadMap method to reduce boxing/unboxing
default Long2ObjectNavigableMap<V>	headMap(java.lang.Long toKey) Deprecated.
Long2ObjectNavigableMap<V>	headMap(long toKey, boolean inclusive) A Type Specific HeadMap method to reduce boxing/unboxing
default Long2ObjectNavigableMap<V>	headMap(java.lang.Long toKey, boolean inclusive) Deprecated.
Long2ObjectMap.Entry<V>	higherEntry(long key) A Type Specific higherEntry method to reduce boxing/unboxing.
default Long2ObjectMap.Entry<V>	higherEntry(java.lang.Long key) Deprecated.
long	higherKey(long key) A Type Specific higherKey method to reduce boxing/unboxing.
default java.lang.Long	higherKey(java.lang.Long key) Deprecated.
LongNavigableSet	keySet()
Long2ObjectMap.Entry<V>	lastEntry()
Long2ObjectMap.Entry<V>	lowerEntry(long key) A Type Specific lowerEntry method to reduce boxing/unboxing.
default Long2ObjectMap.Entry<V>	lowerEntry(java.lang.Long key) Deprecated.
long	lowerKey(long key) A Type Specific lowerKey method to reduce boxing/unboxing.
default java.lang.Long	lowerKey(java.lang.Long key) Deprecated.
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
default Long2ObjectNavigableMap<V>	subMap(java.lang.Long fromKey, boolean fromInclusive, java.lang.Long toKey, boolean toInclusive) Deprecated.
default Long2ObjectNavigableMap<V>	subMap(long fromKey, long toKey) A Type Specific SubMap method to reduce boxing/unboxing
default Long2ObjectNavigableMap<V>	subMap(java.lang.Long fromKey, java.lang.Long toKey) Deprecated.
default Long2ObjectNavigableMap<V>	synchronize() Creates a Wrapped NavigableMap that is Synchronized
default Long2ObjectNavigableMap<V>	synchronize(java.lang.Object mutex) Creates a Wrapped NavigableMap that is Synchronized
default Long2ObjectNavigableMap<V>	tailMap(long fromKey) A Type Specific TailMap method to reduce boxing/unboxing
default Long2ObjectNavigableMap<V>	tailMap(java.lang.Long fromKey) Deprecated.
Long2ObjectNavigableMap<V>	tailMap(long fromKey, boolean inclusive) A Type Specific TailMap method to reduce boxing/unboxing
default Long2ObjectNavigableMap<V>	tailMap(java.lang.Long fromKey, boolean inclusive) Deprecated.
default Long2ObjectNavigableMap<V>	unmodifiable() Creates a Wrapped NavigableMap that is 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

copy

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 Long2ObjectSortedMap<V>

Returns:

a Shallow Copy of the Map

descendingMap

Long2ObjectNavigableMap<V> descendingMap()

Specified by:

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

Returns:

a Type Specific desendingMap

navigableKeySet

LongNavigableSet navigableKeySet()

Specified by:

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

Returns:

a Type Specific Navigable Key Set

descendingKeySet

LongNavigableSet descendingKeySet()

Specified by:

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

Returns:

a Type Specific Desending Key Set

firstEntry

Long2ObjectMap.Entry<V> firstEntry()

Specified by:

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

Returns:

a Type Specific firstEntry

lastEntry

Long2ObjectMap.Entry<V> lastEntry()

Specified by:

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

Returns:

a Type Specific lastEntry

pollFirstEntry

Long2ObjectMap.Entry<V> pollFirstEntry()

Specified by:

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

Returns:

a Type Specific pollFirstEntry

pollLastEntry

Long2ObjectMap.Entry<V> pollLastEntry()

Specified by:

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

Returns:

a Type Specific pollLastEntry

keySet

LongNavigableSet keySet()

Specified by:

keySet in interface Long2ObjectMap<V>

Specified by:

keySet in interface Long2ObjectSortedMap<V>

Specified by:

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

Specified by:

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

Returns:

a Type Specific Navigable Key Set

synchronize

default Long2ObjectNavigableMap<V> synchronize()

Creates a Wrapped NavigableMap that is Synchronized

Specified by:

synchronize in interface Long2ObjectMap<V>

Specified by:

synchronize in interface Long2ObjectSortedMap<V>

Returns:

a new NavigableMap that is synchronized

See Also:

Long2ObjectMaps.synchronize(speiger.src.collections.longs.maps.interfaces.Long2ObjectMap<V>)

synchronize

default Long2ObjectNavigableMap<V> synchronize(java.lang.Object mutex)

Creates a Wrapped NavigableMap that is Synchronized

Specified by:

synchronize in interface Long2ObjectMap<V>

Specified by:

synchronize in interface Long2ObjectSortedMap<V>

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new NavigableMap Wrapper that is synchronized

See Also:

Long2ObjectMaps.synchronize(speiger.src.collections.longs.maps.interfaces.Long2ObjectMap<V>)

unmodifiable

default Long2ObjectNavigableMap<V> unmodifiable()

Creates a Wrapped NavigableMap that is unmodifiable

Specified by:

unmodifiable in interface Long2ObjectMap<V>

Specified by:

unmodifiable in interface Long2ObjectSortedMap<V>

Returns:

a new NavigableMap Wrapper that is unmodifiable

See Also:

Long2ObjectMaps.unmodifiable(speiger.src.collections.longs.maps.interfaces.Long2ObjectMap<V>)

subMap

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

A Type Specific SubMap method to reduce boxing/unboxing

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

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

A Type Specific HeadMap method to reduce boxing/unboxing

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

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

A Type Specific TailMap method to reduce boxing/unboxing

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

default 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 Long2ObjectSortedMap<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

default Long2ObjectNavigableMap<V> headMap(long toKey)

Description copied from interface: Long2ObjectSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Long2ObjectSortedMap<V>

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

default Long2ObjectNavigableMap<V> tailMap(long fromKey)

Description copied from interface: Long2ObjectSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Long2ObjectSortedMap<V>

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range

setDefaultMaxValue

void setDefaultMaxValue(long e)

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

Parameters:

e - the new max value

getDefaultMaxValue

long getDefaultMaxValue()

A Helper method to get the max value for SubMaps.

Returns:

the default max value.

setDefaultMinValue

void setDefaultMinValue(long e)

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

Parameters:

e - the new min value

getDefaultMinValue

long getDefaultMinValue()

A Helper method to get the min value for SubMaps.

Returns:

the default min value.

lowerKey

long lowerKey(long key)

A Type Specific lowerKey method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the greatest lower key that can be found

higherKey

long higherKey(long key)

A Type Specific higherKey method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the lowest higher key that can be found

floorKey

long floorKey(long key)

A Type Specific floorKey method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the greatest lower or equal key that can be found

ceilingKey

long ceilingKey(long key)

A Type Specific ceilingKey method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the lowest higher or equal key that can be found

lowerEntry

Long2ObjectMap.Entry<V> lowerEntry(long key)

A Type Specific lowerEntry method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the greatest lower entry that can be found, or null

higherEntry

Long2ObjectMap.Entry<V> higherEntry(long key)

A Type Specific higherEntry method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

the lowest higher entry that can be found, or null

floorEntry

Long2ObjectMap.Entry<V> floorEntry(long key)

A Type Specific floorEntry method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

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

ceilingEntry

Long2ObjectMap.Entry<V> ceilingEntry(long key)

A Type Specific ceilingEntry method to reduce boxing/unboxing.

Parameters:

key - that should be compared with.

Returns:

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

lowerKey

@Deprecated
default java.lang.Long lowerKey(java.lang.Long key)

Deprecated.

Specified by:

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

floorKey

@Deprecated
default java.lang.Long floorKey(java.lang.Long key)

Deprecated.

Specified by:

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

ceilingKey

@Deprecated
default java.lang.Long ceilingKey(java.lang.Long key)

Deprecated.

Specified by:

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

higherKey

@Deprecated
default java.lang.Long higherKey(java.lang.Long key)

Deprecated.

Specified by:

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

lowerEntry

@Deprecated
default Long2ObjectMap.Entry<V> lowerEntry(java.lang.Long key)

Deprecated.

Specified by:

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

floorEntry

@Deprecated
default Long2ObjectMap.Entry<V> floorEntry(java.lang.Long key)

Deprecated.

Specified by:

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

ceilingEntry

@Deprecated
default Long2ObjectMap.Entry<V> ceilingEntry(java.lang.Long key)

Deprecated.

Specified by:

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

higherEntry

@Deprecated
default Long2ObjectMap.Entry<V> higherEntry(java.lang.Long key)

Deprecated.

Specified by:

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

subMap

@Deprecated
default Long2ObjectNavigableMap<V> subMap(java.lang.Long fromKey,
                                                       boolean fromInclusive,
                                                       java.lang.Long toKey,
                                                       boolean toInclusive)

Deprecated.

Specified by:

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

headMap

@Deprecated
default Long2ObjectNavigableMap<V> headMap(java.lang.Long toKey,
                                                        boolean inclusive)

Deprecated.

Specified by:

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

tailMap

@Deprecated
default Long2ObjectNavigableMap<V> tailMap(java.lang.Long fromKey,
                                                        boolean inclusive)

Deprecated.

Specified by:

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

subMap

@Deprecated
default Long2ObjectNavigableMap<V> subMap(java.lang.Long fromKey,
                                                       java.lang.Long toKey)

Deprecated.

Specified by:

subMap in interface Long2ObjectSortedMap<V>

Specified by:

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

Specified by:

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

headMap

@Deprecated
default Long2ObjectNavigableMap<V> headMap(java.lang.Long toKey)

Deprecated.

Specified by:

headMap in interface Long2ObjectSortedMap<V>

Specified by:

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

Specified by:

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

tailMap

@Deprecated
default Long2ObjectNavigableMap<V> tailMap(java.lang.Long fromKey)

Deprecated.

Specified by:

tailMap in interface Long2ObjectSortedMap<V>

Specified by:

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

Specified by:

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