Object2CharSortedMap (Primitive-Collections 0.2.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:

LinkedEnum2CharMap, Object2CharArrayMap, Object2CharAVLTreeMap, Object2CharLinkedOpenCustomHashMap, Object2CharLinkedOpenHashMap, 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.

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.Entry<T>, Object2CharMap.FastEntrySet<T>

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`java.util.Comparator<T>`	`comparator()`
`char`	`firstCharValue()` A method to get the first Value of a Map.
`char`	`getAndMoveToFirst(T key)` A Specific get method that allows to move teh given key/value int the first index.
`char`	`getAndMoveToLast(T key)` A Specific get method that allows to move teh given key/value int the last index.
`default Object2CharSortedMap<T>`	`headMap(T toKey)`
`ObjectSet<T>`	`keySet()`
`char`	`lastCharValue()` A method to get the last Value of a Map.
`boolean`	`moveToFirst(T key)` A specific move method to move a given key/value to the first index.
`boolean`	`moveToLast(T key)` A specific move method to move a given key/value to the last index.
`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.
`char`	`putAndMoveToFirst(T key, char value)` A customized put method that allows you to insert into the first index.
`char`	`putAndMoveToLast(T key, char value)` A customized put method that allows you to insert into the last index.
`default Object2CharSortedMap<T>`	`subMap(T fromKey, T toKey)`
`default Object2CharSortedMap<T>`	`tailMap(T fromKey)`
`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, 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, putAllIfAbsent, putIfAbsent, putIfAbsent, rem, remOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceChars, replaceChars, setDefaultReturnValue

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

- Method Detail
  - putAndMoveToFirst
```
char putAndMoveToFirst(T key,
                       char value)
```
    A customized put method that allows you to insert into the first index.
    
    Parameters:
    
    key - the key that should be inserted
    
    value - the value that should be inserted
    
    Returns:
    
    the previous present or default return value
    
    See Also:
    
    Map.put(Object, Object)
    
    Note:
    
    some implementations do not support this method
  - putAndMoveToLast
```
char putAndMoveToLast(T key,
                      char value)
```
    A customized put method that allows you to insert into the last index. (This may be nessesary depending on the implementation)
    
    Parameters:
    
    key - the key that should be inserted
    
    value - the value that should be inserted
    
    Returns:
    
    the previous present or default return value
    
    See Also:
    
    Map.put(Object, Object)
    
    Note:
    
    some implementations do not support this method
  - moveToFirst
```
boolean moveToFirst(T key)
```
    A specific move method to move a given key/value to the first index.
    
    Parameters:
    
    key - that should be moved to the first index
    
    Returns:
    
    true if the value was moved.
    
    Note:
    
    returns false if the value was not present in the first place, some implementations do not support this method
  - moveToLast
```
boolean moveToLast(T key)
```
    A specific move method to move a given key/value to the last index.
    
    Parameters:
    
    key - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
    
    Note:
    
    returns false if the value was not present in the first place, some implementations do not support this method
  - getAndMoveToFirst
```
char getAndMoveToFirst(T key)
```
    A Specific get method that allows to move teh given key/value int the first index.
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
    
    Note:
    
    some implementations do not support this method
  - getAndMoveToLast
```
char getAndMoveToLast(T key)
```
    A Specific get method that allows to move teh given key/value int the last index.
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
    
    Note:
    
    some implementations do not support this method
  - comparator
```
java.util.Comparator<T> comparator()
```
    Specified by:
    
    comparator in interface java.util.SortedMap<T,java.lang.Character>
  - keySet
```
ObjectSet<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>
  - 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
```
default Object2CharSortedMap<T> subMap(T fromKey,
                                       T toKey)
```
    Specified by:
    
    subMap in interface java.util.SortedMap<T,java.lang.Character>
  - headMap
```
default Object2CharSortedMap<T> headMap(T toKey)
```
    Specified by:
    
    headMap in interface java.util.SortedMap<T,java.lang.Character>
  - tailMap
```
default 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

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

comparator

keySet

values

pollFirstKey

pollLastKey

firstCharValue

lastCharValue

subMap

headMap

tailMap