Short2DoubleMaps.UnmodifyableSortedMap (Primitive-Collections 0.2.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Short,java.lang.Double>
- - speiger.src.collections.shorts.maps.abstracts.AbstractShort2DoubleMap
  - - speiger.src.collections.shorts.utils.maps.Short2DoubleMaps.UnmodifyableMap
    - - speiger.src.collections.shorts.utils.maps.Short2DoubleMaps.UnmodifyableSortedMap

All Implemented Interfaces:

java.util.Map<java.lang.Short,java.lang.Double>, java.util.SortedMap<java.lang.Short,java.lang.Double>, Short2DoubleFunction, Short2DoubleMap, Short2DoubleSortedMap

Direct Known Subclasses:

Short2DoubleMaps.UnmodifyableNavigableMap

Enclosing class:

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

Nested Class Summary
- Nested classes/interfaces inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2DoubleMap
  AbstractShort2DoubleMap.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.shorts.maps.interfaces.Short2DoubleSortedMap
  Short2DoubleSortedMap.FastSortedSet
- Nested classes/interfaces inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2DoubleMap
  Short2DoubleMap.Entry, Short2DoubleMap.FastEntrySet

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ShortComparator`	`comparator()`
`double`	`firstDoubleValue()` A method to get the first Value of a Map.
`short`	`firstShortKey()` A method to get the first Key of a Map.
`double`	`getAndMoveToFirst(short key)` A Specific get method that allows to move teh given key/value int the first index.
`double`	`getAndMoveToLast(short key)` A Specific get method that allows to move teh given key/value int the last index.
`Short2DoubleSortedMap`	`headMap(short toKey)` A Type Specific HeadMap method to reduce boxing/unboxing
`double`	`lastDoubleValue()` A method to get the last Value of a Map.
`short`	`lastShortKey()` A method to get the last Key of a Map.
`boolean`	`moveToFirst(short key)` A specific move method to move a given key/value to the first index.
`boolean`	`moveToLast(short key)` A specific move method to move a given key/value to the last index.
`short`	`pollFirstShortKey()` A method to get and remove the first Key of a Map.
`short`	`pollLastShortKey()` A method to get and remove the last Key of a Map.
`double`	`putAndMoveToFirst(short key, double value)` A customized put method that allows you to insert into the first index.
`double`	`putAndMoveToLast(short key, double value)` A customized put method that allows you to insert into the last index.
`Short2DoubleSortedMap`	`subMap(short fromKey, short toKey)` A Type Specific SubMap method to reduce boxing/unboxing
`Short2DoubleSortedMap`	`tailMap(short fromKey)` A Type Specific TailMap method to reduce boxing/unboxing

Methods inherited from class speiger.src.collections.shorts.utils.maps.Short2DoubleMaps.UnmodifyableMap
addTo, getDouble, getOrDefault, keySet, put, putIfAbsent, remove, remShort, remShortOrDefault, short2DoubleEntrySet, values

Methods inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2DoubleMap
addToAll, computeDouble, computeDoubleIfAbsent, computeDoubleIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, mergeAllDouble, mergeDouble, putAll, putAll, putAll, putAllIfAbsent, replace, replace, replaceDoubles, replaceDoubles, 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.shorts.maps.interfaces.Short2DoubleSortedMap
firstKey, headMap, keySet, lastKey, subMap, tailMap, values

Methods inherited from interface java.util.SortedMap
entrySet

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2DoubleMap
addTo, addToAll, compute, computeDouble, computeDoubleIfAbsent, computeDoubleIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, getDefaultReturnValue, getDouble, getOrDefault, getOrDefault, merge, mergeAllDouble, mergeDouble, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remShort, remShortOrDefault, replace, replace, replace, replace, replaceAll, replaceDoubles, replaceDoubles, setDefaultReturnValue, short2DoubleEntrySet

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

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

Class Short2DoubleMaps.UnmodifyableSortedMap

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2DoubleMap

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

Nested classes/interfaces inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2DoubleSortedMap

Nested classes/interfaces inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2DoubleMap

Method Summary

Methods inherited from class speiger.src.collections.shorts.utils.maps.Short2DoubleMaps.UnmodifyableMap

Methods inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2DoubleMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2DoubleSortedMap

Methods inherited from interface java.util.SortedMap

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2DoubleMap

Methods inherited from interface java.util.Map

Method Detail

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

comparator

subMap

headMap

tailMap

firstShortKey

pollFirstShortKey

lastShortKey

pollLastShortKey

firstDoubleValue

lastDoubleValue