Char2IntMaps.UnmodifyableOrderedMap (Primitive-Collections 0.7.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Character,java.lang.Integer>
- - speiger.src.collections.chars.maps.abstracts.AbstractChar2IntMap
  - - speiger.src.collections.chars.utils.maps.Char2IntMaps.UnmodifyableMap
    - - speiger.src.collections.chars.utils.maps.Char2IntMaps.UnmodifyableOrderedMap

All Implemented Interfaces:

java.util.Map<java.lang.Character,java.lang.Integer>, Char2IntFunction, Char2IntMap, Char2IntOrderedMap

Enclosing class:

Char2IntMaps
```
public static class Char2IntMaps.UnmodifyableOrderedMap
extends Char2IntMaps.UnmodifyableMap
implements Char2IntOrderedMap
```
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.AbstractChar2IntMap
  AbstractChar2IntMap.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.Char2IntOrderedMap
  Char2IntOrderedMap.FastOrderedSet
- Nested classes/interfaces inherited from interface speiger.src.collections.chars.maps.interfaces.Char2IntMap
  Char2IntMap.BuilderCache, Char2IntMap.Entry, Char2IntMap.FastEntrySet, Char2IntMap.MapBuilder

Method Summary

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

Methods inherited from class speiger.src.collections.chars.utils.maps.Char2IntMaps.UnmodifyableMap
addTo, clear, computeInt, computeIntIfAbsent, computeIntIfPresent, get, getOrDefault, mergeAllInt, mergeInt, put, putIfAbsent, remove, remove, removeOrDefault, replaceInts, replaceInts, subFrom, supplyIntIfAbsent, values

Methods inherited from class speiger.src.collections.chars.maps.abstracts.AbstractChar2IntMap
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.Char2IntOrderedMap
synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.chars.maps.interfaces.Char2IntMap
addTo, addToAll, builder, compute, computeIfAbsent, computeIfPresent, computeInt, computeIntIfAbsent, computeIntIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllInt, mergeInt, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceInts, replaceInts, setDefaultReturnValue, subFrom, supplyIntIfAbsent, values

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

- Method Detail
  - putAndMoveToFirst
```
public int putAndMoveToFirst(char key,
                             int value)
```
    Description copied from interface: Char2IntOrderedMap
    
    A customized put method that allows you to insert into the first index.
    
    Specified by:
    
    putAndMoveToFirst in interface Char2IntOrderedMap
    
    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 int putAndMoveToLast(char key,
                            int value)
```
    Description copied from interface: Char2IntOrderedMap
    
    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 Char2IntOrderedMap
    
    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: Char2IntOrderedMap
    
    A specific move method to move a given key/value to the first index.
    
    Specified by:
    
    moveToFirst in interface Char2IntOrderedMap
    
    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: Char2IntOrderedMap
    
    A specific move method to move a given key/value to the last index.
    
    Specified by:
    
    moveToLast in interface Char2IntOrderedMap
    
    Parameters:
    
    key - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
  - getAndMoveToFirst
```
public int getAndMoveToFirst(char key)
```
    Description copied from interface: Char2IntOrderedMap
    
    A Specific get method that allows to move teh given key/value int the first index.
    
    Specified by:
    
    getAndMoveToFirst in interface Char2IntOrderedMap
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - getAndMoveToLast
```
public int getAndMoveToLast(char key)
```
    Description copied from interface: Char2IntOrderedMap
    
    A Specific get method that allows to move teh given key/value int the last index.
    
    Specified by:
    
    getAndMoveToLast in interface Char2IntOrderedMap
    
    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: Char2IntOrderedMap
    
    A method to get the first Key of a Map.
    
    Specified by:
    
    firstCharKey in interface Char2IntOrderedMap
    
    Returns:
    
    the first key in the map
  - pollFirstCharKey
```
public char pollFirstCharKey()
```
    Description copied from interface: Char2IntOrderedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstCharKey in interface Char2IntOrderedMap
    
    Returns:
    
    the first key in the map
  - lastCharKey
```
public char lastCharKey()
```
    Description copied from interface: Char2IntOrderedMap
    
    A method to get the last Key of a Map.
    
    Specified by:
    
    lastCharKey in interface Char2IntOrderedMap
    
    Returns:
    
    the last key in the map
  - pollLastCharKey
```
public char pollLastCharKey()
```
    Description copied from interface: Char2IntOrderedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastCharKey in interface Char2IntOrderedMap
    
    Returns:
    
    the last key in the map
  - firstIntValue
```
public int firstIntValue()
```
    Description copied from interface: Char2IntOrderedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstIntValue in interface Char2IntOrderedMap
    
    Returns:
    
    the first key in the map
  - lastIntValue
```
public int lastIntValue()
```
    Description copied from interface: Char2IntOrderedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastIntValue in interface Char2IntOrderedMap
    
    Returns:
    
    the last key in the map
  - copy
```
public Char2IntOrderedMap copy()
```
    Description copied from interface: Char2IntMap
    
    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 Char2IntMap
    
    Specified by:
    
    copy in interface Char2IntOrderedMap
    
    Overrides:
    
    copy in class Char2IntMaps.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.Integer>
    
    Specified by:
    
    keySet in interface Char2IntMap
    
    Specified by:
    
    keySet in interface Char2IntOrderedMap
    
    Overrides:
    
    keySet in class Char2IntMaps.UnmodifyableMap
  - char2IntEntrySet
```
public ObjectOrderedSet<Char2IntMap.Entry> char2IntEntrySet()
```
    Description copied from interface: Char2IntMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    char2IntEntrySet in interface Char2IntMap
    
    Specified by:
    
    char2IntEntrySet in interface Char2IntOrderedMap
    
    Overrides:
    
    char2IntEntrySet in class Char2IntMaps.UnmodifyableMap
    
    Returns:
    
    a EntrySet of the collection

Class Char2IntMaps.UnmodifyableOrderedMap

Nested Class Summary

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

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

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

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

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface java.util.Map

Method Detail

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

firstCharKey

pollFirstCharKey

lastCharKey

pollLastCharKey

firstIntValue

lastIntValue

copy

keySet

char2IntEntrySet