Object2ObjectSortedMap (Primitive-Collections 0.7.0 API)

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

All Superinterfaces:

java.util.function.Function<T,V>, java.util.Map<T,V>, Object2ObjectFunction<T,V>, Object2ObjectMap<T,V>, java.util.SortedMap<T,V>

All Known Subinterfaces:

Object2ObjectNavigableMap<T,V>

All Known Implementing Classes:

Object2ObjectAVLTreeMap, Object2ObjectMaps.SynchronizedNavigableMap, Object2ObjectMaps.SynchronizedSortedMap, Object2ObjectMaps.UnmodifyableNavigableMap, Object2ObjectMaps.UnmodifyableSortedMap, Object2ObjectRBTreeMap
```
public interface Object2ObjectSortedMap<T,V>
extends java.util.SortedMap<T,V>, Object2ObjectMap<T,V>
```
A Type Specific SortedMap interface to reduce boxing/unboxing, with a couple extra methods that allow greater control over maps.

Note:

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

Nested Class Summary

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

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`java.util.Comparator<T>`	`comparator()`
`Object2ObjectSortedMap<T,V>`	`copy()` A Function that does a shallow clone of the Map itself.
`V`	`firstValue()` A method to get the first Value of a Map.
`Object2ObjectSortedMap<T,V>`	`headMap(T toKey)`
`ObjectSortedSet<T>`	`keySet()`
`V`	`lastValue()` 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.
`Object2ObjectSortedMap<T,V>`	`subMap(T fromKey, T toKey)`
`default Object2ObjectSortedMap<T,V>`	`synchronize()` Creates a Wrapped SortedMap that is Synchronized
`default Object2ObjectSortedMap<T,V>`	`synchronize(java.lang.Object mutex)` Creates a Wrapped SortedMap that is Synchronized
`Object2ObjectSortedMap<T,V>`	`tailMap(T fromKey)`
`default Object2ObjectSortedMap<T,V>`	`unmodifiable()` Creates a Wrapped SortedMap that is unmodifiable
`ObjectCollection<V>`	`values()`

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

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2ObjectMap
builder, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, entrySet, forEach, forEach, getDefaultReturnValue, merge, merge, mergeAll, object2ObjectEntrySet, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, rem, remOrDefault, remove, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue, supplyIfAbsent

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

Methods inherited from interface speiger.src.collections.objects.functions.function.Object2ObjectFunction
apply, getObject

Methods inherited from interface java.util.function.Function
andThen, compose, identity

- Method Detail
  - comparator
```
java.util.Comparator<T> comparator()
```
    Specified by:
    
    comparator in interface java.util.SortedMap<T,V>
  - copy
```
Object2ObjectSortedMap<T,V> copy()
```
    Description copied from interface: Object2ObjectMap
    
    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 Object2ObjectMap<T,V>
    
    Returns:
    
    a Shallow Copy of the Map
  - keySet
```
ObjectSortedSet<T> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<T,V>
    
    Specified by:
    
    keySet in interface Object2ObjectMap<T,V>
    
    Specified by:
    
    keySet in interface java.util.SortedMap<T,V>
  - values
```
ObjectCollection<V> values()
```
    Specified by:
    
    values in interface java.util.Map<T,V>
    
    Specified by:
    
    values in interface Object2ObjectMap<T,V>
    
    Specified by:
    
    values in interface java.util.SortedMap<T,V>
  - synchronize
```
default Object2ObjectSortedMap<T,V> synchronize()
```
    Creates a Wrapped SortedMap that is Synchronized
    
    Specified by:
    
    synchronize in interface Object2ObjectMap<T,V>
    
    Returns:
    
    a new SortedMap that is synchronized
    
    See Also:
    
    Object2ObjectMaps.synchronize(speiger.src.collections.objects.maps.interfaces.Object2ObjectMap<T, V>)
  - synchronize
```
default Object2ObjectSortedMap<T,V> synchronize(java.lang.Object mutex)
```
    Creates a Wrapped SortedMap that is Synchronized
    
    Specified by:
    
    synchronize in interface Object2ObjectMap<T,V>
    
    Parameters:
    
    mutex - is the controller of the synchronization block
    
    Returns:
    
    a new SortedMap Wrapper that is synchronized
    
    See Also:
    
    Object2ObjectMaps.synchronize(speiger.src.collections.objects.maps.interfaces.Object2ObjectMap<T, V>)
  - unmodifiable
```
default Object2ObjectSortedMap<T,V> unmodifiable()
```
    Creates a Wrapped SortedMap that is unmodifiable
    
    Specified by:
    
    unmodifiable in interface Object2ObjectMap<T,V>
    
    Returns:
    
    a new SortedMap Wrapper that is unmodifiable
    
    See Also:
    
    Object2ObjectMaps.unmodifiable(speiger.src.collections.objects.maps.interfaces.Object2ObjectMap<T, V>)
  - 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
  - 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
  - subMap
```
Object2ObjectSortedMap<T,V> subMap(T fromKey,
                                   T toKey)
```
    Specified by:
    
    subMap in interface java.util.SortedMap<T,V>
  - headMap
```
Object2ObjectSortedMap<T,V> headMap(T toKey)
```
    Specified by:
    
    headMap in interface java.util.SortedMap<T,V>
  - tailMap
```
Object2ObjectSortedMap<T,V> tailMap(T fromKey)
```
    Specified by:
    
    tailMap in interface java.util.SortedMap<T,V>

Interface Object2ObjectSortedMap<T,V>

Nested Class Summary

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

Method Summary

Methods inherited from interface java.util.SortedMap

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

Methods inherited from interface java.util.Map

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

Methods inherited from interface java.util.function.Function

Method Detail

comparator

copy

keySet

values

synchronize

synchronize

unmodifiable

pollFirstKey

pollLastKey

firstValue

lastValue

subMap

headMap

tailMap