Char2ByteMaps.UnmodifyableOrderedMap (Primitive-Collections 0.8.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Character,java.lang.Byte>
- - speiger.src.collections.chars.maps.abstracts.AbstractChar2ByteMap
  - - speiger.src.collections.chars.utils.maps.Char2ByteMaps.UnmodifyableMap
    - - speiger.src.collections.chars.utils.maps.Char2ByteMaps.UnmodifyableOrderedMap

All Implemented Interfaces:

java.util.Map<java.lang.Character,java.lang.Byte>, Char2ByteFunction, Char2ByteMap, Char2ByteOrderedMap

Enclosing class:

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

Nested Class Summary
- Nested classes/interfaces inherited from class speiger.src.collections.chars.maps.abstracts.AbstractChar2ByteMap
  AbstractChar2ByteMap.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.chars.maps.interfaces.Char2ByteOrderedMap
  Char2ByteOrderedMap.FastOrderedSet
- Nested classes/interfaces inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ByteMap
  Char2ByteMap.BuilderCache, Char2ByteMap.Entry, Char2ByteMap.FastEntrySet, Char2ByteMap.MapBuilder

Method Summary

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

Methods inherited from class speiger.src.collections.chars.utils.maps.Char2ByteMaps.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.chars.maps.abstracts.AbstractChar2ByteMap
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.chars.maps.interfaces.Char2ByteOrderedMap
synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ByteMap
addTo, addToAll, applyAsByte, builder, compute, computeByte, computeByteIfAbsent, computeByteIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllByte, mergeByte, put, put, 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(char key,
                              byte value)
```
    Description copied from interface: Char2ByteOrderedMap
    
    A customized put method that allows you to insert into the first index.
    
    Specified by:
    
    putAndMoveToFirst in interface Char2ByteOrderedMap
    
    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(char key,
                             byte value)
```
    Description copied from interface: Char2ByteOrderedMap
    
    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 Char2ByteOrderedMap
    
    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(char key)
```
    Description copied from interface: Char2ByteOrderedMap
    
    A specific move method to move a given key/value to the first index.
    
    Specified by:
    
    moveToFirst in interface Char2ByteOrderedMap
    
    Parameters:
    
    key - that should be moved to the first index
    
    Returns:
    
    true if the value was moved.
  - moveToLast
```
public boolean moveToLast(char key)
```
    Description copied from interface: Char2ByteOrderedMap
    
    A specific move method to move a given key/value to the last index.
    
    Specified by:
    
    moveToLast in interface Char2ByteOrderedMap
    
    Parameters:
    
    key - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
  - getAndMoveToFirst
```
public byte getAndMoveToFirst(char key)
```
    Description copied from interface: Char2ByteOrderedMap
    
    A Specific get method that allows to move teh given key/value int the first index.
    
    Specified by:
    
    getAndMoveToFirst in interface Char2ByteOrderedMap
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - getAndMoveToLast
```
public byte getAndMoveToLast(char key)
```
    Description copied from interface: Char2ByteOrderedMap
    
    A Specific get method that allows to move teh given key/value int the last index.
    
    Specified by:
    
    getAndMoveToLast in interface Char2ByteOrderedMap
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - firstCharKey
```
public char firstCharKey()
```
    Description copied from interface: Char2ByteOrderedMap
    
    A method to get the first Key of a Map.
    
    Specified by:
    
    firstCharKey in interface Char2ByteOrderedMap
    
    Returns:
    
    the first key in the map
  - pollFirstCharKey
```
public char pollFirstCharKey()
```
    Description copied from interface: Char2ByteOrderedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstCharKey in interface Char2ByteOrderedMap
    
    Returns:
    
    the first key in the map
  - lastCharKey
```
public char lastCharKey()
```
    Description copied from interface: Char2ByteOrderedMap
    
    A method to get the last Key of a Map.
    
    Specified by:
    
    lastCharKey in interface Char2ByteOrderedMap
    
    Returns:
    
    the last key in the map
  - pollLastCharKey
```
public char pollLastCharKey()
```
    Description copied from interface: Char2ByteOrderedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastCharKey in interface Char2ByteOrderedMap
    
    Returns:
    
    the last key in the map
  - firstByteValue
```
public byte firstByteValue()
```
    Description copied from interface: Char2ByteOrderedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstByteValue in interface Char2ByteOrderedMap
    
    Returns:
    
    the first key in the map
  - lastByteValue
```
public byte lastByteValue()
```
    Description copied from interface: Char2ByteOrderedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastByteValue in interface Char2ByteOrderedMap
    
    Returns:
    
    the last key in the map
  - copy
```
public Char2ByteOrderedMap copy()
```
    Description copied from interface: Char2ByteMap
    
    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 Char2ByteMap
    
    Specified by:
    
    copy in interface Char2ByteOrderedMap
    
    Overrides:
    
    copy in class Char2ByteMaps.UnmodifyableMap
    
    Returns:
    
    a Shallow Copy of the Map
  - keySet
```
public CharOrderedSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Character,java.lang.Byte>
    
    Specified by:
    
    keySet in interface Char2ByteMap
    
    Specified by:
    
    keySet in interface Char2ByteOrderedMap
    
    Overrides:
    
    keySet in class Char2ByteMaps.UnmodifyableMap
  - char2ByteEntrySet
```
public ObjectOrderedSet<Char2ByteMap.Entry> char2ByteEntrySet()
```
    Description copied from interface: Char2ByteMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    char2ByteEntrySet in interface Char2ByteMap
    
    Specified by:
    
    char2ByteEntrySet in interface Char2ByteOrderedMap
    
    Overrides:
    
    char2ByteEntrySet in class Char2ByteMaps.UnmodifyableMap
    
    Returns:
    
    a EntrySet of the collection

Class Char2ByteMaps.UnmodifyableOrderedMap

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.chars.maps.abstracts.AbstractChar2ByteMap

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

Nested classes/interfaces inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ByteOrderedMap

Nested classes/interfaces inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ByteMap

Method Summary

Methods inherited from class speiger.src.collections.chars.utils.maps.Char2ByteMaps.UnmodifyableMap

Methods inherited from class speiger.src.collections.chars.maps.abstracts.AbstractChar2ByteMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ByteOrderedMap

Methods inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ByteMap

Methods inherited from interface java.util.Map

Method Detail

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

firstCharKey

pollFirstCharKey

lastCharKey

pollLastCharKey

firstByteValue

lastByteValue

copy

keySet

char2ByteEntrySet