speiger.src.collections.floats.maps.interfaces

Interface Float2ObjectSortedMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Superinterfaces:

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

All Known Subinterfaces:

Float2ObjectNavigableMap<V>

All Known Implementing Classes:

Float2ObjectArrayMap, Float2ObjectAVLTreeMap, Float2ObjectLinkedOpenCustomHashMap, Float2ObjectLinkedOpenHashMap, Float2ObjectMaps.SynchronizedNavigableMap, Float2ObjectMaps.SynchronizedSortedMap, Float2ObjectMaps.UnmodifyableNavigableMap, Float2ObjectMaps.UnmodifyableSortedMap, Float2ObjectRBTreeMap

public interface Float2ObjectSortedMap<V>
extends java.util.SortedMap<java.lang.Float,V>, Float2ObjectMap<V>

A Type Specific SortedMap interface to reduce boxing/unboxing, with a couple extra methods that allow greater control over maps.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Float2ObjectSortedMap.FastSortedSet<V> Fast Sorted Entry Set that allows for a faster Entry Iterator by recycling the Entry Object and just exchanging 1 internal value

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

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

Method Summary

Modifier and Type	Method and Description
FloatComparator	comparator()
float	firstFloatKey() A method to get the first Key of a Map.
default java.lang.Float	firstKey() Deprecated.
V	firstValue() A method to get the first Value of a Map.
V	getAndMoveToFirst(float key) A Specific get method that allows to move teh given key/value int the first index.
V	getAndMoveToLast(float key) A Specific get method that allows to move teh given key/value int the last index.
Float2ObjectSortedMap<V>	headMap(float toKey) A Type Specific HeadMap method to reduce boxing/unboxing
default Float2ObjectSortedMap<V>	headMap(java.lang.Float toKey) Deprecated.
FloatSet	keySet()
float	lastFloatKey() A method to get the last Key of a Map.
default java.lang.Float	lastKey() Deprecated.
V	lastValue() A method to get the last Value of a Map.
boolean	moveToFirst(float key) A specific move method to move a given key/value to the first index.
boolean	moveToLast(float key) A specific move method to move a given key/value to the last index.
float	pollFirstFloatKey() A method to get and remove the first Key of a Map.
float	pollLastFloatKey() A method to get and remove the last Key of a Map.
V	putAndMoveToFirst(float key, V value) A customized put method that allows you to insert into the first index.
V	putAndMoveToLast(float key, V value) A customized put method that allows you to insert into the last index.
Float2ObjectSortedMap<V>	subMap(float fromKey, float toKey) A Type Specific SubMap method to reduce boxing/unboxing
default Float2ObjectSortedMap<V>	subMap(java.lang.Float fromKey, java.lang.Float toKey) Deprecated.
Float2ObjectSortedMap<V>	tailMap(float fromKey) A Type Specific TailMap method to reduce boxing/unboxing
default Float2ObjectSortedMap<V>	tailMap(java.lang.Float fromKey) Deprecated.
ObjectCollection<V>	values()

Methods inherited from interface java.util.SortedMap

entrySet

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

compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, float2ObjectEntrySet, forEach, forEach, get, getDefaultReturnValue, getObject, getOrDefault, getOrDefault, merge, merge, mergeAll, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remFloat, remFloatOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue

Methods inherited from interface java.util.Map

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

Method Detail

putAndMoveToFirst

V putAndMoveToFirst(float key,
                    V value)

A customized put method that allows you to insert into the first index.

Parameters:

key - the key that should be inserted

value - the value that should be inserted

Returns:

the previous present or default return value

See Also:

Map.put(Object, Object)

Note:

some implementations do not support this method

putAndMoveToLast

V putAndMoveToLast(float key,
                   V value)

A customized put method that allows you to insert into the last index. (This may be nessesary depending on the implementation)

Parameters:

key - the key that should be inserted

value - the value that should be inserted

Returns:

the previous present or default return value

See Also:

Map.put(Object, Object)

Note:

some implementations do not support this method

moveToFirst

boolean moveToFirst(float key)

A specific move method to move a given key/value to the first index.

Parameters:

key - that should be moved to the first index

Returns:

true if the value was moved.

Note:

returns false if the value was not present in the first place, some implementations do not support this method

moveToLast

boolean moveToLast(float key)

A specific move method to move a given key/value to the last index.

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

Note:

returns false if the value was not present in the first place, some implementations do not support this method

getAndMoveToFirst

V getAndMoveToFirst(float key)

A Specific get method that allows to move teh given key/value int the first index.

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

Note:

some implementations do not support this method

getAndMoveToLast

V getAndMoveToLast(float key)

A Specific get method that allows to move teh given key/value int the last index.

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

Note:

some implementations do not support this method

comparator

FloatComparator comparator()

Specified by:

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

keySet

FloatSet keySet()

Specified by:

keySet in interface Float2ObjectMap<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>

values

ObjectCollection<V> values()

Specified by:

values in interface Float2ObjectMap<V>

Specified by:

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

Specified by:

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

subMap

Float2ObjectSortedMap<V> subMap(float fromKey,
                                float toKey)

A Type Specific SubMap method to reduce boxing/unboxing

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

Note:

Some implementations may not support this method., Some implementations may not keep the desired range when the original is changed.

headMap

Float2ObjectSortedMap<V> headMap(float toKey)

A Type Specific HeadMap method to reduce boxing/unboxing

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

Note:

Some implementations may not support this method., Some implementations may not keep the desired range when the original is changed.

tailMap

Float2ObjectSortedMap<V> tailMap(float fromKey)

A Type Specific TailMap method to reduce boxing/unboxing

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range

Note:

Some implementations may not support this method., Some implementations may not keep the desired range when the original is changed.

firstFloatKey

float firstFloatKey()

A method to get the first Key of a Map.

Returns:

the first key in the map

pollFirstFloatKey

float pollFirstFloatKey()

A method to get and remove the first Key of a Map.

Returns:

the first key in the map

lastFloatKey

float lastFloatKey()

A method to get the last Key of a Map.

Returns:

the last key in the map

pollLastFloatKey

float pollLastFloatKey()

A method to get and remove the last Key of a Map.

Returns:

the last key in the map

firstValue

V firstValue()

A method to get the first Value of a Map.

Returns:

the first key in the map

lastValue

V lastValue()

A method to get the last Value of a Map.

Returns:

the last key in the map

firstKey

@Deprecated
default java.lang.Float firstKey()

Deprecated.

Specified by:

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

lastKey

@Deprecated
default java.lang.Float lastKey()

Deprecated.

Specified by:

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

subMap

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

Deprecated.

Specified by:

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

headMap

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

Deprecated.

Specified by:

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

tailMap

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

Deprecated.

Specified by:

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