speiger.src.collections.floats.maps.interfaces

Interface Float2ObjectSortedMap<V>

Type Parameters:

V - the keyType of elements maintained by this Collection

All Superinterfaces:

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

All Known Subinterfaces:

Float2ObjectNavigableMap<V>

All Known Implementing Classes:

Float2ObjectAVLTreeMap, 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.

Note:

Float2ObjectOrderedMap is only extended until 0.6.0 for Compat reasons. The supported classes already implement Float2ObjectOrderedMap directly and will remove Float2ObjectSortedMap implementations in favor of Float2ObjectOrderedMap instead

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.BuilderCache<V>, Float2ObjectMap.Entry<V>, Float2ObjectMap.FastEntrySet<V>, Float2ObjectMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
FloatComparator	comparator()
Float2ObjectSortedMap<V>	copy() A Function that does a shallow clone of the Map itself.
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.
Float2ObjectSortedMap<V>	headMap(float toKey) A Type Specific HeadMap method to reduce boxing/unboxing
default Float2ObjectSortedMap<V>	headMap(java.lang.Float toKey) Deprecated.
FloatSortedSet	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.
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.
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.
default Float2ObjectSortedMap<V>	synchronize() Creates a Wrapped SortedMap that is Synchronized
default Float2ObjectSortedMap<V>	synchronize(java.lang.Object mutex) Creates a Wrapped SortedMap that is Synchronized
Float2ObjectSortedMap<V>	tailMap(float fromKey) A Type Specific TailMap method to reduce boxing/unboxing
default Float2ObjectSortedMap<V>	tailMap(java.lang.Float fromKey) Deprecated.
default Float2ObjectSortedMap<V>	unmodifiable() Creates a Wrapped SortedMap that is unmodifiable
ObjectCollection<V>	values()

Methods inherited from interface java.util.SortedMap

entrySet

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

apply, builder, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, float2ObjectEntrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, merge, mergeAll, put, put, 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.Map

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

Method Detail

comparator

FloatComparator comparator()

Specified by:

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

copy

Float2ObjectSortedMap<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>

Returns:

a Shallow Copy of the Map

keySet

FloatSortedSet 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>

synchronize

default Float2ObjectSortedMap<V> synchronize()

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Float2ObjectMap<V>

Returns:

a new SortedMap that is synchronized

See Also:

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

synchronize

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

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Float2ObjectMap<V>

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new SortedMap Wrapper that is synchronized

See Also:

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

unmodifiable

default Float2ObjectSortedMap<V> unmodifiable()

Creates a Wrapped SortedMap that is unmodifiable

Specified by:

unmodifiable in interface Float2ObjectMap<V>

Returns:

a new SortedMap Wrapper that is unmodifiable

See Also:

Float2ObjectMaps.unmodifiable(speiger.src.collections.floats.maps.interfaces.Float2ObjectMap<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>