Byte2ObjectMaps.UnmodifyableOrderedMap (Primitive-Collections 0.8.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.UnmodifyableOrderedMap<V>

Type Parameters:

V - the keyType of elements maintained by this Collection

All Implemented Interfaces:

java.util.Map<java.lang.Byte,V>, ByteFunction<V>, Byte2ObjectMap<V>, Byte2ObjectOrderedMap<V>

Enclosing class:

Byte2ObjectMaps
```
public static class Byte2ObjectMaps.UnmodifyableOrderedMap<V>
extends Byte2ObjectMaps.UnmodifyableMap<V>
implements Byte2ObjectOrderedMap<V>
```
The Unmodifyable Ordered 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.Byte2ObjectOrderedMap
  Byte2ObjectOrderedMap.FastOrderedSet<V>
- Nested classes/interfaces inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2ObjectMap
  Byte2ObjectMap.BuilderCache<V>, Byte2ObjectMap.Entry<V>, Byte2ObjectMap.FastEntrySet<V>, Byte2ObjectMap.MapBuilder

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ObjectOrderedSet<Byte2ObjectMap.Entry<V>>`	`byte2ObjectEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`Byte2ObjectOrderedMap<V>`	`copy()` A Function that does a shallow clone of the Map itself.
`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.
`ByteOrderedSet`	`keySet()`
`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.

Methods inherited from class speiger.src.collections.bytes.utils.maps.Byte2ObjectMaps.UnmodifyableMap
clear, compute, computeIfAbsent, computeIfPresent, get, getOrDefault, merge, mergeAll, put, putIfAbsent, remove, remove, removeOrDefault, replaceObjects, replaceObjects, supplyIfAbsent, values

Methods inherited from class speiger.src.collections.bytes.maps.abstracts.AbstractByte2ObjectMap
containsKey, containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, remove, replace, replace, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap
containsKey, isEmpty, 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.Byte2ObjectOrderedMap
synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2ObjectMap
apply, builder, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, merge, mergeAll, put, put, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue, supplyIfAbsent, values

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: Byte2ObjectOrderedMap
    
    A customized put method that allows you to insert into the first index.
    
    Specified by:
    
    putAndMoveToFirst in interface Byte2ObjectOrderedMap<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: Byte2ObjectOrderedMap
    
    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 Byte2ObjectOrderedMap<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: Byte2ObjectOrderedMap
    
    A specific move method to move a given key/value to the first index.
    
    Specified by:
    
    moveToFirst in interface Byte2ObjectOrderedMap<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: Byte2ObjectOrderedMap
    
    A specific move method to move a given key/value to the last index.
    
    Specified by:
    
    moveToLast in interface Byte2ObjectOrderedMap<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: Byte2ObjectOrderedMap
    
    A Specific get method that allows to move teh given key/value int the first index.
    
    Specified by:
    
    getAndMoveToFirst in interface Byte2ObjectOrderedMap<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: Byte2ObjectOrderedMap
    
    A Specific get method that allows to move teh given key/value int the last index.
    
    Specified by:
    
    getAndMoveToLast in interface Byte2ObjectOrderedMap<V>
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - firstByteKey
```
public byte firstByteKey()
```
    Description copied from interface: Byte2ObjectOrderedMap
    
    A method to get the first Key of a Map.
    
    Specified by:
    
    firstByteKey in interface Byte2ObjectOrderedMap<V>
    
    Returns:
    
    the first key in the map
  - pollFirstByteKey
```
public byte pollFirstByteKey()
```
    Description copied from interface: Byte2ObjectOrderedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstByteKey in interface Byte2ObjectOrderedMap<V>
    
    Returns:
    
    the first key in the map
  - lastByteKey
```
public byte lastByteKey()
```
    Description copied from interface: Byte2ObjectOrderedMap
    
    A method to get the last Key of a Map.
    
    Specified by:
    
    lastByteKey in interface Byte2ObjectOrderedMap<V>
    
    Returns:
    
    the last key in the map
  - pollLastByteKey
```
public byte pollLastByteKey()
```
    Description copied from interface: Byte2ObjectOrderedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastByteKey in interface Byte2ObjectOrderedMap<V>
    
    Returns:
    
    the last key in the map
  - firstValue
```
public V firstValue()
```
    Description copied from interface: Byte2ObjectOrderedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstValue in interface Byte2ObjectOrderedMap<V>
    
    Returns:
    
    the first key in the map
  - lastValue
```
public V lastValue()
```
    Description copied from interface: Byte2ObjectOrderedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastValue in interface Byte2ObjectOrderedMap<V>
    
    Returns:
    
    the last key in the map
  - copy
```
public Byte2ObjectOrderedMap<V> copy()
```
    Description copied from interface: Byte2ObjectMap
    
    A Function that does a shallow clone of the Map itself. This function is more optimized then a copy constructor since the Map does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk
    
    Specified by:
    
    copy in interface Byte2ObjectMap<V>
    
    Specified by:
    
    copy in interface Byte2ObjectOrderedMap<V>
    
    Overrides:
    
    copy in class Byte2ObjectMaps.UnmodifyableMap<V>
    
    Returns:
    
    a Shallow Copy of the Map
  - keySet
```
public ByteOrderedSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Byte,V>
    
    Specified by:
    
    keySet in interface Byte2ObjectMap<V>
    
    Specified by:
    
    keySet in interface Byte2ObjectOrderedMap<V>
    
    Overrides:
    
    keySet in class Byte2ObjectMaps.UnmodifyableMap<V>
  - byte2ObjectEntrySet
```
public ObjectOrderedSet<Byte2ObjectMap.Entry<V>> byte2ObjectEntrySet()
```
    Description copied from interface: Byte2ObjectMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    byte2ObjectEntrySet in interface Byte2ObjectMap<V>
    
    Specified by:
    
    byte2ObjectEntrySet in interface Byte2ObjectOrderedMap<V>
    
    Overrides:
    
    byte2ObjectEntrySet in class Byte2ObjectMaps.UnmodifyableMap<V>
    
    Returns:
    
    a EntrySet of the collection

Class Byte2ObjectMaps.UnmodifyableOrderedMap<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.Byte2ObjectOrderedMap

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.Byte2ObjectOrderedMap

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

firstByteKey

pollFirstByteKey

lastByteKey

pollLastByteKey

firstValue

lastValue

copy

keySet

byte2ObjectEntrySet