speiger.src.collections.doubles.utils.maps

Class Double2ObjectMaps.UnmodifyableNavigableMap<V>

java.lang.Object

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

speiger.src.collections.doubles.maps.abstracts.AbstractDouble2ObjectMap<V>

speiger.src.collections.doubles.utils.maps.Double2ObjectMaps.UnmodifyableMap<V>

speiger.src.collections.doubles.utils.maps.Double2ObjectMaps.UnmodifyableSortedMap<V>

speiger.src.collections.doubles.utils.maps.Double2ObjectMaps.UnmodifyableNavigableMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Implemented Interfaces:

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>, Double2ObjectFunction<V>, Double2ObjectMap<V>, Double2ObjectNavigableMap<V>, Double2ObjectSortedMap<V>

Enclosing class:

Double2ObjectMaps

public static class Double2ObjectMaps.UnmodifyableNavigableMap<V>
extends Double2ObjectMaps.UnmodifyableSortedMap<V>
implements Double2ObjectNavigableMap<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.doubles.maps.abstracts.AbstractDouble2ObjectMap

AbstractDouble2ObjectMap.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.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.
double	ceilingKey(double key) A Type Specific ceilingKey method to reduce boxing/unboxing.
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.
double	floorKey(double key) A Type Specific floorKey method to reduce boxing/unboxing.
double	getDefaultMaxValue() A Helper method to get the max value for SubMaps.
double	getDefaultMinValue() A Helper method to get the min value for SubMaps.
Double2ObjectNavigableMap<V>	headMap(double toKey) A Type Specific HeadMap method to reduce boxing/unboxing
Double2ObjectNavigableMap<V>	headMap(double toKey, boolean inclusive) A Type Specific HeadMap method to reduce boxing/unboxing
Double2ObjectMap.Entry<V>	higherEntry(double key) A Type Specific higherEntry method to reduce boxing/unboxing.
double	higherKey(double key) A Type Specific higherKey method to reduce boxing/unboxing.
DoubleNavigableSet	keySet()
Double2ObjectMap.Entry<V>	lastEntry()
Double2ObjectMap.Entry<V>	lowerEntry(double key) A Type Specific lowerEntry method to reduce boxing/unboxing.
double	lowerKey(double key) A Type Specific lowerKey method to reduce boxing/unboxing.
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
Double2ObjectNavigableMap<V>	subMap(double fromKey, double toKey) A Type Specific SubMap method to reduce boxing/unboxing
Double2ObjectNavigableMap<V>	tailMap(double fromKey) A Type Specific TailMap method to reduce boxing/unboxing
Double2ObjectNavigableMap<V>	tailMap(double fromKey, boolean inclusive) A Type Specific TailMap method to reduce boxing/unboxing

Methods inherited from class speiger.src.collections.doubles.utils.maps.Double2ObjectMaps.UnmodifyableSortedMap

comparator, firstDoubleKey, firstValue, lastDoubleKey, lastValue, pollFirstDoubleKey, pollLastDoubleKey

Methods inherited from class speiger.src.collections.doubles.utils.maps.Double2ObjectMaps.UnmodifyableMap

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

Methods inherited from class speiger.src.collections.doubles.maps.abstracts.AbstractDouble2ObjectMap

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.doubles.maps.interfaces.Double2ObjectNavigableMap

ceilingEntry, ceilingKey, floorEntry, floorKey, headMap, headMap, higherEntry, higherKey, lowerEntry, lowerKey, subMap, subMap, synchronize, synchronize, tailMap, tailMap, 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

descendingMap

public Double2ObjectNavigableMap<V> descendingMap()

Specified by:

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

Specified by:

descendingMap in interface Double2ObjectNavigableMap<V>

Returns:

a Type Specific desendingMap

navigableKeySet

public DoubleNavigableSet navigableKeySet()

Specified by:

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

Specified by:

navigableKeySet in interface Double2ObjectNavigableMap<V>

Returns:

a Type Specific Navigable Key Set

keySet

public DoubleNavigableSet keySet()

Specified by:

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

Specified by:

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

Specified by:

keySet in interface Double2ObjectMap<V>

Specified by:

keySet in interface Double2ObjectNavigableMap<V>

Specified by:

keySet in interface Double2ObjectSortedMap<V>

Overrides:

keySet in class Double2ObjectMaps.UnmodifyableSortedMap<V>

Returns:

a Type Specific Navigable Key Set

descendingKeySet

public DoubleNavigableSet descendingKeySet()

Specified by:

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

Specified by:

descendingKeySet in interface Double2ObjectNavigableMap<V>

Returns:

a Type Specific Desending Key Set

firstEntry

public Double2ObjectMap.Entry<V> firstEntry()

Specified by:

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

Specified by:

firstEntry in interface Double2ObjectNavigableMap<V>

Returns:

a Type Specific firstEntry

lastEntry

public Double2ObjectMap.Entry<V> lastEntry()

Specified by:

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

Specified by:

lastEntry in interface Double2ObjectNavigableMap<V>

Returns:

a Type Specific lastEntry

pollFirstEntry

public Double2ObjectMap.Entry<V> pollFirstEntry()

Specified by:

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

Specified by:

pollFirstEntry in interface Double2ObjectNavigableMap<V>

Returns:

a Type Specific pollFirstEntry

pollLastEntry

public Double2ObjectMap.Entry<V> pollLastEntry()

Specified by:

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

Specified by:

pollLastEntry in interface Double2ObjectNavigableMap<V>

Returns:

a Type Specific pollLastEntry

subMap

public Double2ObjectNavigableMap<V> subMap(double fromKey,
                                           boolean fromInclusive,
                                           double toKey,
                                           boolean toInclusive)

Description copied from interface: Double2ObjectNavigableMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

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

Description copied from interface: Double2ObjectNavigableMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Double2ObjectNavigableMap<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 Double2ObjectNavigableMap<V> tailMap(double fromKey,
                                            boolean inclusive)

Description copied from interface: Double2ObjectNavigableMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Double2ObjectNavigableMap<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 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 Double2ObjectNavigableMap<V>

Specified by:

subMap in interface Double2ObjectSortedMap<V>

Overrides:

subMap in class Double2ObjectMaps.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 Double2ObjectNavigableMap<V> headMap(double toKey)

Description copied from interface: Double2ObjectSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Double2ObjectNavigableMap<V>

Specified by:

headMap in interface Double2ObjectSortedMap<V>

Overrides:

headMap in class Double2ObjectMaps.UnmodifyableSortedMap<V>

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

public Double2ObjectNavigableMap<V> tailMap(double fromKey)

Description copied from interface: Double2ObjectSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Double2ObjectNavigableMap<V>

Specified by:

tailMap in interface Double2ObjectSortedMap<V>

Overrides:

tailMap in class Double2ObjectMaps.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(double e)

Description copied from interface: Double2ObjectNavigableMap

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

Specified by:

setDefaultMaxValue in interface Double2ObjectNavigableMap<V>

Parameters:

e - the new max value

getDefaultMaxValue

public double getDefaultMaxValue()

Description copied from interface: Double2ObjectNavigableMap

A Helper method to get the max value for SubMaps.

Specified by:

getDefaultMaxValue in interface Double2ObjectNavigableMap<V>

Returns:

the default max value.

setDefaultMinValue

public void setDefaultMinValue(double e)

Description copied from interface: Double2ObjectNavigableMap

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

Specified by:

setDefaultMinValue in interface Double2ObjectNavigableMap<V>

Parameters:

e - the new min value

getDefaultMinValue

public double getDefaultMinValue()

Description copied from interface: Double2ObjectNavigableMap

A Helper method to get the min value for SubMaps.

Specified by:

getDefaultMinValue in interface Double2ObjectNavigableMap<V>

Returns:

the default min value.

lowerKey

public double lowerKey(double key)

Description copied from interface: Double2ObjectNavigableMap

A Type Specific lowerKey method to reduce boxing/unboxing.

Specified by:

lowerKey in interface Double2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the greatest lower key that can be found

higherKey

public double higherKey(double key)

Description copied from interface: Double2ObjectNavigableMap

A Type Specific higherKey method to reduce boxing/unboxing.

Specified by:

higherKey in interface Double2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the lowest higher key that can be found

floorKey

public double floorKey(double key)

Description copied from interface: Double2ObjectNavigableMap

A Type Specific floorKey method to reduce boxing/unboxing.

Specified by:

floorKey in interface Double2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the greatest lower or equal key that can be found

ceilingKey

public double ceilingKey(double key)

Description copied from interface: Double2ObjectNavigableMap

A Type Specific ceilingKey method to reduce boxing/unboxing.

Specified by:

ceilingKey in interface Double2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the lowest higher or equal key that can be found

lowerEntry

public Double2ObjectMap.Entry<V> lowerEntry(double key)

Description copied from interface: Double2ObjectNavigableMap

A Type Specific lowerEntry method to reduce boxing/unboxing.

Specified by:

lowerEntry in interface Double2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the greatest lower entry that can be found, or null

higherEntry

public Double2ObjectMap.Entry<V> higherEntry(double key)

Description copied from interface: Double2ObjectNavigableMap

A Type Specific higherEntry method to reduce boxing/unboxing.

Specified by:

higherEntry in interface Double2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the lowest higher entry that can be found, or null

floorEntry

public Double2ObjectMap.Entry<V> floorEntry(double key)

Description copied from interface: Double2ObjectNavigableMap

A Type Specific floorEntry method to reduce boxing/unboxing.

Specified by:

floorEntry in interface Double2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

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

ceilingEntry

public Double2ObjectMap.Entry<V> ceilingEntry(double key)

Description copied from interface: Double2ObjectNavigableMap

A Type Specific ceilingEntry method to reduce boxing/unboxing.

Specified by:

ceilingEntry in interface Double2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

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

copy

public 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 Double2ObjectNavigableMap<V>

Specified by:

copy in interface Double2ObjectSortedMap<V>

Overrides:

copy in class Double2ObjectMaps.UnmodifyableSortedMap<V>

Returns:

a Shallow Copy of the Map