Enum2BooleanMap (Primitive-Collections 0.7.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.misc.Enum2BooleanMap<T>

Type Parameters:

T - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.Predicate<T>, java.util.Map<T,java.lang.Boolean>, Object2BooleanFunction<T>, Object2BooleanMap<T>

Direct Known Subclasses:

LinkedEnum2BooleanMap
```
public class Enum2BooleanMap<T extends java.lang.Enum<T>>
extends AbstractObject2BooleanMap<T>
```
A Type Specific EnumMap implementation that allows for Primitive Values. Unlike javas implementation this one does not jump around between a single long or long array implementation based around the enum size This will cause a bit more memory usage but allows for a simpler implementation.

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.Object2BooleanMap
  Object2BooleanMap.BuilderCache<T>, Object2BooleanMap.Entry<T>, Object2BooleanMap.FastEntrySet<T>, Object2BooleanMap.MapBuilder

Constructor Summary

Constructors
Constructor and Description
`Enum2BooleanMap(java.lang.Class<T> keyType)` Default Constructor
`Enum2BooleanMap(java.util.Map<? extends T,? extends java.lang.Boolean> map)` A Helper constructor that allows to create a EnumMap with exactly the same values as the provided map.
`Enum2BooleanMap(Object2BooleanMap<T> map)` A Type Specific Helper function that allows to create a new EnumMap with exactly the same values as the provided map.
`Enum2BooleanMap(T[] keys, boolean[] values)` Helper constructor that allow to create a EnumMap from unboxed values
`Enum2BooleanMap(T[] keys, java.lang.Boolean[] values)` Helper constructor that allow to create a EnumMap from boxed values (it will unbox them)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()`
`boolean`	`computeBoolean(T key, ObjectBooleanUnaryOperator<T> mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`boolean`	`computeBooleanIfAbsent(T key, Object2BooleanFunction<T> mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`boolean`	`computeBooleanIfPresent(T key, ObjectBooleanUnaryOperator<T> mappingFunction)` A Type Specific compute method to reduce boxing/unboxing
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(boolean value)` Type Specific method to reduce boxing/unboxing of values
`Enum2BooleanMap<T>`	`copy()` A Function that does a shallow clone of the Map itself.
`void`	`forEach(ObjectBooleanConsumer<T> action)` Type Specific forEach method to reduce boxing/unboxing
`boolean`	`getBoolean(T key)` A Type Specific get method to reduce boxing/unboxing
`boolean`	`getOrDefault(T key, boolean defaultValue)` A Type Specific getOrDefault method to reduce boxing/unboxing
`ObjectSet<T>`	`keySet()`
`void`	`mergeAllBoolean(Object2BooleanMap<T> m, BooleanBooleanUnaryOperator mappingFunction)` A Bulk method for merging Maps.
`boolean`	`mergeBoolean(T key, boolean value, BooleanBooleanUnaryOperator mappingFunction)` A Type Specific merge method to reduce boxing/unboxing
`ObjectSet<Object2BooleanMap.Entry<T>>`	`object2BooleanEntrySet()` Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
`boolean`	`put(T key, boolean value)` Type Specific method to reduce boxing/unboxing of values
`boolean`	`putIfAbsent(T key, boolean value)` Type Specific method to reduce boxing/unboxing of values
`boolean`	`rem(T key)` Type Specific remove function to reduce boxing/unboxing
`boolean`	`remOrDefault(T key, boolean defaultValue)` Type-Specific Remove function with a default return value if wanted.
`java.lang.Boolean`	`remove(java.lang.Object key)`
`boolean`	`remove(T key, boolean value)` Type Specific remove function to reduce boxing/unboxing
`boolean`	`replace(T key, boolean value)` A Type Specific replace method to reduce boxing/unboxing replace an existing value
`boolean`	`replace(T key, boolean oldValue, boolean newValue)` A Type Specific replace method to replace an existing value
`int`	`size()`
`boolean`	`supplyBooleanIfAbsent(T key, BooleanSupplier valueProvider)` A Supplier based computeIfAbsent function to fill the most used usecase of this function
`BooleanCollection`	`values()`

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

Methods inherited from class java.util.AbstractMap
containsValue, 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.Object2BooleanMap
builder, compute, computeIfAbsent, computeIfPresent, containsValue, forEach, merge, putAll, putAll, putIfAbsent, remove, replace, replace, replaceAll, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Map
isEmpty

Methods inherited from interface speiger.src.collections.objects.functions.function.Object2BooleanFunction
and, andType, negate, or, orType, test

Methods inherited from interface java.util.function.Predicate
isEqual

- Constructor Detail
  - Enum2BooleanMap
```
public Enum2BooleanMap(java.lang.Class<T> keyType)
```
    Default Constructor
    
    Parameters:
    
    keyType - the type of Enum that should be used
  - Enum2BooleanMap
```
public Enum2BooleanMap(T[] keys,
                       java.lang.Boolean[] values)
```
    Helper constructor that allow to create a EnumMap from boxed values (it will unbox them)
    
    Parameters:
    
    keys - the keys that should be put into the EnumMap
    
    values - the values that should be put into the EnumMap.
    
    Throws:
    
    java.lang.IllegalStateException - if the keys and values do not match in lenght
  - Enum2BooleanMap
```
public Enum2BooleanMap(T[] keys,
                       boolean[] values)
```
    Helper constructor that allow to create a EnumMap 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
  - Enum2BooleanMap
```
public Enum2BooleanMap(java.util.Map<? extends T,? extends java.lang.Boolean> map)
```
    A Helper constructor that allows to create a EnumMap with exactly the same values as the provided map.
    
    Parameters:
    
    map - the values that should be present in the map
  - Enum2BooleanMap
```
public Enum2BooleanMap(Object2BooleanMap<T> map)
```
    A Type Specific Helper function that allows to create a new EnumMap with exactly the same values as the provided map.
    
    Parameters:
    
    map - the values that should be present in the map
- Method Detail
  - put
```
public boolean put(T key,
                   boolean value)
```
    Description copied from interface: Object2BooleanMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Parameters:
    
    key - the key that should be inserted,
    
    value - the value that should be inserted
    
    Returns:
    
    the last present value or default return value.
    
    See Also:
    
    Map.put(Object, Object)
  - putIfAbsent
```
public boolean putIfAbsent(T key,
                           boolean value)
```
    Description copied from interface: Object2BooleanMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Parameters:
    
    key - the key that should be inserted,
    
    value - the value that should be inserted
    
    Returns:
    
    the last present value or default return value.
    
    See Also:
    
    Map.putIfAbsent(Object, Object)
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    Specified by:
    
    containsKey in interface java.util.Map<T extends java.lang.Enum<T>,java.lang.Boolean>
    
    Overrides:
    
    containsKey in class AbstractObject2BooleanMap<T extends java.lang.Enum<T>>
  - containsValue
```
public boolean containsValue(boolean value)
```
    Description copied from interface: Object2BooleanMap
    
    Type Specific method to reduce boxing/unboxing of values
    
    Specified by:
    
    containsValue in interface Object2BooleanMap<T extends java.lang.Enum<T>>
    
    Overrides:
    
    containsValue in class AbstractObject2BooleanMap<T extends java.lang.Enum<T>>
    
    Parameters:
    
    value - element that is searched for
    
    Returns:
    
    if the value is present
  - remove
```
public java.lang.Boolean remove(java.lang.Object key)
```
    Specified by:
    
    remove in interface java.util.Map<T extends java.lang.Enum<T>,java.lang.Boolean>
    
    Specified by:
    
    remove in interface Object2BooleanMap<T extends java.lang.Enum<T>>
    
    Overrides:
    
    remove in class AbstractObject2BooleanMap<T extends java.lang.Enum<T>>
    
    Parameters:
    
    key - the element that should be removed
    
    Returns:
    
    the value that was removed or default return value
    
    See Also:
    
    Map.remove(Object)
  - rem
```
public boolean rem(T key)
```
    Description copied from interface: Object2BooleanMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Parameters:
    
    key - the element that should be removed
    
    Returns:
    
    the value that was removed or default return value
  - remOrDefault
```
public boolean remOrDefault(T key,
                            boolean defaultValue)
```
    Description copied from interface: Object2BooleanMap
    
    Type-Specific Remove function with a default return value if wanted.
    
    Parameters:
    
    key - the element that should be removed
    
    defaultValue - the value that should be returned if the entry doesn't exist
    
    Returns:
    
    the value that was removed or default value
    
    See Also:
    
    Map.remove(Object, Object)
  - remove
```
public boolean remove(T key,
                      boolean value)
```
    Description copied from interface: Object2BooleanMap
    
    Type Specific remove function to reduce boxing/unboxing
    
    Parameters:
    
    key - the element that should be removed
    
    value - the expected value that should be found
    
    Returns:
    
    true if the key and value was found and removed
    
    See Also:
    
    Map.remove(Object, Object)
  - getBoolean
```
public boolean getBoolean(T key)
```
    Description copied from interface: Object2BooleanMap
    
    A Type Specific get method to reduce boxing/unboxing
    
    Parameters:
    
    key - the key that is searched for
    
    Returns:
    
    the searched value or default return value
  - getOrDefault
```
public boolean getOrDefault(T key,
                            boolean defaultValue)
```
    Description copied from interface: Object2BooleanMap
    
    A Type Specific getOrDefault method to reduce boxing/unboxing
    
    Parameters:
    
    key - the key that is searched for
    
    defaultValue - the value that should be returned if the key is not present
    
    Returns:
    
    the searched value or defaultValue value
  - copy
```
public Enum2BooleanMap<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 extends java.lang.Enum<T>>
    
    Overrides:
    
    copy in class AbstractObject2BooleanMap<T extends java.lang.Enum<T>>
    
    Returns:
    
    a Shallow Copy of the Map
  - object2BooleanEntrySet
```
public ObjectSet<Object2BooleanMap.Entry<T>> object2BooleanEntrySet()
```
    Description copied from interface: Object2BooleanMap
    
    Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
    
    Returns:
    
    a EntrySet of the collection
  - keySet
```
public ObjectSet<T> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<T extends java.lang.Enum<T>,java.lang.Boolean>
    
    Specified by:
    
    keySet in interface Object2BooleanMap<T extends java.lang.Enum<T>>
    
    Overrides:
    
    keySet in class AbstractObject2BooleanMap<T extends java.lang.Enum<T>>
  - values
```
public BooleanCollection values()
```
    Specified by:
    
    values in interface java.util.Map<T extends java.lang.Enum<T>,java.lang.Boolean>
    
    Specified by:
    
    values in interface Object2BooleanMap<T extends java.lang.Enum<T>>
    
    Overrides:
    
    values in class AbstractObject2BooleanMap<T extends java.lang.Enum<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 extends java.lang.Enum<T>>
    
    Overrides:
    
    forEach in class AbstractObject2BooleanMap<T extends java.lang.Enum<T>>
    
    Parameters:
    
    action - processor of the values that are iterator over
  - replace
```
public boolean replace(T key,
                       boolean oldValue,
                       boolean newValue)
```
    Description copied from interface: Object2BooleanMap
    
    A Type Specific replace method to replace an existing value
    
    Specified by:
    
    replace in interface Object2BooleanMap<T extends java.lang.Enum<T>>
    
    Overrides:
    
    replace in class AbstractObject2BooleanMap<T extends java.lang.Enum<T>>
    
    Parameters:
    
    key - the element that should be searched for
    
    oldValue - the expected value to be replaced
    
    newValue - the value to replace the oldValue with.
    
    Returns:
    
    true if the value got replaced
  - replace
```
public boolean replace(T key,
                       boolean value)
```
    Description copied from interface: Object2BooleanMap
    
    A Type Specific replace method to reduce boxing/unboxing replace an existing value
    
    Specified by:
    
    replace in interface Object2BooleanMap<T extends java.lang.Enum<T>>
    
    Overrides:
    
    replace in class AbstractObject2BooleanMap<T extends java.lang.Enum<T>>
    
    Parameters:
    
    key - the element that should be searched for
    
    value - the value to replace with.
    
    Returns:
    
    the present value or default return value
  - computeBoolean
```
public boolean computeBoolean(T key,
                              ObjectBooleanUnaryOperator<T> mappingFunction)
```
    Description copied from interface: Object2BooleanMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeBoolean in interface Object2BooleanMap<T extends java.lang.Enum<T>>
    
    Overrides:
    
    computeBoolean in class AbstractObject2BooleanMap<T extends java.lang.Enum<T>>
    
    Parameters:
    
    key - the key that should be computed
    
    mappingFunction - the operator that should generate the value
    
    Returns:
    
    the result of the computation
  - computeBooleanIfAbsent
```
public boolean computeBooleanIfAbsent(T key,
                                      Object2BooleanFunction<T> mappingFunction)
```
    Description copied from interface: Object2BooleanMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeBooleanIfAbsent in interface Object2BooleanMap<T extends java.lang.Enum<T>>
    
    Overrides:
    
    computeBooleanIfAbsent in class AbstractObject2BooleanMap<T extends java.lang.Enum<T>>
    
    Parameters:
    
    key - the key that should be computed
    
    mappingFunction - the operator that should generate the value if not present
    
    Returns:
    
    the result of the computed value or present value
  - supplyBooleanIfAbsent
```
public boolean supplyBooleanIfAbsent(T key,
                                     BooleanSupplier valueProvider)
```
    Description copied from interface: Object2BooleanMap
    
    A Supplier based computeIfAbsent function to fill the most used usecase of this function
    
    Specified by:
    
    supplyBooleanIfAbsent in interface Object2BooleanMap<T extends java.lang.Enum<T>>
    
    Overrides:
    
    supplyBooleanIfAbsent in class AbstractObject2BooleanMap<T extends java.lang.Enum<T>>
    
    Parameters:
    
    key - the key that should be computed
    
    valueProvider - the value if not present
    
    Returns:
    
    the result of the computed value or present value
  - computeBooleanIfPresent
```
public boolean computeBooleanIfPresent(T key,
                                       ObjectBooleanUnaryOperator<T> mappingFunction)
```
    Description copied from interface: Object2BooleanMap
    
    A Type Specific compute method to reduce boxing/unboxing
    
    Specified by:
    
    computeBooleanIfPresent in interface Object2BooleanMap<T extends java.lang.Enum<T>>
    
    Overrides:
    
    computeBooleanIfPresent in class AbstractObject2BooleanMap<T extends java.lang.Enum<T>>
    
    Parameters:
    
    key - the key that should be computed
    
    mappingFunction - the operator that should generate the value if present
    
    Returns:
    
    the result of the default return value or present value
  - mergeBoolean
```
public boolean mergeBoolean(T key,
                            boolean value,
                            BooleanBooleanUnaryOperator mappingFunction)
```
    Description copied from interface: Object2BooleanMap
    
    A Type Specific merge method to reduce boxing/unboxing
    
    Specified by:
    
    mergeBoolean in interface Object2BooleanMap<T extends java.lang.Enum<T>>
    
    Overrides:
    
    mergeBoolean in class AbstractObject2BooleanMap<T extends java.lang.Enum<T>>
    
    Parameters:
    
    key - the key that should be be searched for
    
    value - the value that should be merged with
    
    mappingFunction - the operator that should generate the new Value
    
    Returns:
    
    the result of the merge
  - mergeAllBoolean
```
public void mergeAllBoolean(Object2BooleanMap<T> m,
                            BooleanBooleanUnaryOperator mappingFunction)
```
    Description copied from interface: Object2BooleanMap
    
    A Bulk method for merging Maps.
    
    Specified by:
    
    mergeAllBoolean in interface Object2BooleanMap<T extends java.lang.Enum<T>>
    
    Overrides:
    
    mergeAllBoolean in class AbstractObject2BooleanMap<T extends java.lang.Enum<T>>
    
    Parameters:
    
    m - the entries that should be bulk added
    
    mappingFunction - the operator that should generate the new Value
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<T extends java.lang.Enum<T>,java.lang.Boolean>
    
    Overrides:
    
    clear in class java.util.AbstractMap<T extends java.lang.Enum<T>,java.lang.Boolean>
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Map<T extends java.lang.Enum<T>,java.lang.Boolean>
    
    Overrides:
    
    size in class java.util.AbstractMap<T extends java.lang.Enum<T>,java.lang.Boolean>

Class Enum2BooleanMap<T extends java.lang.Enum<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.Object2BooleanMap

Constructor Summary

Method Summary

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.Object2BooleanMap

Methods inherited from interface java.util.Map

Methods inherited from interface speiger.src.collections.objects.functions.function.Object2BooleanFunction

Methods inherited from interface java.util.function.Predicate

Constructor Detail

Enum2BooleanMap

Enum2BooleanMap

Enum2BooleanMap

Enum2BooleanMap

Enum2BooleanMap

Method Detail

put

putIfAbsent

containsKey

containsValue

remove

rem

remOrDefault

remove

getBoolean

getOrDefault

copy

object2BooleanEntrySet

keySet

values

forEach

replace

replace

computeBoolean

computeBooleanIfAbsent

supplyBooleanIfAbsent

computeBooleanIfPresent

mergeBoolean

mergeAllBoolean

clear

size