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

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

java.lang.Object

java.util.AbstractMap<T,java.lang.Integer>

speiger.src.collections.objects.maps.abstracts.AbstractObject2IntMap<T>

speiger.src.collections.objects.maps.impl.misc.Enum2IntMap<T>

Type Parameters:

T - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.ToIntFunction<T>, java.util.Map<T,java.lang.Integer>, Object2IntFunction<T>, Object2IntMap<T>

Direct Known Subclasses:

LinkedEnum2IntMap

public class Enum2IntMap<T extends java.lang.Enum<T>>
extends AbstractObject2IntMap<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.AbstractObject2IntMap

AbstractObject2IntMap.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.Object2IntMap

Object2IntMap.Entry<T>, Object2IntMap.FastEntrySet<T>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	addTo(T key, int value) A Helper method to add a primitives together.
boolean	containsKey(java.lang.Object key)
boolean	containsValue(int value) Type Specific method to reduce boxing/unboxing of values
int	getInt(T key) A Type Specific get method to reduce boxing/unboxing
int	getOrDefault(T key, int defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
ObjectSet<T>	keySet()
ObjectSet<Object2IntMap.Entry<T>>	object2IntEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
int	put(T key, int value) Type Specific method to reduce boxing/unboxing of values
int	putIfAbsent(T key, int value) Type Specific method to reduce boxing/unboxing of values
int	rem(T key) Type Specific remove function to reduce boxing/unboxing
int	remOrDefault(T key, int defaultValue) Type-Specific Remove function with a default return value if wanted.
boolean	remove(T key, int value) Type Specific remove function to reduce boxing/unboxing
IntCollection	values()

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

addToAll, computeInt, computeIntIfAbsent, computeIntIfPresent, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, mergeAllInt, mergeInt, putAll, putAll, putAll, putAllIfAbsent, replace, replace, replaceInts, replaceInts, 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.Object2IntMap

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

applyAsInt

Constructor Detail

Enum2IntMap

public Enum2IntMap(java.lang.Class<T> keyType)

Default Constructor

Parameters:

keyType - the type of Enum that should be used

Method Detail

put

public int put(T key,
               int value)

Description copied from interface: Object2IntMap

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 int putIfAbsent(T key,
                       int value)

Description copied from interface: Object2IntMap

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)

addTo

public int addTo(T key,
                 int value)

Description copied from interface: Object2IntMap

A Helper method to add a primitives together. If key is not present then this functions as a put.

Parameters:

key - the key that should be inserted,

value - the value that should be inserted / added

Returns:

the last present value or default return value.

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<T extends java.lang.Enum<T>,java.lang.Integer>

Overrides:

containsKey in class AbstractObject2IntMap<T extends java.lang.Enum<T>>

containsValue

public boolean containsValue(int value)

Description copied from interface: Object2IntMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsValue in interface Object2IntMap<T extends java.lang.Enum<T>>

Overrides:

containsValue in class AbstractObject2IntMap<T extends java.lang.Enum<T>>

Parameters:

value - element that is searched for

Returns:

if the value is present

rem

public int rem(T key)

Description copied from interface: Object2IntMap

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 int remOrDefault(T key,
                        int defaultValue)

Description copied from interface: Object2IntMap

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,
                      int value)

Description copied from interface: Object2IntMap

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)

getInt

public int getInt(T key)

Description copied from interface: Object2IntMap

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 int getOrDefault(T key,
                        int defaultValue)

Description copied from interface: Object2IntMap

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

object2IntEntrySet

public ObjectSet<Object2IntMap.Entry<T>> object2IntEntrySet()

Description copied from interface: Object2IntMap

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

Specified by:

keySet in interface Object2IntMap<T extends java.lang.Enum<T>>

Overrides:

keySet in class AbstractObject2IntMap<T extends java.lang.Enum<T>>

values

public IntCollection values()

Specified by:

values in interface java.util.Map<T extends java.lang.Enum<T>,java.lang.Integer>

Specified by:

values in interface Object2IntMap<T extends java.lang.Enum<T>>

Overrides:

values in class AbstractObject2IntMap<T extends java.lang.Enum<T>>