Int2CharLinkedOpenHashMap (Primitive-Collections 0.2.0 API)

java.lang.Object
- java.util.AbstractMap<java.lang.Integer,java.lang.Character>
- - speiger.src.collections.ints.maps.abstracts.AbstractInt2CharMap
  - - speiger.src.collections.ints.maps.impl.hash.Int2CharOpenHashMap
    - - speiger.src.collections.ints.maps.impl.hash.Int2CharLinkedOpenHashMap

All Implemented Interfaces:

java.util.Map<java.lang.Integer,java.lang.Character>, java.util.SortedMap<java.lang.Integer,java.lang.Character>, Int2CharFunction, Int2CharMap, Int2CharSortedMap
```
public class Int2CharLinkedOpenHashMap
extends Int2CharOpenHashMap
implements Int2CharSortedMap
```
A Type Specific LinkedHashMap implementation that uses specific arrays to create links between nodes to remove the wrapping of elements to greatly reduce memory usage. In Addition adding some helper methods to move around elements. This implementation of SortedMap does not support SubMaps of any kind. It implements the interface due to sortability and first/last access

Nested Class Summary
- Nested classes/interfaces inherited from class speiger.src.collections.ints.maps.abstracts.AbstractInt2CharMap
  AbstractInt2CharMap.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.ints.maps.interfaces.Int2CharSortedMap
  Int2CharSortedMap.FastSortedSet
- Nested classes/interfaces inherited from interface speiger.src.collections.ints.maps.interfaces.Int2CharMap
  Int2CharMap.Entry, Int2CharMap.FastEntrySet

Constructor Summary

Constructors
Constructor and Description
`Int2CharLinkedOpenHashMap()` Default Constructor
`Int2CharLinkedOpenHashMap(int minCapacity)` Constructor that defines the minimum capacity
`Int2CharLinkedOpenHashMap(int[] keys, char[] values)` Helper constructor that allow to create a map from unboxed values
`Int2CharLinkedOpenHashMap(int[] keys, char[] values, float loadFactor)` Helper constructor that allow to create a map from unboxed values
`Int2CharLinkedOpenHashMap(Int2CharMap map)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`Int2CharLinkedOpenHashMap(Int2CharMap map, float loadFactor)` A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
`Int2CharLinkedOpenHashMap(java.lang.Integer[] keys, java.lang.Character[] values)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`Int2CharLinkedOpenHashMap(java.lang.Integer[] keys, java.lang.Character[] values, float loadFactor)` Helper constructor that allow to create a map from boxed values (it will unbox them)
`Int2CharLinkedOpenHashMap(int minCapacity, float loadFactor)` Constructor that defines the minimum capacity and load factor
`Int2CharLinkedOpenHashMap(java.util.Map<? extends java.lang.Integer,? extends java.lang.Character> map)` A Helper constructor that allows to create a Map with exactly the same values as the provided map.
`Int2CharLinkedOpenHashMap(java.util.Map<? extends java.lang.Integer,? extends java.lang.Character> map, float loadFactor)` A Helper constructor that allows to create a Map with exactly the same values as the provided map.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()`
`IntComparator`	`comparator()`
`char`	`firstCharValue()` A method to get the first Value of a Map.
`int`	`firstIntKey()` A method to get the first Key of a Map.
`void`	`forEach(IntCharConsumer action)` Type Specific forEach method to reduce boxing/unboxing
`char`	`getAndMoveToFirst(int key)` A Specific get method that allows to move teh given key/value int the first index.
`char`	`getAndMoveToLast(int key)` A Specific get method that allows to move teh given key/value int the last index.
`Int2CharSortedMap`	`headMap(int toKey)` A Type Specific HeadMap method to reduce boxing/unboxing
`ObjectSet<Int2CharMap.Entry>`	`int2CharEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`IntSet`	`keySet()`
`char`	`lastCharValue()` A method to get the last Value of a Map.
`int`	`lastIntKey()` A method to get the last Key of a Map.
`boolean`	`moveToFirst(int key)` A specific move method to move a given key/value to the first index.
`boolean`	`moveToLast(int key)` A specific move method to move a given key/value to the last index.
`int`	`pollFirstIntKey()` A method to get and remove the first Key of a Map.
`int`	`pollLastIntKey()` A method to get and remove the last Key of a Map.
`char`	`putAndMoveToFirst(int key, char value)` A customized put method that allows you to insert into the first index.
`char`	`putAndMoveToLast(int key, char value)` A customized put method that allows you to insert into the last index.
`Int2CharSortedMap`	`subMap(int fromKey, int toKey)` A Type Specific SubMap method to reduce boxing/unboxing
`Int2CharSortedMap`	`tailMap(int fromKey)` A Type Specific TailMap method to reduce boxing/unboxing
`CharCollection`	`values()`

Methods inherited from class speiger.src.collections.ints.maps.impl.hash.Int2CharOpenHashMap
addTo, computeChar, computeCharIfAbsent, computeCharIfPresent, containsKey, containsKey, containsValue, containsValue, get, getChar, getOrDefault, mergeAllChar, mergeChar, put, putIfAbsent, remInt, remIntOrDefault, remove, remove, remove, replace, replace, size

Methods inherited from class speiger.src.collections.ints.maps.abstracts.AbstractInt2CharMap
addToAll, entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, putAll, putAll, putAll, putAllIfAbsent, replaceChars, replaceChars, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap
isEmpty, put, toString

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

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2CharSortedMap
firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from interface java.util.SortedMap
entrySet

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2CharMap
addTo, addToAll, compute, computeChar, computeCharIfAbsent, computeCharIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, get, getChar, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllChar, mergeChar, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remInt, remIntOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceChars, replaceChars, setDefaultReturnValue

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

- Constructor Detail
  - Int2CharLinkedOpenHashMap
```
public Int2CharLinkedOpenHashMap()
```
    Default Constructor
  - Int2CharLinkedOpenHashMap
```
public Int2CharLinkedOpenHashMap(int minCapacity)
```
    Constructor that defines the minimum capacity
    
    Parameters:
    
    minCapacity - the minimum capacity the HashMap is allowed to be.
    
    Throws:
    
    java.lang.IllegalStateException - if the minimum capacity is negative
  - Int2CharLinkedOpenHashMap
```
public Int2CharLinkedOpenHashMap(int minCapacity,
                                 float loadFactor)
```
    Constructor that defines the minimum capacity and load factor
    
    Parameters:
    
    minCapacity - the minimum capacity the HashMap is allowed to be.
    
    loadFactor - the percentage of how full the backing array can be before they resize
    
    Throws:
    
    java.lang.IllegalStateException - if the minimum capacity is negative
    
    java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1
  - Int2CharLinkedOpenHashMap
```
public Int2CharLinkedOpenHashMap(java.lang.Integer[] keys,
                                 java.lang.Character[] values)
```
    Helper constructor that allow to create a map from boxed values (it will unbox them)
    
    Parameters:
    
    keys - the keys that should be put into the map
    
    values - the values that should be put into the map.
    
    Throws:
    
    java.lang.IllegalStateException - if the keys and values do not match in lenght
  - Int2CharLinkedOpenHashMap
```
public Int2CharLinkedOpenHashMap(java.lang.Integer[] keys,
                                 java.lang.Character[] values,
                                 float loadFactor)
```
    Helper constructor that allow to create a map from boxed values (it will unbox them)
    
    Parameters:
    
    keys - the keys that should be put into the map
    
    values - the values that should be put into the map.
    
    loadFactor - the percentage of how full the backing array can be before they resize
    
    Throws:
    
    java.lang.IllegalStateException - if the keys and values do not match in lenght
    
    java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1
  - Int2CharLinkedOpenHashMap
```
public Int2CharLinkedOpenHashMap(int[] keys,
                                 char[] values)
```
    Helper constructor that allow to create a map from unboxed values
    
    Parameters:
    
    keys - the keys that should be put into the map
    
    values - the values that should be put into the map.
    
    Throws:
    
    java.lang.IllegalStateException - if the keys and values do not match in lenght
  - Int2CharLinkedOpenHashMap
```
public Int2CharLinkedOpenHashMap(int[] keys,
                                 char[] values,
                                 float loadFactor)
```
    Helper constructor that allow to create a map from unboxed values
    
    Parameters:
    
    keys - the keys that should be put into the map
    
    values - the values that should be put into the map.
    
    loadFactor - the percentage of how full the backing array can be before they resize
    
    Throws:
    
    java.lang.IllegalStateException - if the keys and values do not match in lenght
    
    java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1
  - Int2CharLinkedOpenHashMap
```
public Int2CharLinkedOpenHashMap(java.util.Map<? extends java.lang.Integer,? extends java.lang.Character> map)
```
    A Helper constructor that allows to create a Map with exactly the same values as the provided map.
    
    Parameters:
    
    map - the values that should be present in the map
  - Int2CharLinkedOpenHashMap
```
public Int2CharLinkedOpenHashMap(java.util.Map<? extends java.lang.Integer,? extends java.lang.Character> map,
                                 float loadFactor)
```
    A Helper constructor that allows to create a Map with exactly the same values as the provided map.
    
    Parameters:
    
    map - the values that should be present in the map
    
    loadFactor - the percentage of how full the backing array can be before they resize
    
    Throws:
    
    java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1
  - Int2CharLinkedOpenHashMap
```
public Int2CharLinkedOpenHashMap(Int2CharMap map)
```
    A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
    
    Parameters:
    
    map - the values that should be present in the map
  - Int2CharLinkedOpenHashMap
```
public Int2CharLinkedOpenHashMap(Int2CharMap map,
                                 float loadFactor)
```
    A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
    
    Parameters:
    
    map - the values that should be present in the map
    
    loadFactor - the percentage of how full the backing array can be before they resize
    
    Throws:
    
    java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1
- Method Detail
  - putAndMoveToFirst
```
public char putAndMoveToFirst(int key,
                              char value)
```
    Description copied from interface: Int2CharSortedMap
    
    A customized put method that allows you to insert into the first index.
    
    Specified by:
    
    putAndMoveToFirst in interface Int2CharSortedMap
    
    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(int key,
                             char value)
```
    Description copied from interface: Int2CharSortedMap
    
    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 Int2CharSortedMap
    
    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(int key)
```
    Description copied from interface: Int2CharSortedMap
    
    A specific move method to move a given key/value to the first index.
    
    Specified by:
    
    moveToFirst in interface Int2CharSortedMap
    
    Parameters:
    
    key - that should be moved to the first index
    
    Returns:
    
    true if the value was moved.
  - moveToLast
```
public boolean moveToLast(int key)
```
    Description copied from interface: Int2CharSortedMap
    
    A specific move method to move a given key/value to the last index.
    
    Specified by:
    
    moveToLast in interface Int2CharSortedMap
    
    Parameters:
    
    key - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
  - getAndMoveToFirst
```
public char getAndMoveToFirst(int key)
```
    Description copied from interface: Int2CharSortedMap
    
    A Specific get method that allows to move teh given key/value int the first index.
    
    Specified by:
    
    getAndMoveToFirst in interface Int2CharSortedMap
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - getAndMoveToLast
```
public char getAndMoveToLast(int key)
```
    Description copied from interface: Int2CharSortedMap
    
    A Specific get method that allows to move teh given key/value int the last index.
    
    Specified by:
    
    getAndMoveToLast in interface Int2CharSortedMap
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - comparator
```
public IntComparator comparator()
```
    Specified by:
    
    comparator in interface java.util.SortedMap<java.lang.Integer,java.lang.Character>
    
    Specified by:
    
    comparator in interface Int2CharSortedMap
  - subMap
```
public Int2CharSortedMap subMap(int fromKey,
                                int toKey)
```
    Description copied from interface: Int2CharSortedMap
    
    A Type Specific SubMap method to reduce boxing/unboxing
    
    Specified by:
    
    subMap in interface Int2CharSortedMap
    
    Parameters:
    
    fromKey - where the submap should start
    
    toKey - where the subMap should end
    
    Returns:
    
    a SubMap that is within the range of the desired range
  - headMap
```
public Int2CharSortedMap headMap(int toKey)
```
    Description copied from interface: Int2CharSortedMap
    
    A Type Specific HeadMap method to reduce boxing/unboxing
    
    Specified by:
    
    headMap in interface Int2CharSortedMap
    
    Parameters:
    
    toKey - where the headMap should end
    
    Returns:
    
    a HeadMap that is within the range of the desired range
  - tailMap
```
public Int2CharSortedMap tailMap(int fromKey)
```
    Description copied from interface: Int2CharSortedMap
    
    A Type Specific TailMap method to reduce boxing/unboxing
    
    Specified by:
    
    tailMap in interface Int2CharSortedMap
    
    Parameters:
    
    fromKey - where the TailMap should start
    
    Returns:
    
    a TailMap that is within the range of the desired range
  - firstIntKey
```
public int firstIntKey()
```
    Description copied from interface: Int2CharSortedMap
    
    A method to get the first Key of a Map.
    
    Specified by:
    
    firstIntKey in interface Int2CharSortedMap
    
    Returns:
    
    the first key in the map
  - pollFirstIntKey
```
public int pollFirstIntKey()
```
    Description copied from interface: Int2CharSortedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstIntKey in interface Int2CharSortedMap
    
    Returns:
    
    the first key in the map
  - lastIntKey
```
public int lastIntKey()
```
    Description copied from interface: Int2CharSortedMap
    
    A method to get the last Key of a Map.
    
    Specified by:
    
    lastIntKey in interface Int2CharSortedMap
    
    Returns:
    
    the last key in the map
  - pollLastIntKey
```
public int pollLastIntKey()
```
    Description copied from interface: Int2CharSortedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastIntKey in interface Int2CharSortedMap
    
    Returns:
    
    the last key in the map
  - firstCharValue
```
public char firstCharValue()
```
    Description copied from interface: Int2CharSortedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstCharValue in interface Int2CharSortedMap
    
    Returns:
    
    the first key in the map
  - lastCharValue
```
public char lastCharValue()
```
    Description copied from interface: Int2CharSortedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastCharValue in interface Int2CharSortedMap
    
    Returns:
    
    the last key in the map
  - int2CharEntrySet
```
public ObjectSet<Int2CharMap.Entry> int2CharEntrySet()
```
    Description copied from interface: Int2CharMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    int2CharEntrySet in interface Int2CharMap
    
    Overrides:
    
    int2CharEntrySet in class Int2CharOpenHashMap
    
    Returns:
    
    a EntrySet of the collection
  - keySet
```
public IntSet keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<java.lang.Integer,java.lang.Character>
    
    Specified by:
    
    keySet in interface java.util.SortedMap<java.lang.Integer,java.lang.Character>
    
    Specified by:
    
    keySet in interface Int2CharMap
    
    Specified by:
    
    keySet in interface Int2CharSortedMap
    
    Overrides:
    
    keySet in class Int2CharOpenHashMap
  - values
```
public CharCollection values()
```
    Specified by:
    
    values in interface java.util.Map<java.lang.Integer,java.lang.Character>
    
    Specified by:
    
    values in interface java.util.SortedMap<java.lang.Integer,java.lang.Character>
    
    Specified by:
    
    values in interface Int2CharMap
    
    Specified by:
    
    values in interface Int2CharSortedMap
    
    Overrides:
    
    values in class Int2CharOpenHashMap
  - forEach
```
public void forEach(IntCharConsumer action)
```
    Description copied from interface: Int2CharMap
    
    Type Specific forEach method to reduce boxing/unboxing
    
    Specified by:
    
    forEach in interface Int2CharMap
    
    Overrides:
    
    forEach in class Int2CharOpenHashMap
    
    Parameters:
    
    action - processor of the values that are iterator over
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<java.lang.Integer,java.lang.Character>
    
    Overrides:
    
    clear in class Int2CharOpenHashMap

Class Int2CharLinkedOpenHashMap

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.ints.maps.abstracts.AbstractInt2CharMap

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

Nested classes/interfaces inherited from interface speiger.src.collections.ints.maps.interfaces.Int2CharSortedMap

Nested classes/interfaces inherited from interface speiger.src.collections.ints.maps.interfaces.Int2CharMap

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.ints.maps.impl.hash.Int2CharOpenHashMap

Methods inherited from class speiger.src.collections.ints.maps.abstracts.AbstractInt2CharMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2CharSortedMap

Methods inherited from interface java.util.SortedMap

Methods inherited from interface speiger.src.collections.ints.maps.interfaces.Int2CharMap

Methods inherited from interface java.util.Map

Constructor Detail

Int2CharLinkedOpenHashMap

Int2CharLinkedOpenHashMap

Int2CharLinkedOpenHashMap

Int2CharLinkedOpenHashMap

Int2CharLinkedOpenHashMap

Int2CharLinkedOpenHashMap

Int2CharLinkedOpenHashMap

Int2CharLinkedOpenHashMap

Int2CharLinkedOpenHashMap

Int2CharLinkedOpenHashMap

Int2CharLinkedOpenHashMap

Method Detail

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

comparator

subMap

headMap

tailMap

firstIntKey

pollFirstIntKey

lastIntKey

pollLastIntKey

firstCharValue

lastCharValue

int2CharEntrySet

keySet

values

forEach

clear