speiger.src.collections.longs.maps.impl.hash

Class Long2ObjectLinkedOpenHashMap<V>

java.lang.Object

java.util.AbstractMap<java.lang.Long,V>

speiger.src.collections.longs.maps.abstracts.AbstractLong2ObjectMap<V>

speiger.src.collections.longs.maps.impl.hash.Long2ObjectOpenHashMap<V>

speiger.src.collections.longs.maps.impl.hash.Long2ObjectLinkedOpenHashMap<V>

Type Parameters:

V - the keyType of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.LongFunction<V>, java.util.Map<java.lang.Long,V>, Long2ObjectMap<V>, Long2ObjectOrderedMap<V>, ITrimmable

public class Long2ObjectLinkedOpenHashMap<V>
extends Long2ObjectOpenHashMap<V>
implements Long2ObjectOrderedMap<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.longs.maps.abstracts.AbstractLong2ObjectMap

AbstractLong2ObjectMap.BasicEntry<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.longs.maps.interfaces.Long2ObjectOrderedMap

Long2ObjectOrderedMap.FastOrderedSet<V>

Nested classes/interfaces inherited from interface speiger.src.collections.longs.maps.interfaces.Long2ObjectMap

Long2ObjectMap.BuilderCache<V>, Long2ObjectMap.Entry<V>, Long2ObjectMap.FastEntrySet<V>, Long2ObjectMap.MapBuilder

Constructor Summary

Constructors

Constructor and Description
Long2ObjectLinkedOpenHashMap() Default Constructor
Long2ObjectLinkedOpenHashMap(int minCapacity) Constructor that defines the minimum capacity
Long2ObjectLinkedOpenHashMap(int minCapacity, float loadFactor) Constructor that defines the minimum capacity and load factor
Long2ObjectLinkedOpenHashMap(long[] keys, V[] values) Helper constructor that allow to create a map from unboxed values
Long2ObjectLinkedOpenHashMap(java.lang.Long[] keys, V[] values) Helper constructor that allow to create a map from boxed values (it will unbox them)
Long2ObjectLinkedOpenHashMap(long[] keys, V[] values, float loadFactor) Helper constructor that allow to create a map from unboxed values
Long2ObjectLinkedOpenHashMap(java.lang.Long[] keys, V[] values, float loadFactor) Helper constructor that allow to create a map from boxed values (it will unbox them)
Long2ObjectLinkedOpenHashMap(Long2ObjectMap<V> map) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Long2ObjectLinkedOpenHashMap(Long2ObjectMap<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.
Long2ObjectLinkedOpenHashMap(java.util.Map<? extends java.lang.Long,? extends V> map) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Long2ObjectLinkedOpenHashMap(java.util.Map<? extends java.lang.Long,? extends V> map, float loadFactor) A Helper constructor that allows to create a Map with exactly the same values as the provided map.

Method Summary

Modifier and Type	Method and Description
void	clear()
void	clearAndTrim(int size) Trims the collection down to the requested size and clears all elements while doing so
boolean	containsValue(java.lang.Object value)
Long2ObjectLinkedOpenHashMap<V>	copy() A Function that does a shallow clone of the Map itself.
long	firstLongKey() A method to get the first Key of a Map.
V	firstValue() A method to get the first Value of a Map.
void	forEach(LongObjectConsumer<V> action) Type Specific forEach method to reduce boxing/unboxing
V	getAndMoveToFirst(long key) A Specific get method that allows to move teh given key/value int the first index.
V	getAndMoveToLast(long key) A Specific get method that allows to move teh given key/value int the last index.
LongOrderedSet	keySet()
long	lastLongKey() A method to get the last Key of a Map.
V	lastValue() A method to get the last Value of a Map.
ObjectOrderedSet<Long2ObjectMap.Entry<V>>	long2ObjectEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
boolean	moveToFirst(long key) A specific move method to move a given key/value to the first index.
boolean	moveToLast(long key) A specific move method to move a given key/value to the last index.
long	pollFirstLongKey() A method to get and remove the first Key of a Map.
long	pollLastLongKey() A method to get and remove the last Key of a Map.
V	putAndMoveToFirst(long key, V value) A customized put method that allows you to insert into the first index.
V	putAndMoveToLast(long key, V value) A customized put method that allows you to insert into the last index.
ObjectCollection<V>	values()

Methods inherited from class speiger.src.collections.longs.maps.impl.hash.Long2ObjectOpenHashMap

compute, computeIfAbsent, computeIfPresent, containsKey, containsKey, get, get, getOrDefault, merge, mergeAll, put, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, size, supplyIfAbsent, trim

Methods inherited from class speiger.src.collections.longs.maps.abstracts.AbstractLong2ObjectMap

entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, 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 speiger.src.collections.longs.maps.interfaces.Long2ObjectOrderedMap

synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.longs.maps.interfaces.Long2ObjectMap

apply, builder, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, merge, mergeAll, put, put, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceObjects, replaceObjects, setDefaultReturnValue, supplyIfAbsent

Methods inherited from interface java.util.Map

equals, hashCode, isEmpty, putAll, size

Methods inherited from interface speiger.src.collections.utils.ITrimmable

clearAndTrim, trim

Constructor Detail

Long2ObjectLinkedOpenHashMap

public Long2ObjectLinkedOpenHashMap()

Default Constructor

Long2ObjectLinkedOpenHashMap

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

Long2ObjectLinkedOpenHashMap

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

Long2ObjectLinkedOpenHashMap

public Long2ObjectLinkedOpenHashMap(java.lang.Long[] keys,
                                    V[] 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

Long2ObjectLinkedOpenHashMap

public Long2ObjectLinkedOpenHashMap(java.lang.Long[] keys,
                                    V[] 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

Long2ObjectLinkedOpenHashMap

public Long2ObjectLinkedOpenHashMap(long[] 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

Long2ObjectLinkedOpenHashMap

public Long2ObjectLinkedOpenHashMap(long[] 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

Long2ObjectLinkedOpenHashMap

public Long2ObjectLinkedOpenHashMap(java.util.Map<? extends java.lang.Long,? 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

Long2ObjectLinkedOpenHashMap

public Long2ObjectLinkedOpenHashMap(java.util.Map<? extends java.lang.Long,? 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

Long2ObjectLinkedOpenHashMap

public Long2ObjectLinkedOpenHashMap(Long2ObjectMap<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

Long2ObjectLinkedOpenHashMap

public Long2ObjectLinkedOpenHashMap(Long2ObjectMap<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(long key,
                           V value)

Description copied from interface: Long2ObjectOrderedMap

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

Specified by:

putAndMoveToFirst in interface Long2ObjectOrderedMap<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(long key,
                          V value)

Description copied from interface: Long2ObjectOrderedMap

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 Long2ObjectOrderedMap<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(long key)

Description copied from interface: Long2ObjectOrderedMap

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

Specified by:

moveToFirst in interface Long2ObjectOrderedMap<V>

Parameters:

key - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(long key)

Description copied from interface: Long2ObjectOrderedMap

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

Specified by:

moveToLast in interface Long2ObjectOrderedMap<V>

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public V getAndMoveToFirst(long key)

Description copied from interface: Long2ObjectOrderedMap

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

Specified by:

getAndMoveToFirst in interface Long2ObjectOrderedMap<V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public V getAndMoveToLast(long key)

Description copied from interface: Long2ObjectOrderedMap

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

Specified by:

getAndMoveToLast in interface Long2ObjectOrderedMap<V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<java.lang.Long,V>

Overrides:

containsValue in class Long2ObjectOpenHashMap<V>

copy

public Long2ObjectLinkedOpenHashMap<V> copy()

Description copied from interface: Long2ObjectMap

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

Specified by:

copy in interface Long2ObjectOrderedMap<V>

Overrides:

copy in class Long2ObjectOpenHashMap<V>

Returns:

a Shallow Copy of the Map

firstLongKey

public long firstLongKey()

Description copied from interface: Long2ObjectOrderedMap

A method to get the first Key of a Map.

Specified by:

firstLongKey in interface Long2ObjectOrderedMap<V>

Returns:

the first key in the map

pollFirstLongKey

public long pollFirstLongKey()

Description copied from interface: Long2ObjectOrderedMap

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

Specified by:

pollFirstLongKey in interface Long2ObjectOrderedMap<V>

Returns:

the first key in the map

lastLongKey

public long lastLongKey()

Description copied from interface: Long2ObjectOrderedMap

A method to get the last Key of a Map.

Specified by:

lastLongKey in interface Long2ObjectOrderedMap<V>

Returns:

the last key in the map

pollLastLongKey

public long pollLastLongKey()

Description copied from interface: Long2ObjectOrderedMap

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

Specified by:

pollLastLongKey in interface Long2ObjectOrderedMap<V>

Returns:

the last key in the map

firstValue

public V firstValue()

Description copied from interface: Long2ObjectOrderedMap

A method to get the first Value of a Map.

Specified by:

firstValue in interface Long2ObjectOrderedMap<V>

Returns:

the first key in the map

lastValue

public V lastValue()

Description copied from interface: Long2ObjectOrderedMap

A method to get the last Value of a Map.

Specified by:

lastValue in interface Long2ObjectOrderedMap<V>

Returns:

the last key in the map

long2ObjectEntrySet

public ObjectOrderedSet<Long2ObjectMap.Entry<V>> long2ObjectEntrySet()

Description copied from interface: Long2ObjectMap

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

Specified by:

long2ObjectEntrySet in interface Long2ObjectMap<V>

Specified by:

long2ObjectEntrySet in interface Long2ObjectOrderedMap<V>

Overrides:

long2ObjectEntrySet in class Long2ObjectOpenHashMap<V>

Returns:

a EntrySet of the collection

keySet

public LongOrderedSet keySet()

Specified by:

keySet in interface java.util.Map<java.lang.Long,V>

Specified by:

keySet in interface Long2ObjectMap<V>

Specified by:

keySet in interface Long2ObjectOrderedMap<V>

Overrides:

keySet in class Long2ObjectOpenHashMap<V>

values

public ObjectCollection<V> values()

Specified by:

values in interface java.util.Map<java.lang.Long,V>

Specified by:

values in interface Long2ObjectMap<V>

Overrides:

values in class Long2ObjectOpenHashMap<V>

forEach

public void forEach(LongObjectConsumer<V> action)

Description copied from interface: Long2ObjectMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Long2ObjectMap<V>

Overrides:

forEach in class Long2ObjectOpenHashMap<V>

Parameters:

action - processor of the values that are iterator over

clear

public void clear()

Specified by:

clear in interface java.util.Map<java.lang.Long,V>

Overrides:

clear in class Long2ObjectOpenHashMap<V>

clearAndTrim

public void clearAndTrim(int size)

Description copied from interface: ITrimmable

Trims the collection down to the requested size and clears all elements while doing so

Specified by:

clearAndTrim in interface ITrimmable

Overrides:

clearAndTrim in class Long2ObjectOpenHashMap<V>

Parameters:

size - the amount of elements that should be allowed