Char2ObjectMaps.UnmodifyableOrderedMap (Primitive-Collections 0.7.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Character,V>
- - speiger.src.collections.chars.maps.abstracts.AbstractChar2ObjectMap<V>
  - - speiger.src.collections.chars.utils.maps.Char2ObjectMaps.UnmodifyableMap<V>
    - - speiger.src.collections.chars.utils.maps.Char2ObjectMaps.UnmodifyableOrderedMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.Map<java.lang.Character,V>, Char2ObjectFunction<V>, Char2ObjectMap<V>, Char2ObjectOrderedMap<V>

Enclosing class:

Char2ObjectMaps
```
public static class Char2ObjectMaps.UnmodifyableOrderedMap<V>
extends Char2ObjectMaps.UnmodifyableMap<V>
implements Char2ObjectOrderedMap<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.chars.maps.abstracts.AbstractChar2ObjectMap
  AbstractChar2ObjectMap.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.chars.maps.interfaces.Char2ObjectOrderedMap
  Char2ObjectOrderedMap.FastOrderedSet<V>
- Nested classes/interfaces inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ObjectMap
  Char2ObjectMap.BuilderCache<V>, Char2ObjectMap.Entry<V>, Char2ObjectMap.FastEntrySet<V>, Char2ObjectMap.MapBuilder

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ObjectOrderedSet<Char2ObjectMap.Entry<V>>`	`char2ObjectEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`Char2ObjectOrderedMap<V>`	`copy()` A Function that does a shallow clone of the Map itself.
`char`	`firstCharKey()` A method to get the first Key of a Map.
`V`	`firstValue()` A method to get the first Value of a Map.
`V`	`getAndMoveToFirst(char key)` A Specific get method that allows to move teh given key/value int the first index.
`V`	`getAndMoveToLast(char key)` A Specific get method that allows to move teh given key/value int the last index.
`CharOrderedSet`	`keySet()`
`char`	`lastCharKey()` A method to get the last Key of a Map.
`V`	`lastValue()` A method to get the last Value 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.
`V`	`putAndMoveToFirst(char key, V value)` A customized put method that allows you to insert into the first index.
`V`	`putAndMoveToLast(char key, V value)` A customized put method that allows you to insert into the last index.

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

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

Class Char2ObjectMaps.UnmodifyableOrderedMap<V>

Nested Class Summary

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

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

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

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

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface java.util.Map

Method Detail

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

firstCharKey

pollFirstCharKey

lastCharKey

pollLastCharKey

firstValue

lastValue

copy

keySet

char2ObjectEntrySet