speiger.src.collections.floats.utils.maps

Class Float2ObjectMaps.UnmodifyableNavigableMap<V>

java.lang.Object

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

speiger.src.collections.floats.maps.abstracts.AbstractFloat2ObjectMap<V>

speiger.src.collections.floats.utils.maps.Float2ObjectMaps.UnmodifyableMap<V>

speiger.src.collections.floats.utils.maps.Float2ObjectMaps.UnmodifyableSortedMap<V>

speiger.src.collections.floats.utils.maps.Float2ObjectMaps.UnmodifyableNavigableMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Implemented Interfaces:

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

Enclosing class:

Float2ObjectMaps

public static class Float2ObjectMaps.UnmodifyableNavigableMap<V>
extends Float2ObjectMaps.UnmodifyableSortedMap<V>
implements Float2ObjectNavigableMap<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.floats.maps.abstracts.AbstractFloat2ObjectMap

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

Methods inherited from class speiger.src.collections.floats.utils.maps.Float2ObjectMaps.UnmodifyableSortedMap

comparator, firstFloatKey, firstValue, lastFloatKey, lastValue, pollFirstFloatKey, pollLastFloatKey

Methods inherited from class speiger.src.collections.floats.utils.maps.Float2ObjectMaps.UnmodifyableMap

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

Methods inherited from class speiger.src.collections.floats.maps.abstracts.AbstractFloat2ObjectMap

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.floats.maps.interfaces.Float2ObjectNavigableMap

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

descendingMap

public Float2ObjectNavigableMap<V> descendingMap()

Specified by:

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

Specified by:

descendingMap in interface Float2ObjectNavigableMap<V>

Returns:

a Type Specific desendingMap

navigableKeySet

public FloatNavigableSet navigableKeySet()

Specified by:

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

Specified by:

navigableKeySet in interface Float2ObjectNavigableMap<V>

Returns:

a Type Specific Navigable Key Set

keySet

public FloatNavigableSet keySet()

Specified by:

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

Specified by:

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

Specified by:

keySet in interface Float2ObjectMap<V>

Specified by:

keySet in interface Float2ObjectNavigableMap<V>

Specified by:

keySet in interface Float2ObjectSortedMap<V>

Overrides:

keySet in class Float2ObjectMaps.UnmodifyableSortedMap<V>

Returns:

a Type Specific Navigable Key Set

descendingKeySet

public FloatNavigableSet descendingKeySet()

Specified by:

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

Specified by:

descendingKeySet in interface Float2ObjectNavigableMap<V>

Returns:

a Type Specific Desending Key Set

firstEntry

public Float2ObjectMap.Entry<V> firstEntry()

Specified by:

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

Specified by:

firstEntry in interface Float2ObjectNavigableMap<V>

Returns:

a Type Specific firstEntry

lastEntry

public Float2ObjectMap.Entry<V> lastEntry()

Specified by:

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

Specified by:

lastEntry in interface Float2ObjectNavigableMap<V>

Returns:

a Type Specific lastEntry

pollFirstEntry

public Float2ObjectMap.Entry<V> pollFirstEntry()

Specified by:

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

Specified by:

pollFirstEntry in interface Float2ObjectNavigableMap<V>

Returns:

a Type Specific pollFirstEntry

pollLastEntry

public Float2ObjectMap.Entry<V> pollLastEntry()

Specified by:

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

Specified by:

pollLastEntry in interface Float2ObjectNavigableMap<V>

Returns:

a Type Specific pollLastEntry

subMap

public Float2ObjectNavigableMap<V> subMap(float fromKey,
                                          boolean fromInclusive,
                                          float toKey,
                                          boolean toInclusive)

Description copied from interface: Float2ObjectNavigableMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

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

Description copied from interface: Float2ObjectNavigableMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

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

Description copied from interface: Float2ObjectNavigableMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

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

Specified by:

subMap in interface Float2ObjectSortedMap<V>

Overrides:

subMap in class Float2ObjectMaps.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 Float2ObjectNavigableMap<V> headMap(float toKey)

Description copied from interface: Float2ObjectSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Float2ObjectNavigableMap<V>

Specified by:

headMap in interface Float2ObjectSortedMap<V>

Overrides:

headMap in class Float2ObjectMaps.UnmodifyableSortedMap<V>

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

public Float2ObjectNavigableMap<V> tailMap(float fromKey)

Description copied from interface: Float2ObjectSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Float2ObjectNavigableMap<V>

Specified by:

tailMap in interface Float2ObjectSortedMap<V>

Overrides:

tailMap in class Float2ObjectMaps.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(float e)

Description copied from interface: Float2ObjectNavigableMap

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

Specified by:

setDefaultMaxValue in interface Float2ObjectNavigableMap<V>

Parameters:

e - the new max value

getDefaultMaxValue

public float getDefaultMaxValue()

Description copied from interface: Float2ObjectNavigableMap

A Helper method to get the max value for SubMaps.

Specified by:

getDefaultMaxValue in interface Float2ObjectNavigableMap<V>

Returns:

the default max value.

setDefaultMinValue

public void setDefaultMinValue(float e)

Description copied from interface: Float2ObjectNavigableMap

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

Specified by:

setDefaultMinValue in interface Float2ObjectNavigableMap<V>

Parameters:

e - the new min value

getDefaultMinValue

public float getDefaultMinValue()

Description copied from interface: Float2ObjectNavigableMap

A Helper method to get the min value for SubMaps.

Specified by:

getDefaultMinValue in interface Float2ObjectNavigableMap<V>

Returns:

the default min value.

lowerKey

public float lowerKey(float key)

Description copied from interface: Float2ObjectNavigableMap

A Type Specific lowerKey method to reduce boxing/unboxing.

Specified by:

lowerKey in interface Float2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the greatest lower key that can be found

higherKey

public float higherKey(float key)

Description copied from interface: Float2ObjectNavigableMap

A Type Specific higherKey method to reduce boxing/unboxing.

Specified by:

higherKey in interface Float2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the lowest higher key that can be found

floorKey

public float floorKey(float key)

Description copied from interface: Float2ObjectNavigableMap

A Type Specific floorKey method to reduce boxing/unboxing.

Specified by:

floorKey in interface Float2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the greatest lower or equal key that can be found

ceilingKey

public float ceilingKey(float key)

Description copied from interface: Float2ObjectNavigableMap

A Type Specific ceilingKey method to reduce boxing/unboxing.

Specified by:

ceilingKey in interface Float2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the lowest higher or equal key that can be found

lowerEntry

public Float2ObjectMap.Entry<V> lowerEntry(float key)

Description copied from interface: Float2ObjectNavigableMap

A Type Specific lowerEntry method to reduce boxing/unboxing.

Specified by:

lowerEntry in interface Float2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the greatest lower entry that can be found, or null

higherEntry

public Float2ObjectMap.Entry<V> higherEntry(float key)

Description copied from interface: Float2ObjectNavigableMap

A Type Specific higherEntry method to reduce boxing/unboxing.

Specified by:

higherEntry in interface Float2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

the lowest higher entry that can be found, or null

floorEntry

public Float2ObjectMap.Entry<V> floorEntry(float key)

Description copied from interface: Float2ObjectNavigableMap

A Type Specific floorEntry method to reduce boxing/unboxing.

Specified by:

floorEntry in interface Float2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

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

ceilingEntry

public Float2ObjectMap.Entry<V> ceilingEntry(float key)

Description copied from interface: Float2ObjectNavigableMap

A Type Specific ceilingEntry method to reduce boxing/unboxing.

Specified by:

ceilingEntry in interface Float2ObjectNavigableMap<V>

Parameters:

key - that should be compared with.

Returns:

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

copy

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

Specified by:

copy in interface Float2ObjectSortedMap<V>

Overrides:

copy in class Float2ObjectMaps.UnmodifyableSortedMap<V>

Returns:

a Shallow Copy of the Map