speiger.src.collections.doubles.maps.interfaces

Interface Double2ObjectSortedMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Superinterfaces:

Double2ObjectFunction<V>, Double2ObjectMap<V>, java.util.function.DoubleFunction<V>, java.util.Map<java.lang.Double,V>, java.util.SortedMap<java.lang.Double,V>

All Known Subinterfaces:

Double2ObjectNavigableMap<V>

All Known Implementing Classes:

Double2ObjectAVLTreeMap, Double2ObjectMaps.SynchronizedNavigableMap, Double2ObjectMaps.SynchronizedSortedMap, Double2ObjectMaps.UnmodifyableNavigableMap, Double2ObjectMaps.UnmodifyableSortedMap, Double2ObjectRBTreeMap

public interface Double2ObjectSortedMap<V>
extends java.util.SortedMap<java.lang.Double,V>, Double2ObjectMap<V>

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

Note:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Double2ObjectSortedMap.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.doubles.maps.interfaces.Double2ObjectMap

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

Method Summary

Modifier and Type	Method and Description
DoubleComparator	comparator()
Double2ObjectSortedMap<V>	copy() A Function that does a shallow clone of the Map itself.
double	firstDoubleKey() A method to get the first Key of a Map.
default java.lang.Double	firstKey() Deprecated.
V	firstValue() A method to get the first Value of a Map.
Double2ObjectSortedMap<V>	headMap(double toKey) A Type Specific HeadMap method to reduce boxing/unboxing
default Double2ObjectSortedMap<V>	headMap(java.lang.Double toKey) Deprecated.
DoubleSortedSet	keySet()
double	lastDoubleKey() A method to get the last Key of a Map.
default java.lang.Double	lastKey() Deprecated.
V	lastValue() A method to get the last Value of a Map.
double	pollFirstDoubleKey() A method to get and remove the first Key of a Map.
double	pollLastDoubleKey() A method to get and remove the last Key of a Map.
Double2ObjectSortedMap<V>	subMap(double fromKey, double toKey) A Type Specific SubMap method to reduce boxing/unboxing
default Double2ObjectSortedMap<V>	subMap(java.lang.Double fromKey, java.lang.Double toKey) Deprecated.
default Double2ObjectSortedMap<V>	synchronize() Creates a Wrapped SortedMap that is Synchronized
default Double2ObjectSortedMap<V>	synchronize(java.lang.Object mutex) Creates a Wrapped SortedMap that is Synchronized
Double2ObjectSortedMap<V>	tailMap(double fromKey) A Type Specific TailMap method to reduce boxing/unboxing
default Double2ObjectSortedMap<V>	tailMap(java.lang.Double fromKey) Deprecated.
default Double2ObjectSortedMap<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.doubles.maps.interfaces.Double2ObjectMap

builder, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, double2ObjectEntrySet, entrySet, 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.Map

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

Methods inherited from interface speiger.src.collections.doubles.functions.function.Double2ObjectFunction

apply

Method Detail

comparator

DoubleComparator comparator()

Specified by:

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

copy

Double2ObjectSortedMap<V> copy()

Description copied from interface: Double2ObjectMap

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

Returns:

a Shallow Copy of the Map

keySet

DoubleSortedSet keySet()

Specified by:

keySet in interface Double2ObjectMap<V>

Specified by:

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

Specified by:

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

values

ObjectCollection<V> values()

Specified by:

values in interface Double2ObjectMap<V>

Specified by:

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

Specified by:

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

synchronize

default Double2ObjectSortedMap<V> synchronize()

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Double2ObjectMap<V>

Returns:

a new SortedMap that is synchronized

See Also:

Double2ObjectMaps.synchronize(speiger.src.collections.doubles.maps.interfaces.Double2ObjectMap<V>)

synchronize

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

Creates a Wrapped SortedMap that is Synchronized

Specified by:

synchronize in interface Double2ObjectMap<V>

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new SortedMap Wrapper that is synchronized

See Also:

Double2ObjectMaps.synchronize(speiger.src.collections.doubles.maps.interfaces.Double2ObjectMap<V>)

unmodifiable

default Double2ObjectSortedMap<V> unmodifiable()

Creates a Wrapped SortedMap that is unmodifiable

Specified by:

unmodifiable in interface Double2ObjectMap<V>

Returns:

a new SortedMap Wrapper that is unmodifiable

See Also:

Double2ObjectMaps.unmodifiable(speiger.src.collections.doubles.maps.interfaces.Double2ObjectMap<V>)

subMap

Double2ObjectSortedMap<V> subMap(double fromKey,
                                 double 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

Double2ObjectSortedMap<V> headMap(double 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

Double2ObjectSortedMap<V> tailMap(double 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.

firstDoubleKey

double firstDoubleKey()

A method to get the first Key of a Map.

Returns:

the first key in the map

pollFirstDoubleKey

double pollFirstDoubleKey()

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

Returns:

the first key in the map

lastDoubleKey

double lastDoubleKey()

A method to get the last Key of a Map.

Returns:

the last key in the map

pollLastDoubleKey

double pollLastDoubleKey()

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.Double firstKey()

Deprecated.

Specified by:

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

lastKey

@Deprecated
default java.lang.Double lastKey()

Deprecated.

Specified by:

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

subMap

@Deprecated
default Double2ObjectSortedMap<V> subMap(java.lang.Double fromKey,
                                                      java.lang.Double toKey)

Deprecated.

Specified by:

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

headMap

@Deprecated
default Double2ObjectSortedMap<V> headMap(java.lang.Double toKey)

Deprecated.

Specified by:

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

tailMap

@Deprecated
default Double2ObjectSortedMap<V> tailMap(java.lang.Double fromKey)

Deprecated.

Specified by:

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