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

Class Object2ObjectLinkedOpenHashMap<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.hash.Object2ObjectOpenHashMap<T,V>

speiger.src.collections.objects.maps.impl.hash.Object2ObjectLinkedOpenHashMap<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>, java.util.SortedMap<T,V>, Object2ObjectFunction<T,V>, Object2ObjectMap<T,V>, Object2ObjectSortedMap<T,V>

public class Object2ObjectLinkedOpenHashMap<T,V>
extends Object2ObjectOpenHashMap<T,V>
implements Object2ObjectSortedMap<T,V>

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

Object2ObjectSortedMap.FastSortedSet<T,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
Object2ObjectLinkedOpenHashMap() Default Constructor
Object2ObjectLinkedOpenHashMap(int minCapacity) Constructor that defines the minimum capacity
Object2ObjectLinkedOpenHashMap(int minCapacity, float loadFactor) Constructor that defines the minimum capacity and load factor
Object2ObjectLinkedOpenHashMap(java.util.Map<? extends T,? extends V> map) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Object2ObjectLinkedOpenHashMap(java.util.Map<? extends T,? extends V> map, float loadFactor) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Object2ObjectLinkedOpenHashMap(Object2ObjectMap<T,V> map) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Object2ObjectLinkedOpenHashMap(Object2ObjectMap<T,V> map, float loadFactor) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Object2ObjectLinkedOpenHashMap(T[] keys, V[] values) Helper constructor that allow to create a map from unboxed values
Object2ObjectLinkedOpenHashMap(T[] keys, V[] values, float loadFactor) Helper constructor that allow to create a map from unboxed values

Method Summary

Modifier and Type	Method and Description
void	clear()
java.util.Comparator<T>	comparator()
T	firstKey()
V	firstValue() A method to get the first Value of a Map.
void	forEach(ObjectObjectConsumer<T,V> action) Type Specific forEach method to reduce boxing/unboxing
V	getAndMoveToFirst(T key) A Specific get method that allows to move teh given key/value int the first index.
V	getAndMoveToLast(T key) A Specific get method that allows to move teh given key/value int the last index.
Object2ObjectSortedMap<T,V>	headMap(T toKey)
ObjectSet<T>	keySet()
T	lastKey()
V	lastValue() 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<Object2ObjectMap.Entry<T,V>>	object2ObjectEntrySet() 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.
V	putAndMoveToFirst(T key, V value) A customized put method that allows you to insert into the first index.
V	putAndMoveToLast(T key, V value) A customized put method that allows you to insert into the last index.
Object2ObjectSortedMap<T,V>	subMap(T fromKey, T toKey)
Object2ObjectSortedMap<T,V>	tailMap(T fromKey)
ObjectCollection<V>	values()

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

compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, get, getObject, getOrDefault, merge, mergeAll, put, putIfAbsent, rem, remOrDefault, remove, remove, replace, replace, size

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

entrySet, equals, getDefaultReturnValue, hashCode, putAll, putAll, putAll, putAllIfAbsent, replaceObjects, replaceObjects, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap

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

compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, entrySet, forEach, getDefaultReturnValue, merge, merge, mergeAll, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, rem, remOrDefault, remove, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue

Methods inherited from interface java.util.Map

containsKey, containsValue, equals, get, getOrDefault, hashCode, isEmpty, putAll, remove, size

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

apply, getObject

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Constructor Detail

Object2ObjectLinkedOpenHashMap

public Object2ObjectLinkedOpenHashMap()

Default Constructor

Object2ObjectLinkedOpenHashMap

public Object2ObjectLinkedOpenHashMap(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

Object2ObjectLinkedOpenHashMap

public Object2ObjectLinkedOpenHashMap(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

Object2ObjectLinkedOpenHashMap

public Object2ObjectLinkedOpenHashMap(T[] keys,
                                      V[] 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

Object2ObjectLinkedOpenHashMap

public Object2ObjectLinkedOpenHashMap(T[] keys,
                                      V[] 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

Object2ObjectLinkedOpenHashMap

public Object2ObjectLinkedOpenHashMap(java.util.Map<? extends T,? extends V> 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

Object2ObjectLinkedOpenHashMap

public Object2ObjectLinkedOpenHashMap(java.util.Map<? extends T,? extends V> 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

Object2ObjectLinkedOpenHashMap

public Object2ObjectLinkedOpenHashMap(Object2ObjectMap<T,V> 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

Object2ObjectLinkedOpenHashMap

public Object2ObjectLinkedOpenHashMap(Object2ObjectMap<T,V> 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 V putAndMoveToFirst(T key,
                           V value)

Description copied from interface: Object2ObjectSortedMap

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

Specified by:

putAndMoveToFirst in interface Object2ObjectSortedMap<T,V>

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

Description copied from interface: Object2ObjectSortedMap

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

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

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

Specified by:

moveToFirst in interface Object2ObjectSortedMap<T,V>

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

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

Specified by:

moveToLast in interface Object2ObjectSortedMap<T,V>

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public V getAndMoveToFirst(T key)

Description copied from interface: Object2ObjectSortedMap

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

Specified by:

getAndMoveToFirst in interface Object2ObjectSortedMap<T,V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public V getAndMoveToLast(T key)

Description copied from interface: Object2ObjectSortedMap

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

Specified by:

getAndMoveToLast in interface Object2ObjectSortedMap<T,V>

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

Specified by:

comparator in interface Object2ObjectSortedMap<T,V>

subMap

public Object2ObjectSortedMap<T,V> subMap(T fromKey,
                                          T toKey)

Specified by:

subMap in interface java.util.SortedMap<T,V>

Specified by:

subMap in interface Object2ObjectSortedMap<T,V>

headMap

public Object2ObjectSortedMap<T,V> headMap(T toKey)

Specified by:

headMap in interface java.util.SortedMap<T,V>

Specified by:

headMap in interface Object2ObjectSortedMap<T,V>

tailMap

public Object2ObjectSortedMap<T,V> tailMap(T fromKey)

Specified by:

tailMap in interface java.util.SortedMap<T,V>

Specified by:

tailMap in interface Object2ObjectSortedMap<T,V>

firstKey

public T firstKey()

Specified by:

firstKey in interface java.util.SortedMap<T,V>

pollFirstKey

public T pollFirstKey()

Description copied from interface: Object2ObjectSortedMap

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

Specified by:

pollFirstKey in interface Object2ObjectSortedMap<T,V>

Returns:

the first key in the map

lastKey

public T lastKey()

Specified by:

lastKey in interface java.util.SortedMap<T,V>

pollLastKey

public T pollLastKey()

Description copied from interface: Object2ObjectSortedMap

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

Specified by:

pollLastKey in interface Object2ObjectSortedMap<T,V>

Returns:

the last key in the map

firstValue

public V firstValue()

Description copied from interface: Object2ObjectSortedMap

A method to get the first Value of a Map.

Specified by:

firstValue in interface Object2ObjectSortedMap<T,V>

Returns:

the first key in the map

lastValue

public V lastValue()

Description copied from interface: Object2ObjectSortedMap

A method to get the last Value of a Map.

Specified by:

lastValue in interface Object2ObjectSortedMap<T,V>

Returns:

the last key in the map

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.

Specified by:

object2ObjectEntrySet in interface Object2ObjectMap<T,V>

Overrides:

object2ObjectEntrySet in class Object2ObjectOpenHashMap<T,V>

Returns:

a EntrySet of the collection

keySet

public ObjectSet<T> keySet()

Specified by:

keySet in interface java.util.Map<T,V>

Specified by:

keySet in interface java.util.SortedMap<T,V>

Specified by:

keySet in interface Object2ObjectMap<T,V>

Specified by:

keySet in interface Object2ObjectSortedMap<T,V>

Overrides:

keySet in class Object2ObjectOpenHashMap<T,V>

values

public ObjectCollection<V> values()

Specified by:

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

Specified by:

values in interface java.util.SortedMap<T,V>

Specified by:

values in interface Object2ObjectMap<T,V>

Specified by:

values in interface Object2ObjectSortedMap<T,V>

Overrides:

values in class Object2ObjectOpenHashMap<T,V>

forEach

public void forEach(ObjectObjectConsumer<T,V> action)

Description copied from interface: Object2ObjectMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Object2ObjectMap<T,V>

Overrides:

forEach in class Object2ObjectOpenHashMap<T,V>

Parameters:

action - processor of the values that are iterator over

clear

public void clear()

Specified by:

clear in interface java.util.Map<T,V>

Overrides:

clear in class Object2ObjectOpenHashMap<T,V>