speiger.src.collections.floats.maps.interfaces

Interface Float2ObjectNavigableMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Superinterfaces:

Float2ObjectFunction<V>, Float2ObjectMap<V>, Float2ObjectSortedMap<V>, java.util.Map<java.lang.Float,V>, java.util.NavigableMap<java.lang.Float,V>, java.util.SortedMap<java.lang.Float,V>

All Known Implementing Classes:

Float2ObjectAVLTreeMap, Float2ObjectMaps.SynchronizedNavigableMap, Float2ObjectMaps.UnmodifyableNavigableMap, Float2ObjectRBTreeMap

public interface Float2ObjectNavigableMap<V>
extends Float2ObjectSortedMap<V>, java.util.NavigableMap<java.lang.Float,V>

A Type Specific Navigable Map interface with a couple helper methods

Nested Class Summary

Nested classes/interfaces inherited from interface speiger.src.collections.floats.maps.interfaces.Float2ObjectSortedMap

Float2ObjectSortedMap.FastSortedSet<V>

Nested classes/interfaces inherited from interface speiger.src.collections.floats.maps.interfaces.Float2ObjectMap

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

Method Summary

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

Methods inherited from interface speiger.src.collections.floats.maps.interfaces.Float2ObjectSortedMap

comparator, firstFloatKey, firstKey, firstValue, lastFloatKey, lastKey, lastValue, pollFirstFloatKey, pollLastFloatKey, values

Methods inherited from interface speiger.src.collections.floats.maps.interfaces.Float2ObjectMap

builder, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, float2ObjectEntrySet, 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 java.util.SortedMap

entrySet

Methods inherited from interface java.util.Map

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

Method Detail

copy

Float2ObjectNavigableMap<V> copy()

Description copied from interface: Float2ObjectMap

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

Specified by:

copy in interface Float2ObjectSortedMap<V>

Returns:

a Shallow Copy of the Map

descendingMap

Float2ObjectNavigableMap<V> descendingMap()

Specified by:

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

Returns:

a Type Specific desendingMap

navigableKeySet

FloatNavigableSet navigableKeySet()

Specified by:

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

Returns:

a Type Specific Navigable Key Set

descendingKeySet

FloatNavigableSet descendingKeySet()

Specified by:

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

Returns:

a Type Specific Desending Key Set

firstEntry

Float2ObjectMap.Entry<V> firstEntry()

Specified by:

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

Returns:

a Type Specific firstEntry

lastEntry

Float2ObjectMap.Entry<V> lastEntry()

Specified by:

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

Returns:

a Type Specific lastEntry

pollFirstEntry

Float2ObjectMap.Entry<V> pollFirstEntry()

Specified by:

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

Returns:

a Type Specific pollFirstEntry

pollLastEntry

Float2ObjectMap.Entry<V> pollLastEntry()

Specified by:

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

Returns:

a Type Specific pollLastEntry

keySet

FloatNavigableSet keySet()

Specified by:

keySet in interface Float2ObjectMap<V>

Specified by:

keySet in interface Float2ObjectSortedMap<V>

Specified by:

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

Specified by:

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

Returns:

a Type Specific Navigable Key Set

synchronize

default Float2ObjectNavigableMap<V> synchronize()

Creates a Wrapped NavigableMap that is Synchronized

Specified by:

synchronize in interface Float2ObjectMap<V>

Specified by:

synchronize in interface Float2ObjectSortedMap<V>

Returns:

a new NavigableMap that is synchronized

See Also:

Float2ObjectMaps.synchronize(speiger.src.collections.floats.maps.interfaces.Float2ObjectMap<V>)

synchronize

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

Creates a Wrapped NavigableMap that is Synchronized

Specified by:

synchronize in interface Float2ObjectMap<V>

Specified by:

synchronize in interface Float2ObjectSortedMap<V>

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new NavigableMap Wrapper that is synchronized

See Also:

Float2ObjectMaps.synchronize(speiger.src.collections.floats.maps.interfaces.Float2ObjectMap<V>)

unmodifiable

default Float2ObjectNavigableMap<V> unmodifiable()

Creates a Wrapped NavigableMap that is unmodifiable

Specified by:

unmodifiable in interface Float2ObjectMap<V>

Specified by:

unmodifiable in interface Float2ObjectSortedMap<V>

Returns:

a new NavigableMap Wrapper that is unmodifiable

See Also:

Float2ObjectMaps.unmodifiable(speiger.src.collections.floats.maps.interfaces.Float2ObjectMap<V>)

subMap

Float2ObjectNavigableMap<V> subMap(float fromKey,
                                   boolean fromInclusive,
                                   float 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

Float2ObjectNavigableMap<V> headMap(float 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

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

Description copied from interface: Float2ObjectSortedMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Float2ObjectSortedMap<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 Float2ObjectNavigableMap<V> headMap(float toKey)

Description copied from interface: Float2ObjectSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Float2ObjectSortedMap<V>

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

default Float2ObjectNavigableMap<V> tailMap(float fromKey)

Description copied from interface: Float2ObjectSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Float2ObjectSortedMap<V>

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range

setDefaultMaxValue

void setDefaultMaxValue(float e)

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

Parameters:

e - the new max value

getDefaultMaxValue

float getDefaultMaxValue()

A Helper method to get the max value for SubMaps.

Returns:

the default max value.

setDefaultMinValue

void setDefaultMinValue(float e)

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

Parameters:

e - the new min value

getDefaultMinValue

float getDefaultMinValue()

A Helper method to get the min value for SubMaps.

Returns:

the default min value.

lowerKey

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

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

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

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

Float2ObjectMap.Entry<V> lowerEntry(float 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

Float2ObjectMap.Entry<V> higherEntry(float 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

Float2ObjectMap.Entry<V> floorEntry(float 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

Float2ObjectMap.Entry<V> ceilingEntry(float 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.Float lowerKey(java.lang.Float key)

Deprecated.

Specified by:

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

floorKey

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

Deprecated.

Specified by:

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

ceilingKey

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

Deprecated.

Specified by:

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

higherKey

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

Deprecated.

Specified by:

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

lowerEntry

@Deprecated
default Float2ObjectMap.Entry<V> lowerEntry(java.lang.Float key)

Deprecated.

Specified by:

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

floorEntry

@Deprecated
default Float2ObjectMap.Entry<V> floorEntry(java.lang.Float key)

Deprecated.

Specified by:

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

ceilingEntry

@Deprecated
default Float2ObjectMap.Entry<V> ceilingEntry(java.lang.Float key)

Deprecated.

Specified by:

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

higherEntry

@Deprecated
default Float2ObjectMap.Entry<V> higherEntry(java.lang.Float key)

Deprecated.

Specified by:

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

subMap

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

Deprecated.

Specified by:

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

headMap

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

Deprecated.

Specified by:

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

tailMap

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

Deprecated.

Specified by:

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

subMap

@Deprecated
default Float2ObjectNavigableMap<V> subMap(java.lang.Float fromKey,
                                                        java.lang.Float toKey)

Deprecated.

Specified by:

subMap in interface Float2ObjectSortedMap<V>

Specified by:

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

Specified by:

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

headMap

@Deprecated
default Float2ObjectNavigableMap<V> headMap(java.lang.Float toKey)

Deprecated.

Specified by:

headMap in interface Float2ObjectSortedMap<V>

Specified by:

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

Specified by:

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

tailMap

@Deprecated
default Float2ObjectNavigableMap<V> tailMap(java.lang.Float fromKey)

Deprecated.

Specified by:

tailMap in interface Float2ObjectSortedMap<V>

Specified by:

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

Specified by:

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