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

Class Enum2ObjectMap<T extends java.lang.Enum<T>,V>

java.lang.Object

java.util.AbstractMap<T,V>

speiger.src.collections.objects.maps.abstracts.AbstractObject2ObjectMap<T,V>

speiger.src.collections.objects.maps.impl.misc.Enum2ObjectMap<T,V>

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.Function<T,V>, java.util.Map<T,V>, Object2ObjectFunction<T,V>, Object2ObjectMap<T,V>

Direct Known Subclasses:

LinkedEnum2ObjectMap

public class Enum2ObjectMap<T extends java.lang.Enum<T>,V>
extends AbstractObject2ObjectMap<T,V>

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

AbstractObject2ObjectMap.BasicEntry<T,V>

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

Object2ObjectMap.Entry<T,V>, Object2ObjectMap.FastEntrySet<T,V>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
V	getObject(T key) Type Specific get function to reduce boxing/unboxing
V	getOrDefault(java.lang.Object key, V defaultValue)
ObjectSet<T>	keySet()
ObjectSet<Object2ObjectMap.Entry<T,V>>	object2ObjectEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
V	put(T key, V value) Type Specific method to reduce boxing/unboxing of values
V	putIfAbsent(T key, V value) Type Specific method to reduce boxing/unboxing of values
V	rem(T key) Type Specific remove function to reduce boxing/unboxing
V	remOrDefault(T key, V defaultValue) Type-Specific Remove function with a default return value if wanted.
boolean	remove(java.lang.Object key, java.lang.Object value)
ObjectCollection<V>	values()

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

compute, computeIfAbsent, computeIfPresent, entrySet, equals, forEach, get, getDefaultReturnValue, hashCode, merge, mergeAll, putAll, putAll, putAll, putAllIfAbsent, replace, replace, replaceObjects, replaceObjects, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap

clear, isEmpty, 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.Object2ObjectMap

compute, computeIfAbsent, computeIfPresent, forEach, merge, putAll, remove, replaceAll

Methods inherited from interface java.util.Map

clear, isEmpty, size

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

apply

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Constructor Detail

Enum2ObjectMap

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

Default Constructor

Parameters:

keyType - the type of Enum that should be used

Method Detail

put

public V put(T key,
             V value)

Description copied from interface: Object2ObjectMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

put in interface java.util.Map<T extends java.lang.Enum<T>,V>

Specified by:

put in interface Object2ObjectMap<T extends java.lang.Enum<T>,V>

Overrides:

put in class java.util.AbstractMap<T extends java.lang.Enum<T>,V>

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

Description copied from interface: Object2ObjectMap

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

Overrides:

containsKey in class AbstractObject2ObjectMap<T extends java.lang.Enum<T>,V>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<T extends java.lang.Enum<T>,V>

Overrides:

containsValue in class AbstractObject2ObjectMap<T extends java.lang.Enum<T>,V>

rem

public V rem(T key)

Description copied from interface: Object2ObjectMap

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

Description copied from interface: Object2ObjectMap

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(java.lang.Object key,
                      java.lang.Object value)

getObject

public V getObject(T key)

Description copied from interface: Object2ObjectFunction

Type Specific get function to reduce boxing/unboxing

Parameters:

key - the value that should be processed

Returns:

the result of the function

getOrDefault

public V getOrDefault(java.lang.Object key,
                      V defaultValue)

Specified by:

getOrDefault in interface java.util.Map<T extends java.lang.Enum<T>,V>

Overrides:

getOrDefault in class AbstractObject2ObjectMap<T extends java.lang.Enum<T>,V>

object2ObjectEntrySet

public ObjectSet<Object2ObjectMap.Entry<T,V>> object2ObjectEntrySet()

Description copied from interface: Object2ObjectMap

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

Specified by:

keySet in interface Object2ObjectMap<T extends java.lang.Enum<T>,V>

Overrides:

keySet in class AbstractObject2ObjectMap<T extends java.lang.Enum<T>,V>

values

public ObjectCollection<V> values()

Specified by:

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

Specified by:

values in interface Object2ObjectMap<T extends java.lang.Enum<T>,V>

Overrides:

values in class AbstractObject2ObjectMap<T extends java.lang.Enum<T>,V>