speiger.src.collections.floats.maps.interfaces

Interface Float2FloatSortedMap

All Superinterfaces:

Float2FloatFunction, Float2FloatMap, java.util.Map<java.lang.Float,java.lang.Float>, java.util.SortedMap<java.lang.Float,java.lang.Float>

All Known Subinterfaces:

Float2FloatNavigableMap

All Known Implementing Classes:

Float2FloatAVLTreeMap, Float2FloatMaps.SynchronizedNavigableMap, Float2FloatMaps.SynchronizedSortedMap, Float2FloatMaps.UnmodifyableNavigableMap, Float2FloatMaps.UnmodifyableSortedMap, Float2FloatRBTreeMap

public interface Float2FloatSortedMap
extends java.util.SortedMap<java.lang.Float,java.lang.Float>, Float2FloatMap

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

Note:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Float2FloatSortedMap.FastSortedSet 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.Float2FloatMap

Float2FloatMap.BuilderCache, Float2FloatMap.Entry, Float2FloatMap.FastEntrySet, Float2FloatMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
FloatComparator	comparator()
Float2FloatSortedMap	copy() A Function that does a shallow clone of the Map itself.
float	firstFloatKey() A method to get the first Key of a Map.
float	firstFloatValue() A method to get the first Value of a Map.
default java.lang.Float	firstKey() Deprecated.
Float2FloatSortedMap	headMap(float toKey) A Type Specific HeadMap method to reduce boxing/unboxing
default Float2FloatSortedMap	headMap(java.lang.Float toKey) Deprecated.
FloatSortedSet	keySet()
float	lastFloatKey() A method to get the last Key of a Map.
float	lastFloatValue() A method to get the last Value of a Map.
default java.lang.Float	lastKey() Deprecated.
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.
Float2FloatSortedMap	subMap(float fromKey, float toKey) A Type Specific SubMap method to reduce boxing/unboxing
default Float2FloatSortedMap	subMap(java.lang.Float fromKey, java.lang.Float toKey) Deprecated.
default Float2FloatSortedMap	synchronize() Creates a Wrapped SortedMap that is Synchronized
default Float2FloatSortedMap	synchronize(java.lang.Object mutex) Creates a Wrapped SortedMap that is Synchronized
Float2FloatSortedMap	tailMap(float fromKey) A Type Specific TailMap method to reduce boxing/unboxing
default Float2FloatSortedMap	tailMap(java.lang.Float fromKey) Deprecated.
default Float2FloatSortedMap	unmodifiable() Creates a Wrapped SortedMap that is unmodifiable
FloatCollection	values()

Methods inherited from interface java.util.SortedMap

entrySet

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

addTo, addToAll, builder, compute, computeFloat, computeFloatIfAbsent, computeFloatIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, float2FloatEntrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllFloat, mergeFloat, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceFloats, replaceFloats, setDefaultReturnValue, subFrom, supplyFloatIfAbsent

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

comparator

FloatComparator comparator()

Specified by:

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

copy

Float2FloatSortedMap copy()

Description copied from interface: Float2FloatMap

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 Float2FloatMap

Returns:

a Shallow Copy of the Map

keySet

FloatSortedSet keySet()

Specified by:

keySet in interface Float2FloatMap

Specified by:

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

Specified by:

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

values

FloatCollection values()

Specified by:

values in interface Float2FloatMap

Specified by:

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

Specified by:

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

synchronize

default Float2FloatSortedMap synchronize()

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Float2FloatMap

Returns:

a new SortedMap that is synchronized

See Also:

Float2FloatMaps.synchronize(speiger.src.collections.floats.maps.interfaces.Float2FloatMap)

synchronize

default Float2FloatSortedMap synchronize(java.lang.Object mutex)

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Float2FloatMap

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new SortedMap Wrapper that is synchronized

See Also:

Float2FloatMaps.synchronize(speiger.src.collections.floats.maps.interfaces.Float2FloatMap)

unmodifiable

default Float2FloatSortedMap unmodifiable()

Creates a Wrapped SortedMap that is unmodifiable

Specified by:

unmodifiable in interface Float2FloatMap

Returns:

a new SortedMap Wrapper that is unmodifiable

See Also:

Float2FloatMaps.unmodifiable(speiger.src.collections.floats.maps.interfaces.Float2FloatMap)

subMap

Float2FloatSortedMap 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

Float2FloatSortedMap 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

Float2FloatSortedMap 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

firstFloatValue

float firstFloatValue()

A method to get the first Value of a Map.

Returns:

the first key in the map

lastFloatValue

float lastFloatValue()

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,java.lang.Float>

lastKey

@Deprecated
default java.lang.Float lastKey()

Deprecated.

Specified by:

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

subMap

@Deprecated
default Float2FloatSortedMap subMap(java.lang.Float fromKey,
                                                 java.lang.Float toKey)

Deprecated.

Specified by:

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

headMap

@Deprecated
default Float2FloatSortedMap headMap(java.lang.Float toKey)

Deprecated.

Specified by:

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

tailMap

@Deprecated
default Float2FloatSortedMap tailMap(java.lang.Float fromKey)

Deprecated.

Specified by:

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