Object2CharMaps.UnmodifyableOrderedMap (Primitive-Collections 0.7.0 API)

java.lang.Object
- java.util.AbstractMap<T,java.lang.Character>
- - speiger.src.collections.objects.maps.abstracts.AbstractObject2CharMap<T>
  - - speiger.src.collections.objects.utils.maps.Object2CharMaps.UnmodifyableMap<T>
    - - speiger.src.collections.objects.utils.maps.Object2CharMaps.UnmodifyableOrderedMap<T>

Type Parameters:

T - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.Map<T,java.lang.Character>, Object2CharFunction<T>, Object2CharMap<T>, Object2CharOrderedMap<T>

Enclosing class:

Object2CharMaps
```
public static class Object2CharMaps.UnmodifyableOrderedMap<T>
extends Object2CharMaps.UnmodifyableMap<T>
implements Object2CharOrderedMap<T>
```
The Unmodifyable Ordered Map implementation that is sued for the unmodifyableMap function

Nested Class Summary
- Nested classes/interfaces inherited from class speiger.src.collections.objects.maps.abstracts.AbstractObject2CharMap
  AbstractObject2CharMap.BasicEntry<T>
- 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.objects.maps.interfaces.Object2CharOrderedMap
  Object2CharOrderedMap.FastOrderedSet<T>
- Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2CharMap
  Object2CharMap.BuilderCache<T>, Object2CharMap.Entry<T>, Object2CharMap.FastEntrySet<T>, Object2CharMap.MapBuilder

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object2CharOrderedMap<T>`	`copy()` A Function that does a shallow clone of the Map itself.
`char`	`firstCharValue()` A method to get the first Value of a Map.
`T`	`firstKey()` A method to get the first Key of a Map.
`char`	`getAndMoveToFirst(T key)` A Specific get method that allows to move teh given key/value int the first index.
`char`	`getAndMoveToLast(T key)` A Specific get method that allows to move teh given key/value int the last index.
`ObjectOrderedSet<T>`	`keySet()`
`char`	`lastCharValue()` A method to get the last Value of a Map.
`T`	`lastKey()` A method to get the last Key of a Map.
`boolean`	`moveToFirst(T key)` A specific move method to move a given key/value to the first index.
`boolean`	`moveToLast(T key)` A specific move method to move a given key/value to the last index.
`ObjectOrderedSet<Object2CharMap.Entry<T>>`	`object2CharEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`T`	`pollFirstKey()` A method to get and remove the first Key of a Map.
`T`	`pollLastKey()` A method to get and remove the last Key of a Map.
`char`	`putAndMoveToFirst(T key, char value)` A customized put method that allows you to insert into the first index.
`char`	`putAndMoveToLast(T key, char value)` A customized put method that allows you to insert into the last index.

Methods inherited from class speiger.src.collections.objects.utils.maps.Object2CharMaps.UnmodifyableMap
addTo, clear, computeChar, computeCharIfAbsent, computeCharIfPresent, getChar, getOrDefault, mergeAllChar, mergeChar, put, putIfAbsent, rem, remOrDefault, remove, replaceChars, replaceChars, subFrom, supplyCharIfAbsent, values

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

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

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2CharOrderedMap
synchronize, synchronize, unmodifiable

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

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

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

Class Object2CharMaps.UnmodifyableOrderedMap<T>

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.objects.maps.abstracts.AbstractObject2CharMap

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

Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2CharOrderedMap

Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2CharMap

Method Summary

Methods inherited from class speiger.src.collections.objects.utils.maps.Object2CharMaps.UnmodifyableMap

Methods inherited from class speiger.src.collections.objects.maps.abstracts.AbstractObject2CharMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2CharOrderedMap

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2CharMap

Methods inherited from interface java.util.Map

Method Detail

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

firstKey

pollFirstKey

lastKey

pollLastKey

firstCharValue

lastCharValue

copy

keySet

object2CharEntrySet