Object2DoubleSortedMap (Primitive-Collections 0.7.0 API)

Type Parameters:

T - the type of elements maintained by this Collection

All Superinterfaces:

java.util.Map<T,java.lang.Double>, Object2DoubleFunction<T>, Object2DoubleMap<T>, java.util.SortedMap<T,java.lang.Double>, java.util.function.ToDoubleFunction<T>

All Known Subinterfaces:

Object2DoubleNavigableMap<T>

All Known Implementing Classes:

Object2DoubleAVLTreeMap, Object2DoubleMaps.SynchronizedNavigableMap, Object2DoubleMaps.SynchronizedSortedMap, Object2DoubleMaps.UnmodifyableNavigableMap, Object2DoubleMaps.UnmodifyableSortedMap, Object2DoubleRBTreeMap
```
public interface Object2DoubleSortedMap<T>
extends java.util.SortedMap<T,java.lang.Double>, Object2DoubleMap<T>
```
A Type Specific SortedMap interface to reduce boxing/unboxing, with a couple extra methods that allow greater control over maps.

Note:

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

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Object2DoubleSortedMap.FastSortedSet<T>` 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.objects.maps.interfaces.Object2DoubleMap
Object2DoubleMap.BuilderCache<T>, Object2DoubleMap.Entry<T>, Object2DoubleMap.FastEntrySet<T>, Object2DoubleMap.MapBuilder

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`java.util.Comparator<T>`	`comparator()`
`Object2DoubleSortedMap<T>`	`copy()` A Function that does a shallow clone of the Map itself.
`double`	`firstDoubleValue()` A method to get the first Value of a Map.
`Object2DoubleSortedMap<T>`	`headMap(T toKey)`
`ObjectSortedSet<T>`	`keySet()`
`double`	`lastDoubleValue()` A method to get the last Value of a Map.
`T`	`pollFirstKey()` A method to get and remove the first Key of a Map.
`T`	`pollLastKey()` A method to get and remove the last Key of a Map.
`Object2DoubleSortedMap<T>`	`subMap(T fromKey, T toKey)`
`default Object2DoubleSortedMap<T>`	`synchronize()` Creates a Wrapped SortedMap that is Synchronized
`default Object2DoubleSortedMap<T>`	`synchronize(java.lang.Object mutex)` Creates a Wrapped SortedMap that is Synchronized
`Object2DoubleSortedMap<T>`	`tailMap(T fromKey)`
`default Object2DoubleSortedMap<T>`	`unmodifiable()` Creates a Wrapped SortedMap that is unmodifiable
`DoubleCollection`	`values()`

Methods inherited from interface java.util.SortedMap
entrySet, firstKey, lastKey

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2DoubleMap
addTo, addToAll, builder, compute, computeDouble, computeDoubleIfAbsent, computeDoubleIfPresent, computeIfAbsent, computeIfPresent, containsValue, containsValue, entrySet, forEach, forEach, get, getDefaultReturnValue, getDouble, getOrDefault, getOrDefault, merge, mergeAllDouble, mergeDouble, object2DoubleEntrySet, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, rem, remOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceDoubles, replaceDoubles, setDefaultReturnValue, subFrom, supplyDoubleIfAbsent

Methods inherited from interface java.util.Map
clear, containsKey, equals, hashCode, isEmpty, putAll, size

Methods inherited from interface speiger.src.collections.objects.functions.function.Object2DoubleFunction
applyAsDouble

- Method Detail
  - comparator
```
java.util.Comparator<T> comparator()
```
    Specified by:
    
    comparator in interface java.util.SortedMap<T,java.lang.Double>
  - copy
```
Object2DoubleSortedMap<T> copy()
```
    Description copied from interface: Object2DoubleMap
    
    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 Object2DoubleMap<T>
    
    Returns:
    
    a Shallow Copy of the Map
  - keySet
```
ObjectSortedSet<T> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<T,java.lang.Double>
    
    Specified by:
    
    keySet in interface Object2DoubleMap<T>
    
    Specified by:
    
    keySet in interface java.util.SortedMap<T,java.lang.Double>
  - values
```
DoubleCollection values()
```
    Specified by:
    
    values in interface java.util.Map<T,java.lang.Double>
    
    Specified by:
    
    values in interface Object2DoubleMap<T>
    
    Specified by:
    
    values in interface java.util.SortedMap<T,java.lang.Double>
  - synchronize
```
default Object2DoubleSortedMap<T> synchronize()
```
    Creates a Wrapped SortedMap that is Synchronized
    
    Specified by:
    
    synchronize in interface Object2DoubleMap<T>
    
    Returns:
    
    a new SortedMap that is synchronized
    
    See Also:
    
    Object2DoubleMaps.synchronize(speiger.src.collections.objects.maps.interfaces.Object2DoubleMap<T>)
  - synchronize
```
default Object2DoubleSortedMap<T> synchronize(java.lang.Object mutex)
```
    Creates a Wrapped SortedMap that is Synchronized
    
    Specified by:
    
    synchronize in interface Object2DoubleMap<T>
    
    Parameters:
    
    mutex - is the controller of the synchronization block
    
    Returns:
    
    a new SortedMap Wrapper that is synchronized
    
    See Also:
    
    Object2DoubleMaps.synchronize(speiger.src.collections.objects.maps.interfaces.Object2DoubleMap<T>)
  - unmodifiable
```
default Object2DoubleSortedMap<T> unmodifiable()
```
    Creates a Wrapped SortedMap that is unmodifiable
    
    Specified by:
    
    unmodifiable in interface Object2DoubleMap<T>
    
    Returns:
    
    a new SortedMap Wrapper that is unmodifiable
    
    See Also:
    
    Object2DoubleMaps.unmodifiable(speiger.src.collections.objects.maps.interfaces.Object2DoubleMap<T>)
  - pollFirstKey
```
T pollFirstKey()
```
    A method to get and remove the first Key of a Map.
    
    Returns:
    
    the first key in the map
  - pollLastKey
```
T pollLastKey()
```
    A method to get and remove the last Key of a Map.
    
    Returns:
    
    the last key in the map
  - firstDoubleValue
```
double firstDoubleValue()
```
    A method to get the first Value of a Map.
    
    Returns:
    
    the first key in the map
  - lastDoubleValue
```
double lastDoubleValue()
```
    A method to get the last Value of a Map.
    
    Returns:
    
    the last key in the map
  - subMap
```
Object2DoubleSortedMap<T> subMap(T fromKey,
                                 T toKey)
```
    Specified by:
    
    subMap in interface java.util.SortedMap<T,java.lang.Double>
  - headMap
```
Object2DoubleSortedMap<T> headMap(T toKey)
```
    Specified by:
    
    headMap in interface java.util.SortedMap<T,java.lang.Double>
  - tailMap
```
Object2DoubleSortedMap<T> tailMap(T fromKey)
```
    Specified by:
    
    tailMap in interface java.util.SortedMap<T,java.lang.Double>

Interface Object2DoubleSortedMap<T>

Nested Class Summary

Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2DoubleMap

Method Summary

Methods inherited from interface java.util.SortedMap

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2DoubleMap

Methods inherited from interface java.util.Map

Methods inherited from interface speiger.src.collections.objects.functions.function.Object2DoubleFunction

Method Detail

comparator

copy

keySet

values

synchronize

synchronize

unmodifiable

pollFirstKey

pollLastKey

firstDoubleValue

lastDoubleValue

subMap

headMap

tailMap