speiger.src.collections.doubles.maps.interfaces

Interface Double2ObjectNavigableMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Superinterfaces:

Double2ObjectFunction<V>, Double2ObjectMap<V>, Double2ObjectSortedMap<V>, java.util.function.DoubleFunction<V>, java.util.Map<java.lang.Double,V>, java.util.NavigableMap<java.lang.Double,V>, java.util.SortedMap<java.lang.Double,V>

All Known Implementing Classes:

Double2ObjectAVLTreeMap, Double2ObjectMaps.SynchronizedNavigableMap, Double2ObjectMaps.UnmodifyableNavigableMap, Double2ObjectRBTreeMap

public interface Double2ObjectNavigableMap<V>
extends Double2ObjectSortedMap<V>, java.util.NavigableMap<java.lang.Double,V>

A Type Specific Navigable Map interface with a couple helper methods

Nested Class Summary

Nested classes/interfaces inherited from interface speiger.src.collections.doubles.maps.interfaces.Double2ObjectSortedMap

Double2ObjectSortedMap.FastSortedSet<V>

Nested classes/interfaces inherited from interface speiger.src.collections.doubles.maps.interfaces.Double2ObjectMap

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

Method Summary

Modifier and Type	Method and Description
Double2ObjectMap.Entry<V>	ceilingEntry(double key) A Type Specific ceilingEntry method to reduce boxing/unboxing.
default Double2ObjectMap.Entry<V>	ceilingEntry(java.lang.Double key) Deprecated.
double	ceilingKey(double key) A Type Specific ceilingKey method to reduce boxing/unboxing.
default java.lang.Double	ceilingKey(java.lang.Double key) Deprecated.
Double2ObjectNavigableMap<V>	copy() A Function that does a shallow clone of the Map itself.
DoubleNavigableSet	descendingKeySet()
Double2ObjectNavigableMap<V>	descendingMap()
Double2ObjectMap.Entry<V>	firstEntry()
Double2ObjectMap.Entry<V>	floorEntry(double key) A Type Specific floorEntry method to reduce boxing/unboxing.
default Double2ObjectMap.Entry<V>	floorEntry(java.lang.Double key) Deprecated.
double	floorKey(double key) A Type Specific floorKey method to reduce boxing/unboxing.
default java.lang.Double	floorKey(java.lang.Double key) Deprecated.
double	getDefaultMaxValue() A Helper method to get the max value for SubMaps.
double	getDefaultMinValue() A Helper method to get the min value for SubMaps.
default Double2ObjectNavigableMap<V>	headMap(double toKey) A Type Specific HeadMap method to reduce boxing/unboxing
default Double2ObjectNavigableMap<V>	headMap(java.lang.Double toKey) Deprecated.
Double2ObjectNavigableMap<V>	headMap(double toKey, boolean inclusive) A Type Specific HeadMap method to reduce boxing/unboxing
default Double2ObjectNavigableMap<V>	headMap(java.lang.Double toKey, boolean inclusive) Deprecated.
Double2ObjectMap.Entry<V>	higherEntry(double key) A Type Specific higherEntry method to reduce boxing/unboxing.
default Double2ObjectMap.Entry<V>	higherEntry(java.lang.Double key) Deprecated.
double	higherKey(double key) A Type Specific higherKey method to reduce boxing/unboxing.
default java.lang.Double	higherKey(java.lang.Double key) Deprecated.
DoubleNavigableSet	keySet()
Double2ObjectMap.Entry<V>	lastEntry()
Double2ObjectMap.Entry<V>	lowerEntry(double key) A Type Specific lowerEntry method to reduce boxing/unboxing.
default Double2ObjectMap.Entry<V>	lowerEntry(java.lang.Double key) Deprecated.
double	lowerKey(double key) A Type Specific lowerKey method to reduce boxing/unboxing.
default java.lang.Double	lowerKey(java.lang.Double key) Deprecated.
DoubleNavigableSet	navigableKeySet()
Double2ObjectMap.Entry<V>	pollFirstEntry()
Double2ObjectMap.Entry<V>	pollLastEntry()
void	setDefaultMaxValue(double e) A Helper method to set the max value for SubMaps.
void	setDefaultMinValue(double e) A Helper method to set the min value for SubMaps.
Double2ObjectNavigableMap<V>	subMap(double fromKey, boolean fromInclusive, double toKey, boolean toInclusive) A Type Specific SubMap method to reduce boxing/unboxing
default Double2ObjectNavigableMap<V>	subMap(java.lang.Double fromKey, boolean fromInclusive, java.lang.Double toKey, boolean toInclusive) Deprecated.
default Double2ObjectNavigableMap<V>	subMap(double fromKey, double toKey) A Type Specific SubMap method to reduce boxing/unboxing
default Double2ObjectNavigableMap<V>	subMap(java.lang.Double fromKey, java.lang.Double toKey) Deprecated.
default Double2ObjectNavigableMap<V>	synchronize() Creates a Wrapped NavigableMap that is Synchronized
default Double2ObjectNavigableMap<V>	synchronize(java.lang.Object mutex) Creates a Wrapped NavigableMap that is Synchronized
default Double2ObjectNavigableMap<V>	tailMap(double fromKey) A Type Specific TailMap method to reduce boxing/unboxing
default Double2ObjectNavigableMap<V>	tailMap(java.lang.Double fromKey) Deprecated.
Double2ObjectNavigableMap<V>	tailMap(double fromKey, boolean inclusive) A Type Specific TailMap method to reduce boxing/unboxing
default Double2ObjectNavigableMap<V>	tailMap(java.lang.Double fromKey, boolean inclusive) Deprecated.
default Double2ObjectNavigableMap<V>	unmodifiable() Creates a Wrapped NavigableMap that is unmodifiable

Methods inherited from interface speiger.src.collections.doubles.maps.interfaces.Double2ObjectSortedMap

comparator, firstDoubleKey, firstKey, firstValue, lastDoubleKey, lastKey, lastValue, pollFirstDoubleKey, pollLastDoubleKey, values

Methods inherited from interface speiger.src.collections.doubles.maps.interfaces.Double2ObjectMap

builder, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, double2ObjectEntrySet, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, 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.doubles.functions.function.Double2ObjectFunction

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

Double2ObjectNavigableMap<V> copy()

Description copied from interface: Double2ObjectMap

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

Specified by:

copy in interface Double2ObjectSortedMap<V>

Returns:

a Shallow Copy of the Map

descendingMap

Double2ObjectNavigableMap<V> descendingMap()

Specified by:

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

Returns:

a Type Specific desendingMap

navigableKeySet

DoubleNavigableSet navigableKeySet()

Specified by:

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

Returns:

a Type Specific Navigable Key Set

descendingKeySet

DoubleNavigableSet descendingKeySet()

Specified by:

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

Returns:

a Type Specific Desending Key Set

firstEntry

Double2ObjectMap.Entry<V> firstEntry()

Specified by:

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

Returns:

a Type Specific firstEntry

lastEntry

Double2ObjectMap.Entry<V> lastEntry()

Specified by:

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

Returns:

a Type Specific lastEntry

pollFirstEntry

Double2ObjectMap.Entry<V> pollFirstEntry()

Specified by:

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

Returns:

a Type Specific pollFirstEntry

pollLastEntry

Double2ObjectMap.Entry<V> pollLastEntry()

Specified by:

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

Returns:

a Type Specific pollLastEntry

keySet

DoubleNavigableSet keySet()

Specified by:

keySet in interface Double2ObjectMap<V>

Specified by:

keySet in interface Double2ObjectSortedMap<V>

Specified by:

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

Specified by:

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

Returns:

a Type Specific Navigable Key Set

synchronize

default Double2ObjectNavigableMap<V> synchronize()

Creates a Wrapped NavigableMap that is Synchronized

Specified by:

synchronize in interface Double2ObjectMap<V>

Specified by:

synchronize in interface Double2ObjectSortedMap<V>

Returns:

a new NavigableMap that is synchronized

See Also:

Double2ObjectMaps.synchronize(speiger.src.collections.doubles.maps.interfaces.Double2ObjectMap<V>)

synchronize

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

Creates a Wrapped NavigableMap that is Synchronized

Specified by:

synchronize in interface Double2ObjectMap<V>

Specified by:

synchronize in interface Double2ObjectSortedMap<V>

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new NavigableMap Wrapper that is synchronized

See Also:

Double2ObjectMaps.synchronize(speiger.src.collections.doubles.maps.interfaces.Double2ObjectMap<V>)

unmodifiable

default Double2ObjectNavigableMap<V> unmodifiable()

Creates a Wrapped NavigableMap that is unmodifiable

Specified by:

unmodifiable in interface Double2ObjectMap<V>

Specified by:

unmodifiable in interface Double2ObjectSortedMap<V>

Returns:

a new NavigableMap Wrapper that is unmodifiable

See Also:

Double2ObjectMaps.unmodifiable(speiger.src.collections.doubles.maps.interfaces.Double2ObjectMap<V>)

subMap

Double2ObjectNavigableMap<V> subMap(double fromKey,
                                    boolean fromInclusive,
                                    double 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

Double2ObjectNavigableMap<V> headMap(double 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

Double2ObjectNavigableMap<V> tailMap(double 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 Double2ObjectNavigableMap<V> subMap(double fromKey,
                                            double toKey)

Description copied from interface: Double2ObjectSortedMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Double2ObjectSortedMap<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 Double2ObjectNavigableMap<V> headMap(double toKey)

Description copied from interface: Double2ObjectSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Double2ObjectSortedMap<V>

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

default Double2ObjectNavigableMap<V> tailMap(double fromKey)

Description copied from interface: Double2ObjectSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Double2ObjectSortedMap<V>

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range

setDefaultMaxValue

void setDefaultMaxValue(double e)

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

Parameters:

e - the new max value

getDefaultMaxValue

double getDefaultMaxValue()

A Helper method to get the max value for SubMaps.

Returns:

the default max value.

setDefaultMinValue

void setDefaultMinValue(double e)

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

Parameters:

e - the new min value

getDefaultMinValue

double getDefaultMinValue()

A Helper method to get the min value for SubMaps.

Returns:

the default min value.

lowerKey

double lowerKey(double 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

double higherKey(double 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

double floorKey(double 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

double ceilingKey(double 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

Double2ObjectMap.Entry<V> lowerEntry(double 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

Double2ObjectMap.Entry<V> higherEntry(double 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

Double2ObjectMap.Entry<V> floorEntry(double 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

Double2ObjectMap.Entry<V> ceilingEntry(double 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.Double lowerKey(java.lang.Double key)

Deprecated.

Specified by:

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

floorKey

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

Deprecated.

Specified by:

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

ceilingKey

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

Deprecated.

Specified by:

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

higherKey

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

Deprecated.

Specified by:

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

lowerEntry

@Deprecated
default Double2ObjectMap.Entry<V> lowerEntry(java.lang.Double key)

Deprecated.

Specified by:

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

floorEntry

@Deprecated
default Double2ObjectMap.Entry<V> floorEntry(java.lang.Double key)

Deprecated.

Specified by:

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

ceilingEntry

@Deprecated
default Double2ObjectMap.Entry<V> ceilingEntry(java.lang.Double key)

Deprecated.

Specified by:

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

higherEntry

@Deprecated
default Double2ObjectMap.Entry<V> higherEntry(java.lang.Double key)

Deprecated.

Specified by:

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

subMap

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

Deprecated.

Specified by:

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

headMap

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

Deprecated.

Specified by:

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

tailMap

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

Deprecated.

Specified by:

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

subMap

@Deprecated
default Double2ObjectNavigableMap<V> subMap(java.lang.Double fromKey,
                                                         java.lang.Double toKey)

Deprecated.

Specified by:

subMap in interface Double2ObjectSortedMap<V>

Specified by:

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

Specified by:

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

headMap

@Deprecated
default Double2ObjectNavigableMap<V> headMap(java.lang.Double toKey)

Deprecated.

Specified by:

headMap in interface Double2ObjectSortedMap<V>

Specified by:

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

Specified by:

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

tailMap

@Deprecated
default Double2ObjectNavigableMap<V> tailMap(java.lang.Double fromKey)

Deprecated.

Specified by:

tailMap in interface Double2ObjectSortedMap<V>

Specified by:

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

Specified by:

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