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

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

java.lang.Object

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

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

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

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

Type Parameters:

T - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.Map<T,java.lang.Character>, Object2CharFunction<T>, Object2CharMap<T>, Object2CharOrderedMap<T>

public class LinkedEnum2CharMap<T extends java.lang.Enum<T>>
extends Enum2CharMap<T>
implements Object2CharOrderedMap<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.AbstractObject2CharMap

AbstractObject2CharMap.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.Object2CharOrderedMap

Object2CharOrderedMap.FastOrderedSet<T>

Nested classes/interfaces inherited from interface speiger.src.collections.objects.maps.interfaces.Object2CharMap

Object2CharMap.BuilderCache<T>, Object2CharMap.Entry<T>, Object2CharMap.FastEntrySet<T>, Object2CharMap.MapBuilder

Constructor Summary

Constructors

Constructor and Description
LinkedEnum2CharMap(java.lang.Class<T> keyType) Default Constructor
LinkedEnum2CharMap(java.util.Map<? extends T,? extends java.lang.Character> map) A Helper constructor that allows to create a EnumMap with exactly the same values as the provided map.
LinkedEnum2CharMap(Object2CharMap<T> map) A Type Specific Helper function that allows to create a new EnumMap with exactly the same values as the provided map.
LinkedEnum2CharMap(T[] keys, char[] values) Helper constructor that allow to create a EnumMap from unboxed values
LinkedEnum2CharMap(T[] keys, java.lang.Character[] values) Helper constructor that allow to create a EnumMap from boxed values (it will unbox them)

Method Summary

Modifier and Type	Method and Description
void	clear()
LinkedEnum2CharMap<T>	copy() A Function that does a shallow clone of the Map itself.
char	firstCharValue() A method to get the first Value of a Map.
T	firstKey() A method to get the first Key of a Map.
void	forEach(ObjectCharConsumer<T> action) Type Specific forEach method to reduce boxing/unboxing
char	getAndMoveToFirst(T key) A Specific get method that allows to move teh given key/value int the first index.
char	getAndMoveToLast(T key) A Specific get method that allows to move teh given key/value int the last index.
ObjectOrderedSet<T>	keySet()
char	lastCharValue() A method to get the last Value of a Map.
T	lastKey() A method to get the last Key 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.
ObjectOrderedSet<Object2CharMap.Entry<T>>	object2CharEntrySet() 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.
char	putAndMoveToFirst(T key, char value) A customized put method that allows you to insert into the first index.
char	putAndMoveToLast(T key, char value) A customized put method that allows you to insert into the last index.
CharCollection	values()

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

addTo, computeChar, computeCharIfAbsent, computeCharIfPresent, containsKey, containsValue, getChar, getOrDefault, mergeAllChar, mergeChar, put, putIfAbsent, rem, remOrDefault, remove, remove, replace, replace, size, subFrom, supplyCharIfAbsent

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

addToAll, entrySet, equals, get, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, replaceChars, replaceChars, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap

containsValue, isEmpty, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

synchronize, synchronize, unmodifiable

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

addTo, addToAll, builder, compute, computeChar, computeCharIfAbsent, computeCharIfPresent, computeIfAbsent, computeIfPresent, containsValue, containsValue, entrySet, forEach, get, getChar, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllChar, mergeChar, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, rem, remOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceChars, replaceChars, setDefaultReturnValue, subFrom, supplyCharIfAbsent

Methods inherited from interface java.util.Map

containsKey, equals, hashCode, isEmpty, putAll, size

Constructor Detail

LinkedEnum2CharMap

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

Default Constructor

Parameters:

keyType - the type of Enum that should be used

LinkedEnum2CharMap

public LinkedEnum2CharMap(T[] keys,
                          java.lang.Character[] values)

Helper constructor that allow to create a EnumMap from boxed values (it will unbox them)

Parameters:

keys - the keys that should be put into the EnumMap

values - the values that should be put into the EnumMap.

Throws:

java.lang.IllegalStateException - if the keys and values do not match in lenght

LinkedEnum2CharMap

public LinkedEnum2CharMap(T[] keys,
                          char[] values)

Helper constructor that allow to create a EnumMap from unboxed values

Parameters:

keys - the keys that should be put into the map

values - the values that should be put into the map.

Throws:

java.lang.IllegalStateException - if the keys and values do not match in lenght

LinkedEnum2CharMap

public LinkedEnum2CharMap(java.util.Map<? extends T,? extends java.lang.Character> map)

A Helper constructor that allows to create a EnumMap with exactly the same values as the provided map.

Parameters:

map - the values that should be present in the map

LinkedEnum2CharMap

public LinkedEnum2CharMap(Object2CharMap<T> map)

A Type Specific Helper function that allows to create a new EnumMap with exactly the same values as the provided map.

Parameters:

map - the values that should be present in the map

Method Detail

putAndMoveToFirst

public char putAndMoveToFirst(T key,
                              char value)

Description copied from interface: Object2CharOrderedMap

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

Specified by:

putAndMoveToFirst in interface Object2CharOrderedMap<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 char putAndMoveToLast(T key,
                             char value)

Description copied from interface: Object2CharOrderedMap

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

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

Specified by:

moveToFirst in interface Object2CharOrderedMap<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: Object2CharOrderedMap

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

Specified by:

moveToLast in interface Object2CharOrderedMap<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 char getAndMoveToFirst(T key)

Description copied from interface: Object2CharOrderedMap

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

Specified by:

getAndMoveToFirst in interface Object2CharOrderedMap<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 char getAndMoveToLast(T key)

Description copied from interface: Object2CharOrderedMap

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

Specified by:

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

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

copy

public LinkedEnum2CharMap<T> copy()

Description copied from interface: Object2CharMap

A Function that does a shallow clone of the Map itself. This function is more optimized then a copy constructor since the Map does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk

Specified by:

copy in interface Object2CharMap<T extends java.lang.Enum<T>>

Specified by:

copy in interface Object2CharOrderedMap<T extends java.lang.Enum<T>>

Overrides:

copy in class Enum2CharMap<T extends java.lang.Enum<T>>

Returns:

a Shallow Copy of the Map

firstKey

public T firstKey()

Description copied from interface: Object2CharOrderedMap

A method to get the first Key of a Map.

Specified by:

firstKey in interface Object2CharOrderedMap<T extends java.lang.Enum<T>>

Returns:

the first key in the map

pollFirstKey

public T pollFirstKey()

Description copied from interface: Object2CharOrderedMap

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

Specified by:

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

Returns:

the first key in the map

lastKey

public T lastKey()

Description copied from interface: Object2CharOrderedMap

A method to get the last Key of a Map.

Specified by:

lastKey in interface Object2CharOrderedMap<T extends java.lang.Enum<T>>

Returns:

the last key in the map

pollLastKey

public T pollLastKey()

Description copied from interface: Object2CharOrderedMap

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

Specified by:

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

Returns:

the last key in the map

firstCharValue

public char firstCharValue()

Description copied from interface: Object2CharOrderedMap

A method to get the first Value of a Map.

Specified by:

firstCharValue in interface Object2CharOrderedMap<T extends java.lang.Enum<T>>

Returns:

the first key in the map

lastCharValue

public char lastCharValue()

Description copied from interface: Object2CharOrderedMap

A method to get the last Value of a Map.

Specified by:

lastCharValue in interface Object2CharOrderedMap<T extends java.lang.Enum<T>>

Returns:

the last key in the map

object2CharEntrySet

public ObjectOrderedSet<Object2CharMap.Entry<T>> object2CharEntrySet()

Description copied from interface: Object2CharMap

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

Specified by:

object2CharEntrySet in interface Object2CharMap<T extends java.lang.Enum<T>>

Specified by:

object2CharEntrySet in interface Object2CharOrderedMap<T extends java.lang.Enum<T>>

Overrides:

object2CharEntrySet in class Enum2CharMap<T extends java.lang.Enum<T>>

Returns:

a EntrySet of the collection

keySet

public ObjectOrderedSet<T> keySet()

Specified by:

keySet in interface java.util.Map<T extends java.lang.Enum<T>,java.lang.Character>

Specified by:

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

Specified by:

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

Overrides:

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

values

public CharCollection values()

Specified by:

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

Specified by:

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

Overrides:

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

forEach

public void forEach(ObjectCharConsumer<T> action)

Description copied from interface: Object2CharMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

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

Overrides:

forEach in class Enum2CharMap<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.Character>

Overrides:

clear in class Enum2CharMap<T extends java.lang.Enum<T>>