Object2CharSortedMap (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.Character>, Object2CharFunction<T>, Object2CharMap<T>, java.util.SortedMap<T,java.lang.Character>

All Known Subinterfaces:

Object2CharNavigableMap<T>

All Known Implementing Classes:

Object2CharAVLTreeMap, Object2CharMaps.SynchronizedNavigableMap, Object2CharMaps.SynchronizedSortedMap, Object2CharMaps.UnmodifyableNavigableMap, Object2CharMaps.UnmodifyableSortedMap, Object2CharRBTreeMap
```
public interface Object2CharSortedMap<T>
extends java.util.SortedMap<T,java.lang.Character>, Object2CharMap<T>
```
A Type Specific SortedMap interface to reduce boxing/unboxing, with a couple extra methods that allow greater control over maps.

Note:

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

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Object2CharSortedMap.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.Object2CharMap
Object2CharMap.BuilderCache<T>, Object2CharMap.Entry<T>, Object2CharMap.FastEntrySet<T>, Object2CharMap.MapBuilder

Method Summary

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

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

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2CharMap
addTo, addToAll, builder, compute, computeChar, computeCharIfAbsent, computeCharIfPresent, computeIfAbsent, computeIfPresent, containsValue, containsValue, entrySet, forEach, forEach, get, getChar, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllChar, mergeChar, object2CharEntrySet, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, rem, remOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceChars, replaceChars, setDefaultReturnValue, subFrom, supplyCharIfAbsent

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

- Method Detail
  - comparator
```
java.util.Comparator<T> comparator()
```
    Specified by:
    
    comparator in interface java.util.SortedMap<T,java.lang.Character>
  - copy
```
Object2CharSortedMap<T> copy()
```
    Description copied from interface: Object2CharMap
    
    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 Object2CharMap<T>
    
    Returns:
    
    a Shallow Copy of the Map
  - keySet
```
ObjectSortedSet<T> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<T,java.lang.Character>
    
    Specified by:
    
    keySet in interface Object2CharMap<T>
    
    Specified by:
    
    keySet in interface java.util.SortedMap<T,java.lang.Character>
  - values
```
CharCollection values()
```
    Specified by:
    
    values in interface java.util.Map<T,java.lang.Character>
    
    Specified by:
    
    values in interface Object2CharMap<T>
    
    Specified by:
    
    values in interface java.util.SortedMap<T,java.lang.Character>
  - synchronize
```
default Object2CharSortedMap<T> synchronize()
```
    Creates a Wrapped SortedMap that is Synchronized
    
    Specified by:
    
    synchronize in interface Object2CharMap<T>
    
    Returns:
    
    a new SortedMap that is synchronized
    
    See Also:
    
    Object2CharMaps.synchronize(speiger.src.collections.objects.maps.interfaces.Object2CharMap<T>)
  - synchronize
```
default Object2CharSortedMap<T> synchronize(java.lang.Object mutex)
```
    Creates a Wrapped SortedMap that is Synchronized
    
    Specified by:
    
    synchronize in interface Object2CharMap<T>
    
    Parameters:
    
    mutex - is the controller of the synchronization block
    
    Returns:
    
    a new SortedMap Wrapper that is synchronized
    
    See Also:
    
    Object2CharMaps.synchronize(speiger.src.collections.objects.maps.interfaces.Object2CharMap<T>)
  - unmodifiable
```
default Object2CharSortedMap<T> unmodifiable()
```
    Creates a Wrapped SortedMap that is unmodifiable
    
    Specified by:
    
    unmodifiable in interface Object2CharMap<T>
    
    Returns:
    
    a new SortedMap Wrapper that is unmodifiable
    
    See Also:
    
    Object2CharMaps.unmodifiable(speiger.src.collections.objects.maps.interfaces.Object2CharMap<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
  - firstCharValue
```
char firstCharValue()
```
    A method to get the first Value of a Map.
    
    Returns:
    
    the first key in the map
  - lastCharValue
```
char lastCharValue()
```
    A method to get the last Value of a Map.
    
    Returns:
    
    the last key in the map
  - subMap
```
Object2CharSortedMap<T> subMap(T fromKey,
                               T toKey)
```
    Specified by:
    
    subMap in interface java.util.SortedMap<T,java.lang.Character>
  - headMap
```
Object2CharSortedMap<T> headMap(T toKey)
```
    Specified by:
    
    headMap in interface java.util.SortedMap<T,java.lang.Character>
  - tailMap
```
Object2CharSortedMap<T> tailMap(T fromKey)
```
    Specified by:
    
    tailMap in interface java.util.SortedMap<T,java.lang.Character>

Interface Object2CharSortedMap<T>

Nested Class Summary

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

Method Summary

Methods inherited from interface java.util.SortedMap

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

Methods inherited from interface java.util.Map

Method Detail

comparator

copy

keySet

values

synchronize

synchronize

unmodifiable

pollFirstKey

pollLastKey

firstCharValue

lastCharValue

subMap

headMap

tailMap