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

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

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

Type Parameters:

T - the type of elements maintained by this Collection

All Implemented Interfaces:

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

public class LinkedEnum2ShortMap<T extends java.lang.Enum<T>>
extends Enum2ShortMap<T>
implements Object2ShortSortedMap<T>

A Type Specific LinkedEnumMap implementation that allows for Primitive Values and faster iteration. 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.Object2ShortSortedMap

Object2ShortSortedMap.FastSortedSet<T>

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
LinkedEnum2ShortMap(java.lang.Class<T> keyType) Default Constructor

Method Summary

Modifier and Type	Method and Description
void	clear()
java.util.Comparator<T>	comparator()
T	firstKey()
short	firstShortValue() A method to get the first Value of a Map.
void	forEach(ObjectShortConsumer<T> action) Type Specific forEach method to reduce boxing/unboxing
short	getAndMoveToFirst(T key) A Specific get method that allows to move teh given key/value int the first index.
short	getAndMoveToLast(T key) A Specific get method that allows to move teh given key/value int the last index.
Object2ShortSortedMap<T>	headMap(T toKey)
ObjectSet<T>	keySet()
T	lastKey()
short	lastShortValue() A method to get the last Value of a Map.
boolean	moveToFirst(T key) A specific move method to move a given key/value to the first index.
boolean	moveToLast(T key) A specific move method to move a given key/value to the last index.
ObjectSet<Object2ShortMap.Entry<T>>	object2ShortEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
T	pollFirstKey() A method to get and remove the first Key of a Map.
T	pollLastKey() A method to get and remove the last Key of a Map.
short	putAndMoveToFirst(T key, short value) A customized put method that allows you to insert into the first index.
short	putAndMoveToLast(T key, short value) A customized put method that allows you to insert into the last index.
Object2ShortSortedMap<T>	subMap(T fromKey, T toKey)
Object2ShortSortedMap<T>	tailMap(T fromKey)
ShortCollection	values()

Methods inherited from class speiger.src.collections.objects.maps.impl.misc.Enum2ShortMap

addTo, containsKey, containsValue, getOrDefault, getShort, put, putIfAbsent, rem, remOrDefault, remove

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

addToAll, computeShort, computeShortIfAbsent, computeShortIfPresent, entrySet, equals, get, getDefaultReturnValue, getOrDefault, hashCode, mergeAllShort, mergeShort, putAll, putAll, putAll, putAllIfAbsent, replace, replace, replaceShorts, replaceShorts, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap

containsValue, isEmpty, put, remove, size, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.SortedMap

entrySet

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2ShortMap

addTo, addToAll, compute, computeIfAbsent, computeIfPresent, computeShort, computeShortIfAbsent, computeShortIfPresent, containsValue, containsValue, entrySet, forEach, get, getDefaultReturnValue, getOrDefault, getOrDefault, getShort, merge, mergeAllShort, mergeShort, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, rem, remOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceShorts, replaceShorts, setDefaultReturnValue

Methods inherited from interface java.util.Map

containsKey, equals, hashCode, isEmpty, putAll, size

Constructor Detail

LinkedEnum2ShortMap

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

Default Constructor

Parameters:

keyType - the type of Enum that should be used

Method Detail

putAndMoveToFirst

public short putAndMoveToFirst(T key,
                               short value)

Description copied from interface: Object2ShortSortedMap

A customized put method that allows you to insert into the first index.

Specified by:

putAndMoveToFirst in interface Object2ShortSortedMap<T extends java.lang.Enum<T>>

Parameters:

key - the key that should be inserted

value - the value that should be inserted

Returns:

the previous present or default return value

See Also:

Map.put(Object, Object)

putAndMoveToLast

public short putAndMoveToLast(T key,
                              short value)

Description copied from interface: Object2ShortSortedMap

A customized put method that allows you to insert into the last index. (This may be nessesary depending on the implementation)

Specified by:

putAndMoveToLast in interface Object2ShortSortedMap<T extends java.lang.Enum<T>>

Parameters:

key - the key that should be inserted

value - the value that should be inserted

Returns:

the previous present or default return value

See Also:

Map.put(Object, Object)

moveToFirst

public boolean moveToFirst(T key)

Description copied from interface: Object2ShortSortedMap

A specific move method to move a given key/value to the first index.

Specified by:

moveToFirst in interface Object2ShortSortedMap<T extends java.lang.Enum<T>>

Parameters:

key - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(T key)

Description copied from interface: Object2ShortSortedMap

A specific move method to move a given key/value to the last index.

Specified by:

moveToLast in interface Object2ShortSortedMap<T extends java.lang.Enum<T>>

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public short getAndMoveToFirst(T key)

Description copied from interface: Object2ShortSortedMap

A Specific get method that allows to move teh given key/value int the first index.

Specified by:

getAndMoveToFirst in interface Object2ShortSortedMap<T extends java.lang.Enum<T>>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public short getAndMoveToLast(T key)

Description copied from interface: Object2ShortSortedMap

A Specific get method that allows to move teh given key/value int the last index.

Specified by:

getAndMoveToLast in interface Object2ShortSortedMap<T extends java.lang.Enum<T>>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

comparator

public java.util.Comparator<T> comparator()

Specified by:

comparator in interface java.util.SortedMap<T extends java.lang.Enum<T>,java.lang.Short>

Specified by:

comparator in interface Object2ShortSortedMap<T extends java.lang.Enum<T>>

subMap

public Object2ShortSortedMap<T> subMap(T fromKey,
                                       T toKey)

Specified by:

subMap in interface java.util.SortedMap<T extends java.lang.Enum<T>,java.lang.Short>

Specified by:

subMap in interface Object2ShortSortedMap<T extends java.lang.Enum<T>>

headMap

public Object2ShortSortedMap<T> headMap(T toKey)

Specified by:

headMap in interface java.util.SortedMap<T extends java.lang.Enum<T>,java.lang.Short>

Specified by:

headMap in interface Object2ShortSortedMap<T extends java.lang.Enum<T>>

tailMap

public Object2ShortSortedMap<T> tailMap(T fromKey)

Specified by:

tailMap in interface java.util.SortedMap<T extends java.lang.Enum<T>,java.lang.Short>

Specified by:

tailMap in interface Object2ShortSortedMap<T extends java.lang.Enum<T>>

firstKey

public T firstKey()

Specified by:

firstKey in interface java.util.SortedMap<T extends java.lang.Enum<T>,java.lang.Short>

pollFirstKey

public T pollFirstKey()

Description copied from interface: Object2ShortSortedMap

A method to get and remove the first Key of a Map.

Specified by:

pollFirstKey in interface Object2ShortSortedMap<T extends java.lang.Enum<T>>

Returns:

the first key in the map

lastKey

public T lastKey()

Specified by:

lastKey in interface java.util.SortedMap<T extends java.lang.Enum<T>,java.lang.Short>

pollLastKey

public T pollLastKey()

Description copied from interface: Object2ShortSortedMap

A method to get and remove the last Key of a Map.

Specified by:

pollLastKey in interface Object2ShortSortedMap<T extends java.lang.Enum<T>>

Returns:

the last key in the map

firstShortValue

public short firstShortValue()

Description copied from interface: Object2ShortSortedMap

A method to get the first Value of a Map.

Specified by:

firstShortValue in interface Object2ShortSortedMap<T extends java.lang.Enum<T>>

Returns:

the first key in the map

lastShortValue

public short lastShortValue()

Description copied from interface: Object2ShortSortedMap

A method to get the last Value of a Map.

Specified by:

lastShortValue in interface Object2ShortSortedMap<T extends java.lang.Enum<T>>

Returns:

the last key in the map

object2ShortEntrySet

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

Description copied from interface: Object2ShortMap

Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.

Specified by:

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

Overrides:

object2ShortEntrySet in class Enum2ShortMap<T extends java.lang.Enum<T>>

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 java.util.SortedMap<T extends java.lang.Enum<T>,java.lang.Short>

Specified by:

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

Specified by:

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

Overrides:

keySet in class Enum2ShortMap<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 java.util.SortedMap<T extends java.lang.Enum<T>,java.lang.Short>

Specified by:

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

Specified by:

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

Overrides:

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

forEach

public void forEach(ObjectShortConsumer<T> action)

Description copied from interface: Object2ShortMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

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

Overrides:

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

Parameters:

action - processor of the values that are iterator over

clear

public void clear()

Specified by:

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

Overrides:

clear in class java.util.AbstractMap<T extends java.lang.Enum<T>,java.lang.Short>