Object2CharMaps.UnmodifyableSortedMap (Primitive-Collections 0.2.0 API)

java.lang.Object
- java.util.AbstractMap<T,java.lang.Character>
- - speiger.src.collections.objects.maps.abstracts.AbstractObject2CharMap<T>
  - - speiger.src.collections.objects.utils.maps.Object2CharMaps.UnmodifyableMap<T>
    - - speiger.src.collections.objects.utils.maps.Object2CharMaps.UnmodifyableSortedMap<T>

Type Parameters:

T - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.Map<T,java.lang.Character>, java.util.SortedMap<T,java.lang.Character>, Object2CharFunction<T>, Object2CharMap<T>, Object2CharSortedMap<T>

Direct Known Subclasses:

Object2CharMaps.UnmodifyableNavigableMap

Enclosing class:

Object2CharMaps
```
public static class Object2CharMaps.UnmodifyableSortedMap<T>
extends Object2CharMaps.UnmodifyableMap<T>
implements Object2CharSortedMap<T>
```
The Unmodifyable Sorted Map implementation that is sued for the unmodifyableMap function

Nested Class Summary
- Nested classes/interfaces inherited from class speiger.src.collections.objects.maps.abstracts.AbstractObject2CharMap
  AbstractObject2CharMap.BasicEntry<T>
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2CharSortedMap
  Object2CharSortedMap.FastSortedSet<T>
- 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 Concrete Methods
Modifier and Type	Method and Description
`java.util.Comparator<T>`	`comparator()`
`char`	`firstCharValue()` A method to get the first Value of a Map.
`T`	`firstKey()`
`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.
`Object2CharSortedMap<T>`	`headMap(T toKey)`
`char`	`lastCharValue()` A method to get the last Value of a Map.
`T`	`lastKey()`
`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.
`Object2CharSortedMap<T>`	`subMap(T fromKey, T toKey)`
`Object2CharSortedMap<T>`	`tailMap(T fromKey)`

Methods inherited from class speiger.src.collections.objects.utils.maps.Object2CharMaps.UnmodifyableMap
addTo, getChar, getOrDefault, keySet, object2CharEntrySet, put, putIfAbsent, rem, remOrDefault, remove, values

Methods inherited from class speiger.src.collections.objects.maps.abstracts.AbstractObject2CharMap
addToAll, computeChar, computeCharIfAbsent, computeCharIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, mergeAllChar, mergeChar, putAll, putAll, putAll, putAllIfAbsent, replace, replace, replaceChars, replaceChars, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap
clear, containsValue, isEmpty, put, remove, size, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2CharSortedMap
keySet, values

Methods inherited from interface java.util.SortedMap
entrySet

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
```
public char putAndMoveToFirst(T key,
                              char value)
```
    Description copied from interface: Object2CharSortedMap
    
    A customized put method that allows you to insert into the first index.
    
    Specified by:
    
    putAndMoveToFirst in interface Object2CharSortedMap<T>
    
    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)
  - putAndMoveToLast
```
public char putAndMoveToLast(T key,
                             char value)
```
    Description copied from interface: Object2CharSortedMap
    
    A customized put method that allows you to insert into the last index. (This may be nessesary depending on the implementation)
    
    Specified by:
    
    putAndMoveToLast in interface Object2CharSortedMap<T>
    
    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)
  - moveToFirst
```
public boolean moveToFirst(T key)
```
    Description copied from interface: Object2CharSortedMap
    
    A specific move method to move a given key/value to the first index.
    
    Specified by:
    
    moveToFirst in interface Object2CharSortedMap<T>
    
    Parameters:
    
    key - that should be moved to the first index
    
    Returns:
    
    true if the value was moved.
  - moveToLast
```
public boolean moveToLast(T key)
```
    Description copied from interface: Object2CharSortedMap
    
    A specific move method to move a given key/value to the last index.
    
    Specified by:
    
    moveToLast in interface Object2CharSortedMap<T>
    
    Parameters:
    
    key - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
  - getAndMoveToFirst
```
public char getAndMoveToFirst(T key)
```
    Description copied from interface: Object2CharSortedMap
    
    A Specific get method that allows to move teh given key/value int the first index.
    
    Specified by:
    
    getAndMoveToFirst in interface Object2CharSortedMap<T>
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - getAndMoveToLast
```
public char getAndMoveToLast(T key)
```
    Description copied from interface: Object2CharSortedMap
    
    A Specific get method that allows to move teh given key/value int the last index.
    
    Specified by:
    
    getAndMoveToLast in interface Object2CharSortedMap<T>
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - comparator
```
public java.util.Comparator<T> comparator()
```
    Specified by:
    
    comparator in interface java.util.SortedMap<T,java.lang.Character>
    
    Specified by:
    
    comparator in interface Object2CharSortedMap<T>
  - subMap
```
public Object2CharSortedMap<T> subMap(T fromKey,
                                      T toKey)
```
    Specified by:
    
    subMap in interface java.util.SortedMap<T,java.lang.Character>
    
    Specified by:
    
    subMap in interface Object2CharSortedMap<T>
  - headMap
```
public Object2CharSortedMap<T> headMap(T toKey)
```
    Specified by:
    
    headMap in interface java.util.SortedMap<T,java.lang.Character>
    
    Specified by:
    
    headMap in interface Object2CharSortedMap<T>
  - tailMap
```
public Object2CharSortedMap<T> tailMap(T fromKey)
```
    Specified by:
    
    tailMap in interface java.util.SortedMap<T,java.lang.Character>
    
    Specified by:
    
    tailMap in interface Object2CharSortedMap<T>
  - firstKey
```
public T firstKey()
```
    Specified by:
    
    firstKey in interface java.util.SortedMap<T,java.lang.Character>
  - pollFirstKey
```
public T pollFirstKey()
```
    Description copied from interface: Object2CharSortedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstKey in interface Object2CharSortedMap<T>
    
    Returns:
    
    the first key in the map
  - lastKey
```
public T lastKey()
```
    Specified by:
    
    lastKey in interface java.util.SortedMap<T,java.lang.Character>
  - pollLastKey
```
public T pollLastKey()
```
    Description copied from interface: Object2CharSortedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastKey in interface Object2CharSortedMap<T>
    
    Returns:
    
    the last key in the map
  - firstCharValue
```
public char firstCharValue()
```
    Description copied from interface: Object2CharSortedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstCharValue in interface Object2CharSortedMap<T>
    
    Returns:
    
    the first key in the map
  - lastCharValue
```
public char lastCharValue()
```
    Description copied from interface: Object2CharSortedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastCharValue in interface Object2CharSortedMap<T>
    
    Returns:
    
    the last key in the map

Class Object2CharMaps.UnmodifyableSortedMap<T>

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.objects.maps.abstracts.AbstractObject2CharMap

Nested classes/interfaces inherited from class java.util.AbstractMap

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

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

Method Summary

Methods inherited from class speiger.src.collections.objects.utils.maps.Object2CharMaps.UnmodifyableMap

Methods inherited from class speiger.src.collections.objects.maps.abstracts.AbstractObject2CharMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

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

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

subMap

headMap

tailMap

firstKey

pollFirstKey

lastKey

pollLastKey

firstCharValue

lastCharValue