speiger.src.collections.objects.maps.impl.misc

Class Enum2BooleanMap<T extends java.lang.Enum<T>>

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

Constructor Summary

Constructors

Constructor and Description
Enum2BooleanMap(java.lang.Class<T> keyType) Default Constructor

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(java.lang.Object key)
boolean	containsValue(boolean value) Type Specific method to reduce boxing/unboxing of values
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()
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.
boolean	remove(T key, boolean value) Type Specific remove function to reduce boxing/unboxing
BooleanCollection	values()

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

computeBoolean, computeBooleanIfAbsent, computeBooleanIfPresent, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, mergeAllBoolean, mergeBoolean, putAll, putAll, putAll, putAllIfAbsent, replace, replace, replaceBooleans, replaceBooleans, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap

clear, containsValue, isEmpty, put, remove, size, 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

compute, computeIfAbsent, computeIfPresent, containsValue, forEach, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll

Methods inherited from interface java.util.Map

clear, isEmpty, size

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

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

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

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