Object2BooleanLinkedOpenCustomHashMap (Primitive-Collections 0.8.0 API)

java.lang.Object
- java.util.AbstractMap<T,java.lang.Boolean>
- - speiger.src.collections.objects.maps.abstracts.AbstractObject2BooleanMap<T>
  - - speiger.src.collections.objects.maps.impl.customHash.Object2BooleanOpenCustomHashMap<T>
    - - speiger.src.collections.objects.maps.impl.customHash.Object2BooleanLinkedOpenCustomHashMap<T>

Type Parameters:

T - the keyType of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.Predicate<T>, java.util.Map<T,java.lang.Boolean>, Object2BooleanMap<T>, Object2BooleanOrderedMap<T>, ITrimmable
```
public class Object2BooleanLinkedOpenCustomHashMap<T>
extends Object2BooleanOpenCustomHashMap<T>
implements Object2BooleanOrderedMap<T>
```
A Type Specific LinkedHashMap that allows for custom HashControl. That uses arrays to create links between nodes. For cases where Objects/primitive do not allow hashcoding this can be really useful and provide a lot of control. 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.objects.maps.abstracts.AbstractObject2BooleanMap
  AbstractObject2BooleanMap.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.Object2BooleanOrderedMap
  Object2BooleanOrderedMap.FastOrderedSet<T>
- Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2BooleanMap
  Object2BooleanMap.BuilderCache<T>, Object2BooleanMap.Entry<T>, Object2BooleanMap.FastEntrySet<T>, Object2BooleanMap.MapBuilder

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()`
`void`	`clearAndTrim(int size)` Trims the collection down to the requested size and clears all elements while doing so
`Object2BooleanLinkedOpenCustomHashMap<T>`	`copy()` A Function that does a shallow clone of the Map itself.
`boolean`	`firstBooleanValue()` A method to get the first Value of a Map.
`T`	`firstKey()` A method to get the first Key of a Map.
`void`	`forEach(ObjectBooleanConsumer<T> action)` Type Specific forEach method to reduce boxing/unboxing
`boolean`	`getAndMoveToFirst(T key)` A Specific get method that allows to move teh given key/value int the first index.
`boolean`	`getAndMoveToLast(T key)` A Specific get method that allows to move teh given key/value int the last index.
`ObjectOrderedSet<T>`	`keySet()`
`boolean`	`lastBooleanValue()` 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<Object2BooleanMap.Entry<T>>`	`object2BooleanEntrySet()` 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.
`boolean`	`putAndMoveToFirst(T key, boolean value)` A customized put method that allows you to insert into the first index.
`boolean`	`putAndMoveToLast(T key, boolean value)` A customized put method that allows you to insert into the last index.
`BooleanCollection`	`values()`

Methods inherited from class speiger.src.collections.objects.maps.impl.customHash.Object2BooleanOpenCustomHashMap
computeBoolean, computeBooleanIfAbsent, computeBooleanIfPresent, containsKey, containsValue, containsValue, get, getBoolean, getOrDefault, mergeAllBoolean, mergeBoolean, put, putIfAbsent, rem, remOrDefault, remove, remove, remove, replace, replace, size, supplyBooleanIfAbsent, trim

Methods inherited from class speiger.src.collections.objects.maps.abstracts.AbstractObject2BooleanMap
entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, replaceBooleans, replaceBooleans, setDefaultReturnValue

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

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

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

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2BooleanMap
builder, compute, computeBoolean, computeBooleanIfAbsent, computeBooleanIfPresent, computeIfAbsent, computeIfPresent, containsValue, containsValue, entrySet, forEach, get, getBoolean, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllBoolean, mergeBoolean, put, put, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, rem, remOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceBooleans, replaceBooleans, setDefaultReturnValue, supplyBooleanIfAbsent, test

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

Methods inherited from interface java.util.function.Predicate
and, isEqual, negate, or

Methods inherited from interface speiger.src.collections.utils.ITrimmable
clearAndTrim, trim

- Constructor Detail
  - Object2BooleanLinkedOpenCustomHashMap
```
public Object2BooleanLinkedOpenCustomHashMap(ObjectStrategy<? super T> strategy)
```
    Default Constructor
    
    Parameters:
    
    strategy - the strategy that allows hash control.
    
    Throws:
    
    java.lang.NullPointerException - if Strategy is null
  - Object2BooleanLinkedOpenCustomHashMap
```
public Object2BooleanLinkedOpenCustomHashMap(int minCapacity,
                                             ObjectStrategy<? super T> strategy)
```
    Constructor that defines the minimum capacity
    
    Parameters:
    
    minCapacity - the minimum capacity the HashMap is allowed to be.
    
    strategy - the strategy that allows hash control.
    
    Throws:
    
    java.lang.NullPointerException - if Strategy is null
    
    java.lang.IllegalStateException - if the minimum capacity is negative
  - Object2BooleanLinkedOpenCustomHashMap
```
public Object2BooleanLinkedOpenCustomHashMap(int minCapacity,
                                             float loadFactor,
                                             ObjectStrategy<? super T> strategy)
```
    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
    
    strategy - the strategy that allows hash control.
    
    Throws:
    
    java.lang.NullPointerException - if Strategy is null
    
    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
  - Object2BooleanLinkedOpenCustomHashMap
```
public Object2BooleanLinkedOpenCustomHashMap(T[] keys,
                                             java.lang.Boolean[] values,
                                             ObjectStrategy<? super T> strategy)
```
    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.
    
    strategy - the strategy that allows hash control.
    
    Throws:
    
    java.lang.NullPointerException - if Strategy is null
    
    java.lang.IllegalStateException - if the keys and values do not match in lenght
  - Object2BooleanLinkedOpenCustomHashMap
```
public Object2BooleanLinkedOpenCustomHashMap(T[] keys,
                                             java.lang.Boolean[] values,
                                             float loadFactor,
                                             ObjectStrategy<? super T> strategy)
```
    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
    
    strategy - the strategy that allows hash control.
    
    Throws:
    
    java.lang.NullPointerException - if Strategy is null
    
    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
  - Object2BooleanLinkedOpenCustomHashMap
```
public Object2BooleanLinkedOpenCustomHashMap(T[] keys,
                                             boolean[] values,
                                             ObjectStrategy<? super T> strategy)
```
    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.
    
    strategy - the strategy that allows hash control.
    
    Throws:
    
    java.lang.NullPointerException - if Strategy is null
    
    java.lang.IllegalStateException - if the keys and values do not match in lenght
  - Object2BooleanLinkedOpenCustomHashMap
```
public Object2BooleanLinkedOpenCustomHashMap(T[] keys,
                                             boolean[] values,
                                             float loadFactor,
                                             ObjectStrategy<? super T> strategy)
```
    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
    
    strategy - the strategy that allows hash control.
    
    Throws:
    
    java.lang.NullPointerException - if Strategy is null
    
    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
  - Object2BooleanLinkedOpenCustomHashMap
```
public Object2BooleanLinkedOpenCustomHashMap(java.util.Map<? extends T,? extends java.lang.Boolean> map,
                                             ObjectStrategy<? super T> strategy)
```
    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
    
    strategy - the strategy that allows hash control.
    
    Throws:
    
    java.lang.NullPointerException - if Strategy is null
  - Object2BooleanLinkedOpenCustomHashMap
```
public Object2BooleanLinkedOpenCustomHashMap(java.util.Map<? extends T,? extends java.lang.Boolean> map,
                                             float loadFactor,
                                             ObjectStrategy<? super T> strategy)
```
    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
    
    strategy - the strategy that allows hash control.
    
    Throws:
    
    java.lang.NullPointerException - if Strategy is null
    
    java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1
  - Object2BooleanLinkedOpenCustomHashMap
```
public Object2BooleanLinkedOpenCustomHashMap(Object2BooleanMap<T> map,
                                             ObjectStrategy<? super T> strategy)
```
    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
    
    strategy - the strategy that allows hash control.
    
    Throws:
    
    java.lang.NullPointerException - if Strategy is null
  - Object2BooleanLinkedOpenCustomHashMap
```
public Object2BooleanLinkedOpenCustomHashMap(Object2BooleanMap<T> map,
                                             float loadFactor,
                                             ObjectStrategy<? super T> strategy)
```
    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
    
    strategy - the strategy that allows hash control.
    
    Throws:
    
    java.lang.NullPointerException - if Strategy is null
    
    java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1
- Method Detail
  - putAndMoveToFirst
```
public boolean putAndMoveToFirst(T key,
                                 boolean value)
```
    Description copied from interface: Object2BooleanOrderedMap
    
    A customized put method that allows you to insert into the first index.
    
    Specified by:
    
    putAndMoveToFirst in interface Object2BooleanOrderedMap<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 boolean putAndMoveToLast(T key,
                                boolean value)
```
    Description copied from interface: Object2BooleanOrderedMap
    
    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 Object2BooleanOrderedMap<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: Object2BooleanOrderedMap
    
    A specific move method to move a given key/value to the first index.
    
    Specified by:
    
    moveToFirst in interface Object2BooleanOrderedMap<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: Object2BooleanOrderedMap
    
    A specific move method to move a given key/value to the last index.
    
    Specified by:
    
    moveToLast in interface Object2BooleanOrderedMap<T>
    
    Parameters:
    
    key - that should be moved to the first last
    
    Returns:
    
    true if the value was moved.
  - getAndMoveToFirst
```
public boolean getAndMoveToFirst(T key)
```
    Description copied from interface: Object2BooleanOrderedMap
    
    A Specific get method that allows to move teh given key/value int the first index.
    
    Specified by:
    
    getAndMoveToFirst in interface Object2BooleanOrderedMap<T>
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - getAndMoveToLast
```
public boolean getAndMoveToLast(T key)
```
    Description copied from interface: Object2BooleanOrderedMap
    
    A Specific get method that allows to move teh given key/value int the last index.
    
    Specified by:
    
    getAndMoveToLast in interface Object2BooleanOrderedMap<T>
    
    Parameters:
    
    key - that is searched for
    
    Returns:
    
    the given value for the requested key or default return value
  - copy
```
public Object2BooleanLinkedOpenCustomHashMap<T> copy()
```
    Description copied from interface: Object2BooleanMap
    
    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 Object2BooleanMap<T>
    
    Specified by:
    
    copy in interface Object2BooleanOrderedMap<T>
    
    Overrides:
    
    copy in class Object2BooleanOpenCustomHashMap<T>
    
    Returns:
    
    a Shallow Copy of the Map
  - firstKey
```
public T firstKey()
```
    Description copied from interface: Object2BooleanOrderedMap
    
    A method to get the first Key of a Map.
    
    Specified by:
    
    firstKey in interface Object2BooleanOrderedMap<T>
    
    Returns:
    
    the first key in the map
  - pollFirstKey
```
public T pollFirstKey()
```
    Description copied from interface: Object2BooleanOrderedMap
    
    A method to get and remove the first Key of a Map.
    
    Specified by:
    
    pollFirstKey in interface Object2BooleanOrderedMap<T>
    
    Returns:
    
    the first key in the map
  - lastKey
```
public T lastKey()
```
    Description copied from interface: Object2BooleanOrderedMap
    
    A method to get the last Key of a Map.
    
    Specified by:
    
    lastKey in interface Object2BooleanOrderedMap<T>
    
    Returns:
    
    the last key in the map
  - pollLastKey
```
public T pollLastKey()
```
    Description copied from interface: Object2BooleanOrderedMap
    
    A method to get and remove the last Key of a Map.
    
    Specified by:
    
    pollLastKey in interface Object2BooleanOrderedMap<T>
    
    Returns:
    
    the last key in the map
  - firstBooleanValue
```
public boolean firstBooleanValue()
```
    Description copied from interface: Object2BooleanOrderedMap
    
    A method to get the first Value of a Map.
    
    Specified by:
    
    firstBooleanValue in interface Object2BooleanOrderedMap<T>
    
    Returns:
    
    the first key in the map
  - lastBooleanValue
```
public boolean lastBooleanValue()
```
    Description copied from interface: Object2BooleanOrderedMap
    
    A method to get the last Value of a Map.
    
    Specified by:
    
    lastBooleanValue in interface Object2BooleanOrderedMap<T>
    
    Returns:
    
    the last key in the map
  - object2BooleanEntrySet
```
public ObjectOrderedSet<Object2BooleanMap.Entry<T>> object2BooleanEntrySet()
```
    Description copied from interface: Object2BooleanMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Specified by:
    
    object2BooleanEntrySet in interface Object2BooleanMap<T>
    
    Specified by:
    
    object2BooleanEntrySet in interface Object2BooleanOrderedMap<T>
    
    Overrides:
    
    object2BooleanEntrySet in class Object2BooleanOpenCustomHashMap<T>
    
    Returns:
    
    a EntrySet of the collection
  - keySet
```
public ObjectOrderedSet<T> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<T,java.lang.Boolean>
    
    Specified by:
    
    keySet in interface Object2BooleanMap<T>
    
    Specified by:
    
    keySet in interface Object2BooleanOrderedMap<T>
    
    Overrides:
    
    keySet in class Object2BooleanOpenCustomHashMap<T>
  - values
```
public BooleanCollection values()
```
    Specified by:
    
    values in interface java.util.Map<T,java.lang.Boolean>
    
    Specified by:
    
    values in interface Object2BooleanMap<T>
    
    Overrides:
    
    values in class Object2BooleanOpenCustomHashMap<T>
  - forEach
```
public void forEach(ObjectBooleanConsumer<T> action)
```
    Description copied from interface: Object2BooleanMap
    
    Type Specific forEach method to reduce boxing/unboxing
    
    Specified by:
    
    forEach in interface Object2BooleanMap<T>
    
    Overrides:
    
    forEach in class Object2BooleanOpenCustomHashMap<T>
    
    Parameters:
    
    action - processor of the values that are iterator over
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<T,java.lang.Boolean>
    
    Overrides:
    
    clear in class Object2BooleanOpenCustomHashMap<T>
  - clearAndTrim
```
public void clearAndTrim(int size)
```
    Description copied from interface: ITrimmable
    
    Trims the collection down to the requested size and clears all elements while doing so
    
    Specified by:
    
    clearAndTrim in interface ITrimmable
    
    Overrides:
    
    clearAndTrim in class Object2BooleanOpenCustomHashMap<T>
    
    Parameters:
    
    size - the amount of elements that should be allowed

Class Object2BooleanLinkedOpenCustomHashMap<T>

Nested Class Summary

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

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

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

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

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.objects.maps.impl.customHash.Object2BooleanOpenCustomHashMap

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface java.util.Map

Methods inherited from interface java.util.function.Predicate

Methods inherited from interface speiger.src.collections.utils.ITrimmable

Constructor Detail

Object2BooleanLinkedOpenCustomHashMap

Object2BooleanLinkedOpenCustomHashMap

Object2BooleanLinkedOpenCustomHashMap

Object2BooleanLinkedOpenCustomHashMap

Object2BooleanLinkedOpenCustomHashMap

Object2BooleanLinkedOpenCustomHashMap

Object2BooleanLinkedOpenCustomHashMap

Object2BooleanLinkedOpenCustomHashMap

Object2BooleanLinkedOpenCustomHashMap

Object2BooleanLinkedOpenCustomHashMap

Object2BooleanLinkedOpenCustomHashMap

Method Detail

putAndMoveToFirst

putAndMoveToLast

moveToFirst

moveToLast

getAndMoveToFirst

getAndMoveToLast

copy

firstKey

pollFirstKey

lastKey

pollLastKey

firstBooleanValue

lastBooleanValue

object2BooleanEntrySet

keySet

values

forEach

clear

clearAndTrim