Byte2ObjectMaps.UnmodifyableSortedMap (Primitive-Collections 0.2.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Byte,V>
- - speiger.src.collections.bytes.maps.abstracts.AbstractByte2ObjectMap<V>
  - - speiger.src.collections.bytes.utils.maps.Byte2ObjectMaps.UnmodifyableMap<V>
    - - speiger.src.collections.bytes.utils.maps.Byte2ObjectMaps.UnmodifyableSortedMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.Map<java.lang.Byte,V>, java.util.SortedMap<java.lang.Byte,V>, Byte2ObjectFunction<V>, Byte2ObjectMap<V>, Byte2ObjectSortedMap<V>

Direct Known Subclasses:

Byte2ObjectMaps.UnmodifyableNavigableMap

Enclosing class:

Byte2ObjectMaps
```
public static class Byte2ObjectMaps.UnmodifyableSortedMap<V>
extends Byte2ObjectMaps.UnmodifyableMap<V>
implements Byte2ObjectSortedMap<V>
```
The Unmodifyable Sorted Map implementation that is sued for the unmodifyableMap function

Nested Class Summary
- Nested classes/interfaces inherited from class speiger.src.collections.bytes.maps.abstracts.AbstractByte2ObjectMap
  AbstractByte2ObjectMap.BasicEntry<V>
- 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.bytes.maps.interfaces.Byte2ObjectSortedMap
  Byte2ObjectSortedMap.FastSortedSet<V>
- Nested classes/interfaces inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2ObjectMap
  Byte2ObjectMap.Entry<V>, Byte2ObjectMap.FastEntrySet<V>

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ByteComparator`	`comparator()`
`byte`	`firstByteKey()` A method to get the first Key of a Map.
`V`	`firstValue()` A method to get the first Value of a Map.
`V`	`getAndMoveToFirst(byte key)` A Specific get method that allows to move teh given key/value int the first index.
`V`	`getAndMoveToLast(byte key)` A Specific get method that allows to move teh given key/value int the last index.
`Byte2ObjectSortedMap<V>`	`headMap(byte toKey)` A Type Specific HeadMap method to reduce boxing/unboxing
`byte`	`lastByteKey()` A method to get the last Key of a Map.
`V`	`lastValue()` A method to get the last Value of a Map.
`boolean`	`moveToFirst(byte key)` A specific move method to move a given key/value to the first index.
`boolean`	`moveToLast(byte key)` A specific move method to move a given key/value to the last index.
`byte`	`pollFirstByteKey()` A method to get and remove the first Key of a Map.
`byte`	`pollLastByteKey()` A method to get and remove the last Key of a Map.
`V`	`putAndMoveToFirst(byte key, V value)` A customized put method that allows you to insert into the first index.
`V`	`putAndMoveToLast(byte key, V value)` A customized put method that allows you to insert into the last index.
`Byte2ObjectSortedMap<V>`	`subMap(byte fromKey, byte toKey)` A Type Specific SubMap method to reduce boxing/unboxing
`Byte2ObjectSortedMap<V>`	`tailMap(byte fromKey)` A Type Specific TailMap method to reduce boxing/unboxing

Methods inherited from class speiger.src.collections.bytes.utils.maps.Byte2ObjectMaps.UnmodifyableMap
byte2ObjectEntrySet, getObject, getOrDefault, keySet, put, putIfAbsent, remByte, remByteOrDefault, remove, values

Methods inherited from class speiger.src.collections.bytes.maps.abstracts.AbstractByte2ObjectMap
compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, merge, mergeAll, putAll, putAll, putAll, putAllIfAbsent, replace, replace, replaceObjects, replaceObjects, setDefaultReturnValue

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

Methods inherited from interface java.util.SortedMap
entrySet

Methods inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2ObjectMap
byte2ObjectEntrySet, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, forEach, forEach, get, getDefaultReturnValue, getObject, getOrDefault, getOrDefault, merge, merge, mergeAll, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remByte, remByteOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue

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

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

Class Byte2ObjectMaps.UnmodifyableSortedMap<V>

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.bytes.maps.abstracts.AbstractByte2ObjectMap

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

Nested classes/interfaces inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2ObjectSortedMap

Nested classes/interfaces inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2ObjectMap

Method Summary

Methods inherited from class speiger.src.collections.bytes.utils.maps.Byte2ObjectMaps.UnmodifyableMap

Methods inherited from class speiger.src.collections.bytes.maps.abstracts.AbstractByte2ObjectMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2ObjectSortedMap

Methods inherited from interface java.util.SortedMap

Methods inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2ObjectMap

Methods inherited from interface java.util.Map

Method Detail

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

comparator

subMap

headMap

tailMap

firstByteKey

pollFirstByteKey

lastByteKey

pollLastByteKey

firstValue

lastValue