speiger.src.collections.objects.maps.impl.hash

Class Object2CharLinkedOpenHashMap<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.hash.Object2CharOpenHashMap<T>

speiger.src.collections.objects.maps.impl.hash.Object2CharLinkedOpenHashMap<T>

Type Parameters:

T - the type of elements maintained by this Collection

All Implemented Interfaces:

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

public class Object2CharLinkedOpenHashMap<T>
extends Object2CharOpenHashMap<T>
implements Object2CharSortedMap<T>

A Type Specific LinkedHashMap implementation that uses specific arrays to create links between nodes to remove the wrapping of elements to greatly reduce memory usage. In Addition adding some helper methods to move around elements. This implementation of SortedMap does not support SubMaps of any kind. It implements the interface due to sortability and first/last access

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

Object2CharSortedMap.FastSortedSet<T>

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

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

Constructor Summary

Constructors

Constructor and Description
Object2CharLinkedOpenHashMap() Default Constructor
Object2CharLinkedOpenHashMap(int minCapacity) Constructor that defines the minimum capacity
Object2CharLinkedOpenHashMap(int minCapacity, float loadFactor) Constructor that defines the minimum capacity and load factor
Object2CharLinkedOpenHashMap(java.util.Map<? extends T,? extends java.lang.Character> map) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Object2CharLinkedOpenHashMap(java.util.Map<? extends T,? extends java.lang.Character> map, float loadFactor) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Object2CharLinkedOpenHashMap(Object2CharMap<T> map) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Object2CharLinkedOpenHashMap(Object2CharMap<T> map, float loadFactor) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Object2CharLinkedOpenHashMap(T[] keys, char[] values) Helper constructor that allow to create a map from unboxed values
Object2CharLinkedOpenHashMap(T[] keys, char[] values, float loadFactor) Helper constructor that allow to create a map from unboxed values
Object2CharLinkedOpenHashMap(T[] keys, java.lang.Character[] values) Helper constructor that allow to create a map from boxed values (it will unbox them)
Object2CharLinkedOpenHashMap(T[] keys, java.lang.Character[] values, float loadFactor) Helper constructor that allow to create a map from boxed values (it will unbox them)

Method Summary

Modifier and Type	Method and Description
void	clear()
java.util.Comparator<T>	comparator()
char	firstCharValue() A method to get the first Value of a Map.
T	firstKey()
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.
Object2CharSortedMap<T>	headMap(T toKey)
ObjectSet<T>	keySet()
char	lastCharValue() A method to get the last Value of a Map.
T	lastKey()
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<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.
Object2CharSortedMap<T>	subMap(T fromKey, T toKey)
Object2CharSortedMap<T>	tailMap(T fromKey)
CharCollection	values()

Methods inherited from class speiger.src.collections.objects.maps.impl.hash.Object2CharOpenHashMap

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

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

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

Methods inherited from class java.util.AbstractMap

isEmpty, put, 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.Object2CharMap

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

Methods inherited from interface java.util.Map

containsKey, equals, hashCode, isEmpty, putAll, size

Constructor Detail

Object2CharLinkedOpenHashMap

public Object2CharLinkedOpenHashMap()

Default Constructor

Object2CharLinkedOpenHashMap

public Object2CharLinkedOpenHashMap(int minCapacity)

Constructor that defines the minimum capacity

Parameters:

minCapacity - the minimum capacity the HashMap is allowed to be.

Throws:

java.lang.IllegalStateException - if the minimum capacity is negative

Object2CharLinkedOpenHashMap

public Object2CharLinkedOpenHashMap(int minCapacity,
                                    float loadFactor)

Constructor that defines the minimum capacity and load factor

Parameters:

minCapacity - the minimum capacity the HashMap is allowed to be.

loadFactor - the percentage of how full the backing array can be before they resize

Throws:

java.lang.IllegalStateException - if the minimum capacity is negative

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

Object2CharLinkedOpenHashMap

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

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

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

Object2CharLinkedOpenHashMap

public Object2CharLinkedOpenHashMap(T[] keys,
                                    java.lang.Character[] values,
                                    float loadFactor)

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

Parameters:

keys - the keys that should be put into the map

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

loadFactor - the percentage of how full the backing array can be before they resize

Throws:

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

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

Object2CharLinkedOpenHashMap

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

Helper constructor that allow to create a map 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

Object2CharLinkedOpenHashMap

public Object2CharLinkedOpenHashMap(T[] keys,
                                    char[] values,
                                    float loadFactor)

Helper constructor that allow to create a map from unboxed values

Parameters:

keys - the keys that should be put into the map

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

loadFactor - the percentage of how full the backing array can be before they resize

Throws:

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

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

Object2CharLinkedOpenHashMap

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

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

Parameters:

map - the values that should be present in the map

Object2CharLinkedOpenHashMap

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

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

Parameters:

map - the values that should be present in the map

loadFactor - the percentage of how full the backing array can be before they resize

Throws:

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

Object2CharLinkedOpenHashMap

public Object2CharLinkedOpenHashMap(Object2CharMap<T> map)

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

Parameters:

map - the values that should be present in the map

Object2CharLinkedOpenHashMap

public Object2CharLinkedOpenHashMap(Object2CharMap<T> map,
                                    float loadFactor)

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

Parameters:

map - the values that should be present in the map

loadFactor - the percentage of how full the backing array can be before they resize

Throws:

java.lang.IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

Method Detail

putAndMoveToFirst

public char putAndMoveToFirst(T key,
                              char value)

Description copied from interface: Object2CharSortedMap

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

Specified by:

putAndMoveToFirst in interface Object2CharSortedMap<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: Object2CharSortedMap

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

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

Specified by:

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

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

Specified by:

moveToLast in interface Object2CharSortedMap<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: Object2CharSortedMap

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

Specified by:

getAndMoveToFirst in interface Object2CharSortedMap<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: Object2CharSortedMap

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

Specified by:

getAndMoveToLast in interface Object2CharSortedMap<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,java.lang.Character>

Specified by:

comparator in interface Object2CharSortedMap<T>

subMap

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

Specified by:

subMap in interface java.util.SortedMap<T,java.lang.Character>

Specified by:

subMap in interface Object2CharSortedMap<T>

headMap

public Object2CharSortedMap<T> headMap(T toKey)

Specified by:

headMap in interface java.util.SortedMap<T,java.lang.Character>

Specified by:

headMap in interface Object2CharSortedMap<T>

tailMap

public Object2CharSortedMap<T> tailMap(T fromKey)

Specified by:

tailMap in interface java.util.SortedMap<T,java.lang.Character>

Specified by:

tailMap in interface Object2CharSortedMap<T>

firstKey

public T firstKey()

Specified by:

firstKey in interface java.util.SortedMap<T,java.lang.Character>

pollFirstKey

public T pollFirstKey()

Description copied from interface: Object2CharSortedMap

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

Specified by:

pollFirstKey in interface Object2CharSortedMap<T>

Returns:

the first key in the map

lastKey

public T lastKey()

Specified by:

lastKey in interface java.util.SortedMap<T,java.lang.Character>

pollLastKey

public T pollLastKey()

Description copied from interface: Object2CharSortedMap

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

Specified by:

pollLastKey in interface Object2CharSortedMap<T>

Returns:

the last key in the map

firstCharValue

public char firstCharValue()

Description copied from interface: Object2CharSortedMap

A method to get the first Value of a Map.

Specified by:

firstCharValue in interface Object2CharSortedMap<T>

Returns:

the first key in the map

lastCharValue

public char lastCharValue()

Description copied from interface: Object2CharSortedMap

A method to get the last Value of a Map.

Specified by:

lastCharValue in interface Object2CharSortedMap<T>

Returns:

the last key in the map

object2CharEntrySet

public ObjectSet<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>

Overrides:

object2CharEntrySet in class Object2CharOpenHashMap<T>

Returns:

a EntrySet of the collection

keySet

public ObjectSet<T> keySet()

Specified by:

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

Specified by:

keySet in interface java.util.SortedMap<T,java.lang.Character>

Specified by:

keySet in interface Object2CharMap<T>

Specified by:

keySet in interface Object2CharSortedMap<T>

Overrides:

keySet in class Object2CharOpenHashMap<T>

values

public CharCollection values()

Specified by:

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

Specified by:

values in interface java.util.SortedMap<T,java.lang.Character>

Specified by:

values in interface Object2CharMap<T>

Specified by:

values in interface Object2CharSortedMap<T>

Overrides:

values in class Object2CharOpenHashMap<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>

Overrides:

forEach in class Object2CharOpenHashMap<T>

Parameters:

action - processor of the values that are iterator over

clear

public void clear()

Specified by:

clear in interface java.util.Map<T,java.lang.Character>

Overrides:

clear in class Object2CharOpenHashMap<T>