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

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

java.lang.Object

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

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

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

Type Parameters:

T - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.Map<T,java.lang.Short>, Object2ShortFunction<T>, Object2ShortMap<T>

Direct Known Subclasses:

LinkedEnum2ShortMap

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

AbstractObject2ShortMap.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.Object2ShortMap

Object2ShortMap.Entry<T>, Object2ShortMap.FastEntrySet<T>

Constructor Summary

Constructors

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

Method Summary

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

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

addToAll, computeShort, computeShortIfAbsent, computeShortIfPresent, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, mergeAllShort, mergeShort, putAll, putAll, putAll, putAllIfAbsent, replace, replace, replaceShorts, replaceShorts, 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.Object2ShortMap

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

Methods inherited from interface java.util.Map

clear, isEmpty, size

Constructor Detail

Enum2ShortMap

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

Default Constructor

Parameters:

keyType - the type of Enum that should be used

Method Detail

put

public short put(T key,
                 short value)

Description copied from interface: Object2ShortMap

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

Description copied from interface: Object2ShortMap

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 short addTo(T key,
                   short value)

Description copied from interface: Object2ShortMap

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

Overrides:

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

containsValue

public boolean containsValue(short value)

Description copied from interface: Object2ShortMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

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

Overrides:

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

Parameters:

value - element that is searched for

Returns:

if the value is present

rem

public short rem(T key)

Description copied from interface: Object2ShortMap

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

Description copied from interface: Object2ShortMap

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

Description copied from interface: Object2ShortMap

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)

getShort

public short getShort(T key)

Description copied from interface: Object2ShortMap

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

Description copied from interface: Object2ShortMap

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

object2ShortEntrySet

public ObjectSet<Object2ShortMap.Entry<T>> object2ShortEntrySet()

Description copied from interface: Object2ShortMap

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

Specified by:

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

Overrides:

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

values

public ShortCollection values()

Specified by:

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

Specified by:

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

Overrides:

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