Char2ShortMaps.UnmodifyableSortedMap (Primitive-Collections 0.2.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Character,java.lang.Short>
- - speiger.src.collections.chars.maps.abstracts.AbstractChar2ShortMap
  - - speiger.src.collections.chars.utils.maps.Char2ShortMaps.UnmodifyableMap
    - - speiger.src.collections.chars.utils.maps.Char2ShortMaps.UnmodifyableSortedMap

All Implemented Interfaces:

java.util.Map<java.lang.Character,java.lang.Short>, java.util.SortedMap<java.lang.Character,java.lang.Short>, Char2ShortFunction, Char2ShortMap, Char2ShortSortedMap

Direct Known Subclasses:

Char2ShortMaps.UnmodifyableNavigableMap

Enclosing class:

Char2ShortMaps
```
public static class Char2ShortMaps.UnmodifyableSortedMap
extends Char2ShortMaps.UnmodifyableMap
implements Char2ShortSortedMap
```
The Unmodifyable Sorted Map implementation that is sued for the unmodifyableMap function

Nested Class Summary
- Nested classes/interfaces inherited from class speiger.src.collections.chars.maps.abstracts.AbstractChar2ShortMap
  AbstractChar2ShortMap.BasicEntry
- 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.chars.maps.interfaces.Char2ShortSortedMap
  Char2ShortSortedMap.FastSortedSet
- Nested classes/interfaces inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ShortMap
  Char2ShortMap.Entry, Char2ShortMap.FastEntrySet

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CharComparator`	`comparator()`
`char`	`firstCharKey()` A method to get the first Key of a Map.
`short`	`firstShortValue()` A method to get the first Value of a Map.
`short`	`getAndMoveToFirst(char key)` A Specific get method that allows to move teh given key/value int the first index.
`short`	`getAndMoveToLast(char key)` A Specific get method that allows to move teh given key/value int the last index.
`Char2ShortSortedMap`	`headMap(char toKey)` A Type Specific HeadMap method to reduce boxing/unboxing
`char`	`lastCharKey()` A method to get the last Key of a Map.
`short`	`lastShortValue()` A method to get the last Value of a Map.
`boolean`	`moveToFirst(char key)` A specific move method to move a given key/value to the first index.
`boolean`	`moveToLast(char key)` A specific move method to move a given key/value to the last index.
`char`	`pollFirstCharKey()` A method to get and remove the first Key of a Map.
`char`	`pollLastCharKey()` A method to get and remove the last Key of a Map.
`short`	`putAndMoveToFirst(char key, short value)` A customized put method that allows you to insert into the first index.
`short`	`putAndMoveToLast(char key, short value)` A customized put method that allows you to insert into the last index.
`Char2ShortSortedMap`	`subMap(char fromKey, char toKey)` A Type Specific SubMap method to reduce boxing/unboxing
`Char2ShortSortedMap`	`tailMap(char fromKey)` A Type Specific TailMap method to reduce boxing/unboxing

Methods inherited from class speiger.src.collections.chars.utils.maps.Char2ShortMaps.UnmodifyableMap
addTo, char2ShortEntrySet, getOrDefault, getShort, keySet, put, putIfAbsent, remChar, remCharOrDefault, remove, values

Methods inherited from class speiger.src.collections.chars.maps.abstracts.AbstractChar2ShortMap
addToAll, computeShort, computeShortIfAbsent, computeShortIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, mergeAllShort, mergeShort, putAll, putAll, putAll, putAllIfAbsent, replace, replace, replaceShorts, replaceShorts, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap
clear, containsKey, 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.chars.maps.interfaces.Char2ShortSortedMap
firstKey, headMap, keySet, lastKey, subMap, tailMap, values

Methods inherited from interface java.util.SortedMap
entrySet

Methods inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ShortMap
addTo, addToAll, char2ShortEntrySet, compute, computeIfAbsent, computeIfPresent, computeShort, computeShortIfAbsent, computeShortIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, getDefaultReturnValue, getOrDefault, getOrDefault, getShort, merge, mergeAllShort, mergeShort, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remChar, remCharOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceShorts, replaceShorts, setDefaultReturnValue

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

- Method Detail
  - putAndMoveToFirst
```
public short putAndMoveToFirst(char key,
                               short value)
```
    Description copied from interface: Char2ShortSortedMap
    
    A customized put method that allows you to insert into the first index.
    
    Specified by:
    
    putAndMoveToFirst in interface Char2ShortSortedMap
    
    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 short putAndMoveToLast(char key,
                              short value)
```
    Description copied from interface: Char2ShortSortedMap
    
    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 Char2ShortSortedMap
    
    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(char key)
```
    Description copied from interface: Char2ShortSortedMap
    
    A specific move method to move a given key/value to the first index.
    
    Specified by:
    
    moveToFirst in interface Char2ShortSortedMap
    
    Parameters:
    
    key - that should be moved to the first index
    
    Returns:
    
    true if the value was moved.
  - moveToLast
```
public boolean moveToLast(char key)
```
    Description copied from interface: Char2ShortSortedMap
    
    A specific move method to move a given key/value to the last index.
    
    Specified by:
    
    moveToLast in interface Char2ShortSortedMap
    
    Parameters:
    
    key - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
  - getAndMoveToFirst
```
public short getAndMoveToFirst(char key)
```
    Description copied from interface: Char2ShortSortedMap
    
    A Specific get method that allows to move teh given key/value int the first index.
    
    Specified by:
    
    getAndMoveToFirst in interface Char2ShortSortedMap
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - getAndMoveToLast
```
public short getAndMoveToLast(char key)
```
    Description copied from interface: Char2ShortSortedMap
    
    A Specific get method that allows to move teh given key/value int the last index.
    
    Specified by:
    
    getAndMoveToLast in interface Char2ShortSortedMap
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - comparator
```
public CharComparator comparator()
```
    Specified by:
    
    comparator in interface java.util.SortedMap<java.lang.Character,java.lang.Short>
    
    Specified by:
    
    comparator in interface Char2ShortSortedMap
  - subMap
```
public Char2ShortSortedMap subMap(char fromKey,
                                  char toKey)
```
    Description copied from interface: Char2ShortSortedMap
    
    A Type Specific SubMap method to reduce boxing/unboxing
    
    Specified by:
    
    subMap in interface Char2ShortSortedMap
    
    Parameters:
    
    fromKey - where the submap should start
    
    toKey - where the subMap should end
    
    Returns:
    
    a SubMap that is within the range of the desired range
  - headMap
```
public Char2ShortSortedMap headMap(char toKey)
```
    Description copied from interface: Char2ShortSortedMap
    
    A Type Specific HeadMap method to reduce boxing/unboxing
    
    Specified by:
    
    headMap in interface Char2ShortSortedMap
    
    Parameters:
    
    toKey - where the headMap should end
    
    Returns:
    
    a HeadMap that is within the range of the desired range
  - tailMap
```
public Char2ShortSortedMap tailMap(char fromKey)
```
    Description copied from interface: Char2ShortSortedMap
    
    A Type Specific TailMap method to reduce boxing/unboxing
    
    Specified by:
    
    tailMap in interface Char2ShortSortedMap
    
    Parameters:
    
    fromKey - where the TailMap should start
    
    Returns:
    
    a TailMap that is within the range of the desired range
  - firstCharKey
```
public char firstCharKey()
```
    Description copied from interface: Char2ShortSortedMap
    
    A method to get the first Key of a Map.
    
    Specified by:
    
    firstCharKey in interface Char2ShortSortedMap
    
    Returns:
    
    the first key in the map
  - pollFirstCharKey
```
public char pollFirstCharKey()
```
    Description copied from interface: Char2ShortSortedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstCharKey in interface Char2ShortSortedMap
    
    Returns:
    
    the first key in the map
  - lastCharKey
```
public char lastCharKey()
```
    Description copied from interface: Char2ShortSortedMap
    
    A method to get the last Key of a Map.
    
    Specified by:
    
    lastCharKey in interface Char2ShortSortedMap
    
    Returns:
    
    the last key in the map
  - pollLastCharKey
```
public char pollLastCharKey()
```
    Description copied from interface: Char2ShortSortedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastCharKey in interface Char2ShortSortedMap
    
    Returns:
    
    the last key in the map
  - firstShortValue
```
public short firstShortValue()
```
    Description copied from interface: Char2ShortSortedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstShortValue in interface Char2ShortSortedMap
    
    Returns:
    
    the first key in the map
  - lastShortValue
```
public short lastShortValue()
```
    Description copied from interface: Char2ShortSortedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastShortValue in interface Char2ShortSortedMap
    
    Returns:
    
    the last key in the map

Class Char2ShortMaps.UnmodifyableSortedMap

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.chars.maps.abstracts.AbstractChar2ShortMap

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

Nested classes/interfaces inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ShortSortedMap

Nested classes/interfaces inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ShortMap

Method Summary

Methods inherited from class speiger.src.collections.chars.utils.maps.Char2ShortMaps.UnmodifyableMap

Methods inherited from class speiger.src.collections.chars.maps.abstracts.AbstractChar2ShortMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ShortSortedMap

Methods inherited from interface java.util.SortedMap

Methods inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ShortMap

Methods inherited from interface java.util.Map

Method Detail

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

comparator

subMap

headMap

tailMap

firstCharKey

pollFirstCharKey

lastCharKey

pollLastCharKey

firstShortValue

lastShortValue