Double2ByteMaps.UnmodifyableOrderedMap (Primitive-Collections 0.7.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Double,java.lang.Byte>
- - speiger.src.collections.doubles.maps.abstracts.AbstractDouble2ByteMap
  - - speiger.src.collections.doubles.utils.maps.Double2ByteMaps.UnmodifyableMap
    - - speiger.src.collections.doubles.utils.maps.Double2ByteMaps.UnmodifyableOrderedMap

All Implemented Interfaces:

java.util.Map<java.lang.Double,java.lang.Byte>, Double2ByteFunction, Double2ByteMap, Double2ByteOrderedMap

Enclosing class:

Double2ByteMaps
```
public static class Double2ByteMaps.UnmodifyableOrderedMap
extends Double2ByteMaps.UnmodifyableMap
implements Double2ByteOrderedMap
```
The Unmodifyable Ordered Map implementation that is sued for the unmodifyableMap function

Nested Class Summary
- Nested classes/interfaces inherited from class speiger.src.collections.doubles.maps.abstracts.AbstractDouble2ByteMap
  AbstractDouble2ByteMap.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.doubles.maps.interfaces.Double2ByteOrderedMap
  Double2ByteOrderedMap.FastOrderedSet
- Nested classes/interfaces inherited from interface speiger.src.collections.doubles.maps.interfaces.Double2ByteMap
  Double2ByteMap.BuilderCache, Double2ByteMap.Entry, Double2ByteMap.FastEntrySet, Double2ByteMap.MapBuilder

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Double2ByteOrderedMap`	`copy()` A Function that does a shallow clone of the Map itself.
`ObjectOrderedSet<Double2ByteMap.Entry>`	`double2ByteEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`byte`	`firstByteValue()` A method to get the first Value of a Map.
`double`	`firstDoubleKey()` A method to get the first Key of a Map.
`byte`	`getAndMoveToFirst(double key)` A Specific get method that allows to move teh given key/value int the first index.
`byte`	`getAndMoveToLast(double key)` A Specific get method that allows to move teh given key/value int the last index.
`DoubleOrderedSet`	`keySet()`
`byte`	`lastByteValue()` A method to get the last Value of a Map.
`double`	`lastDoubleKey()` A method to get the last Key of a Map.
`boolean`	`moveToFirst(double key)` A specific move method to move a given key/value to the first index.
`boolean`	`moveToLast(double key)` A specific move method to move a given key/value to the last index.
`double`	`pollFirstDoubleKey()` A method to get and remove the first Key of a Map.
`double`	`pollLastDoubleKey()` A method to get and remove the last Key of a Map.
`byte`	`putAndMoveToFirst(double key, byte value)` A customized put method that allows you to insert into the first index.
`byte`	`putAndMoveToLast(double key, byte value)` A customized put method that allows you to insert into the last index.

Methods inherited from class speiger.src.collections.doubles.utils.maps.Double2ByteMaps.UnmodifyableMap
addTo, clear, computeByte, computeByteIfAbsent, computeByteIfPresent, get, getOrDefault, mergeAllByte, mergeByte, put, putIfAbsent, remove, remove, removeOrDefault, replaceBytes, replaceBytes, subFrom, supplyByteIfAbsent, values

Methods inherited from class speiger.src.collections.doubles.maps.abstracts.AbstractDouble2ByteMap
addToAll, 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, containsValue, isEmpty, size, toString

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

Methods inherited from interface speiger.src.collections.doubles.maps.interfaces.Double2ByteOrderedMap
synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.doubles.maps.interfaces.Double2ByteMap
addTo, addToAll, builder, compute, computeByte, computeByteIfAbsent, computeByteIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllByte, mergeByte, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceBytes, replaceBytes, setDefaultReturnValue, subFrom, supplyByteIfAbsent, values

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

- Method Detail
  - putAndMoveToFirst
```
public byte putAndMoveToFirst(double key,
                              byte value)
```
    Description copied from interface: Double2ByteOrderedMap
    
    A customized put method that allows you to insert into the first index.
    
    Specified by:
    
    putAndMoveToFirst in interface Double2ByteOrderedMap
    
    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 byte putAndMoveToLast(double key,
                             byte value)
```
    Description copied from interface: Double2ByteOrderedMap
    
    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 Double2ByteOrderedMap
    
    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(double key)
```
    Description copied from interface: Double2ByteOrderedMap
    
    A specific move method to move a given key/value to the first index.
    
    Specified by:
    
    moveToFirst in interface Double2ByteOrderedMap
    
    Parameters:
    
    key - that should be moved to the first index
    
    Returns:
    
    true if the value was moved.
  - moveToLast
```
public boolean moveToLast(double key)
```
    Description copied from interface: Double2ByteOrderedMap
    
    A specific move method to move a given key/value to the last index.
    
    Specified by:
    
    moveToLast in interface Double2ByteOrderedMap
    
    Parameters:
    
    key - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
  - getAndMoveToFirst
```
public byte getAndMoveToFirst(double key)
```
    Description copied from interface: Double2ByteOrderedMap
    
    A Specific get method that allows to move teh given key/value int the first index.
    
    Specified by:
    
    getAndMoveToFirst in interface Double2ByteOrderedMap
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - getAndMoveToLast
```
public byte getAndMoveToLast(double key)
```
    Description copied from interface: Double2ByteOrderedMap
    
    A Specific get method that allows to move teh given key/value int the last index.
    
    Specified by:
    
    getAndMoveToLast in interface Double2ByteOrderedMap
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - firstDoubleKey
```
public double firstDoubleKey()
```
    Description copied from interface: Double2ByteOrderedMap
    
    A method to get the first Key of a Map.
    
    Specified by:
    
    firstDoubleKey in interface Double2ByteOrderedMap
    
    Returns:
    
    the first key in the map
  - pollFirstDoubleKey
```
public double pollFirstDoubleKey()
```
    Description copied from interface: Double2ByteOrderedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstDoubleKey in interface Double2ByteOrderedMap
    
    Returns:
    
    the first key in the map
  - lastDoubleKey
```
public double lastDoubleKey()
```
    Description copied from interface: Double2ByteOrderedMap
    
    A method to get the last Key of a Map.
    
    Specified by:
    
    lastDoubleKey in interface Double2ByteOrderedMap
    
    Returns:
    
    the last key in the map
  - pollLastDoubleKey
```
public double pollLastDoubleKey()
```
    Description copied from interface: Double2ByteOrderedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastDoubleKey in interface Double2ByteOrderedMap
    
    Returns:
    
    the last key in the map
  - firstByteValue
```
public byte firstByteValue()
```
    Description copied from interface: Double2ByteOrderedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstByteValue in interface Double2ByteOrderedMap
    
    Returns:
    
    the first key in the map
  - lastByteValue
```
public byte lastByteValue()
```
    Description copied from interface: Double2ByteOrderedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastByteValue in interface Double2ByteOrderedMap
    
    Returns:
    
    the last key in the map
  - copy
```
public Double2ByteOrderedMap copy()
```
    Description copied from interface: Double2ByteMap
    
    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 Double2ByteMap
    
    Specified by:
    
    copy in interface Double2ByteOrderedMap
    
    Overrides:
    
    copy in class Double2ByteMaps.UnmodifyableMap
    
    Returns:
    
    a Shallow Copy of the Map
  - keySet
```
public DoubleOrderedSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Double,java.lang.Byte>
    
    Specified by:
    
    keySet in interface Double2ByteMap
    
    Specified by:
    
    keySet in interface Double2ByteOrderedMap
    
    Overrides:
    
    keySet in class Double2ByteMaps.UnmodifyableMap
  - double2ByteEntrySet
```
public ObjectOrderedSet<Double2ByteMap.Entry> double2ByteEntrySet()
```
    Description copied from interface: Double2ByteMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    double2ByteEntrySet in interface Double2ByteMap
    
    Specified by:
    
    double2ByteEntrySet in interface Double2ByteOrderedMap
    
    Overrides:
    
    double2ByteEntrySet in class Double2ByteMaps.UnmodifyableMap
    
    Returns:
    
    a EntrySet of the collection

Class Double2ByteMaps.UnmodifyableOrderedMap

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.doubles.maps.abstracts.AbstractDouble2ByteMap

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

Nested classes/interfaces inherited from interface speiger.src.collections.doubles.maps.interfaces.Double2ByteOrderedMap

Nested classes/interfaces inherited from interface speiger.src.collections.doubles.maps.interfaces.Double2ByteMap

Method Summary

Methods inherited from class speiger.src.collections.doubles.utils.maps.Double2ByteMaps.UnmodifyableMap

Methods inherited from class speiger.src.collections.doubles.maps.abstracts.AbstractDouble2ByteMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.doubles.maps.interfaces.Double2ByteOrderedMap

Methods inherited from interface speiger.src.collections.doubles.maps.interfaces.Double2ByteMap

Methods inherited from interface java.util.Map

Method Detail

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

firstDoubleKey

pollFirstDoubleKey

lastDoubleKey

pollLastDoubleKey

firstByteValue

lastByteValue

copy

keySet

double2ByteEntrySet