Byte2CharMaps.UnmodifyableOrderedMap (Primitive-Collections 0.7.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Byte,java.lang.Character>
- - speiger.src.collections.bytes.maps.abstracts.AbstractByte2CharMap
  - - speiger.src.collections.bytes.utils.maps.Byte2CharMaps.UnmodifyableMap
    - - speiger.src.collections.bytes.utils.maps.Byte2CharMaps.UnmodifyableOrderedMap

All Implemented Interfaces:

java.util.Map<java.lang.Byte,java.lang.Character>, Byte2CharFunction, Byte2CharMap, Byte2CharOrderedMap

Enclosing class:

Byte2CharMaps
```
public static class Byte2CharMaps.UnmodifyableOrderedMap
extends Byte2CharMaps.UnmodifyableMap
implements Byte2CharOrderedMap
```
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.AbstractByte2CharMap
  AbstractByte2CharMap.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.bytes.maps.interfaces.Byte2CharOrderedMap
  Byte2CharOrderedMap.FastOrderedSet
- Nested classes/interfaces inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2CharMap
  Byte2CharMap.BuilderCache, Byte2CharMap.Entry, Byte2CharMap.FastEntrySet, Byte2CharMap.MapBuilder

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ObjectOrderedSet<Byte2CharMap.Entry>`	`byte2CharEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`Byte2CharOrderedMap`	`copy()` A Function that does a shallow clone of the Map itself.
`byte`	`firstByteKey()` A method to get the first Key of a Map.
`char`	`firstCharValue()` A method to get the first Value of a Map.
`char`	`getAndMoveToFirst(byte key)` A Specific get method that allows to move teh given key/value int the first index.
`char`	`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.
`char`	`lastCharValue()` 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.
`char`	`putAndMoveToFirst(byte key, char value)` A customized put method that allows you to insert into the first index.
`char`	`putAndMoveToLast(byte key, char value)` A customized put method that allows you to insert into the last index.

Methods inherited from class speiger.src.collections.bytes.utils.maps.Byte2CharMaps.UnmodifyableMap
addTo, clear, computeChar, computeCharIfAbsent, computeCharIfPresent, get, getOrDefault, mergeAllChar, mergeChar, put, putIfAbsent, remove, remove, removeOrDefault, replaceChars, replaceChars, subFrom, supplyCharIfAbsent, values

Methods inherited from class speiger.src.collections.bytes.maps.abstracts.AbstractByte2CharMap
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.bytes.maps.interfaces.Byte2CharOrderedMap
synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2CharMap
addTo, addToAll, builder, compute, computeChar, computeCharIfAbsent, computeCharIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllChar, mergeChar, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceChars, replaceChars, setDefaultReturnValue, subFrom, supplyCharIfAbsent, values

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

- Method Detail
  - putAndMoveToFirst
```
public char putAndMoveToFirst(byte key,
                              char value)
```
    Description copied from interface: Byte2CharOrderedMap
    
    A customized put method that allows you to insert into the first index.
    
    Specified by:
    
    putAndMoveToFirst in interface Byte2CharOrderedMap
    
    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 char putAndMoveToLast(byte key,
                             char value)
```
    Description copied from interface: Byte2CharOrderedMap
    
    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 Byte2CharOrderedMap
    
    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: Byte2CharOrderedMap
    
    A specific move method to move a given key/value to the first index.
    
    Specified by:
    
    moveToFirst in interface Byte2CharOrderedMap
    
    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: Byte2CharOrderedMap
    
    A specific move method to move a given key/value to the last index.
    
    Specified by:
    
    moveToLast in interface Byte2CharOrderedMap
    
    Parameters:
    
    key - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
  - getAndMoveToFirst
```
public char getAndMoveToFirst(byte key)
```
    Description copied from interface: Byte2CharOrderedMap
    
    A Specific get method that allows to move teh given key/value int the first index.
    
    Specified by:
    
    getAndMoveToFirst in interface Byte2CharOrderedMap
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - getAndMoveToLast
```
public char getAndMoveToLast(byte key)
```
    Description copied from interface: Byte2CharOrderedMap
    
    A Specific get method that allows to move teh given key/value int the last index.
    
    Specified by:
    
    getAndMoveToLast in interface Byte2CharOrderedMap
    
    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: Byte2CharOrderedMap
    
    A method to get the first Key of a Map.
    
    Specified by:
    
    firstByteKey in interface Byte2CharOrderedMap
    
    Returns:
    
    the first key in the map
  - pollFirstByteKey
```
public byte pollFirstByteKey()
```
    Description copied from interface: Byte2CharOrderedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstByteKey in interface Byte2CharOrderedMap
    
    Returns:
    
    the first key in the map
  - lastByteKey
```
public byte lastByteKey()
```
    Description copied from interface: Byte2CharOrderedMap
    
    A method to get the last Key of a Map.
    
    Specified by:
    
    lastByteKey in interface Byte2CharOrderedMap
    
    Returns:
    
    the last key in the map
  - pollLastByteKey
```
public byte pollLastByteKey()
```
    Description copied from interface: Byte2CharOrderedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastByteKey in interface Byte2CharOrderedMap
    
    Returns:
    
    the last key in the map
  - firstCharValue
```
public char firstCharValue()
```
    Description copied from interface: Byte2CharOrderedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstCharValue in interface Byte2CharOrderedMap
    
    Returns:
    
    the first key in the map
  - lastCharValue
```
public char lastCharValue()
```
    Description copied from interface: Byte2CharOrderedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastCharValue in interface Byte2CharOrderedMap
    
    Returns:
    
    the last key in the map
  - copy
```
public Byte2CharOrderedMap copy()
```
    Description copied from interface: Byte2CharMap
    
    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 Byte2CharMap
    
    Specified by:
    
    copy in interface Byte2CharOrderedMap
    
    Overrides:
    
    copy in class Byte2CharMaps.UnmodifyableMap
    
    Returns:
    
    a Shallow Copy of the Map
  - keySet
```
public ByteOrderedSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Byte,java.lang.Character>
    
    Specified by:
    
    keySet in interface Byte2CharMap
    
    Specified by:
    
    keySet in interface Byte2CharOrderedMap
    
    Overrides:
    
    keySet in class Byte2CharMaps.UnmodifyableMap
  - byte2CharEntrySet
```
public ObjectOrderedSet<Byte2CharMap.Entry> byte2CharEntrySet()
```
    Description copied from interface: Byte2CharMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    byte2CharEntrySet in interface Byte2CharMap
    
    Specified by:
    
    byte2CharEntrySet in interface Byte2CharOrderedMap
    
    Overrides:
    
    byte2CharEntrySet in class Byte2CharMaps.UnmodifyableMap
    
    Returns:
    
    a EntrySet of the collection

Class Byte2CharMaps.UnmodifyableOrderedMap

Nested Class Summary

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

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

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

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

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface java.util.Map

Method Detail

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

firstByteKey

pollFirstByteKey

lastByteKey

pollLastByteKey

firstCharValue

lastCharValue

copy

keySet

byte2CharEntrySet