speiger.src.collections.bytes.maps.impl.customHash

Class Byte2ObjectLinkedOpenCustomHashMap<V>

java.lang.Object

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

speiger.src.collections.bytes.maps.abstracts.AbstractByte2ObjectMap<V>

speiger.src.collections.bytes.maps.impl.customHash.Byte2ObjectOpenCustomHashMap<V>

speiger.src.collections.bytes.maps.impl.customHash.Byte2ObjectLinkedOpenCustomHashMap<V>

Type Parameters:

V - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.Map<java.lang.Byte,V>, Byte2ObjectFunction<V>, Byte2ObjectMap<V>, Byte2ObjectOrderedMap<V>, ITrimmable

public class Byte2ObjectLinkedOpenCustomHashMap<V>
extends Byte2ObjectOpenCustomHashMap<V>
implements Byte2ObjectOrderedMap<V>

A Type Specific LinkedHashMap that allows for custom HashControl. That uses arrays to create links between nodes. For cases where Objects/primitive do not allow hashcoding this can be really useful and provide a lot of control. 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.bytes.maps.abstracts.AbstractByte2ObjectMap

AbstractByte2ObjectMap.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.bytes.maps.interfaces.Byte2ObjectOrderedMap

Byte2ObjectOrderedMap.FastOrderedSet<V>

Nested classes/interfaces inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2ObjectMap

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

Constructor Summary

Constructors

Constructor and Description
Byte2ObjectLinkedOpenCustomHashMap(byte[] keys, V[] values, ByteStrategy strategy) Helper constructor that allow to create a map from unboxed values
Byte2ObjectLinkedOpenCustomHashMap(java.lang.Byte[] keys, V[] values, ByteStrategy strategy) Helper constructor that allow to create a map from boxed values (it will unbox them)
Byte2ObjectLinkedOpenCustomHashMap(byte[] keys, V[] values, float loadFactor, ByteStrategy strategy) Helper constructor that allow to create a map from unboxed values
Byte2ObjectLinkedOpenCustomHashMap(java.lang.Byte[] keys, V[] values, float loadFactor, ByteStrategy strategy) Helper constructor that allow to create a map from boxed values (it will unbox them)
Byte2ObjectLinkedOpenCustomHashMap(Byte2ObjectMap<V> map, ByteStrategy strategy) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Byte2ObjectLinkedOpenCustomHashMap(Byte2ObjectMap<V> map, float loadFactor, ByteStrategy strategy) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Byte2ObjectLinkedOpenCustomHashMap(ByteStrategy strategy) Default Constructor
Byte2ObjectLinkedOpenCustomHashMap(int minCapacity, ByteStrategy strategy) Constructor that defines the minimum capacity
Byte2ObjectLinkedOpenCustomHashMap(int minCapacity, float loadFactor, ByteStrategy strategy) Constructor that defines the minimum capacity and load factor
Byte2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Byte,? extends V> map, ByteStrategy strategy) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Byte2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Byte,? extends V> map, float loadFactor, ByteStrategy strategy) 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
ObjectOrderedSet<Byte2ObjectMap.Entry<V>>	byte2ObjectEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
void	clear()
void	clearAndTrim(int size) Trims the collection down to the requested size and clears all elements while doing so
Byte2ObjectLinkedOpenCustomHashMap<V>	copy() A Function that does a shallow clone of the Map itself.
byte	firstByteKey() A method to get the first Key of a Map.
V	firstValue() A method to get the first Value of a Map.
void	forEach(ByteObjectConsumer<V> action) Type Specific forEach method to reduce boxing/unboxing
V	getAndMoveToFirst(byte key) A Specific get method that allows to move teh given key/value int the first index.
V	getAndMoveToLast(byte key) A Specific get method that allows to move teh given key/value int the last index.
ByteOrderedSet	keySet()
byte	lastByteKey() A method to get the last Key of a Map.
V	lastValue() A method to get the last Value of a Map.
boolean	moveToFirst(byte key) A specific move method to move a given key/value to the first index.
boolean	moveToLast(byte key) A specific move method to move a given key/value to the last index.
byte	pollFirstByteKey() A method to get and remove the first Key of a Map.
byte	pollLastByteKey() A method to get and remove the last Key of a Map.
V	putAndMoveToFirst(byte key, V value) A customized put method that allows you to insert into the first index.
V	putAndMoveToLast(byte 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.bytes.maps.impl.customHash.Byte2ObjectOpenCustomHashMap

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

Methods inherited from class speiger.src.collections.bytes.maps.abstracts.AbstractByte2ObjectMap

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.bytes.maps.interfaces.Byte2ObjectOrderedMap

synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.bytes.maps.interfaces.Byte2ObjectMap

builder, compute, compute, computeIfAbsent, computeIfAbsent, computeIfPresent, computeIfPresent, containsKey, containsKey, entrySet, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, merge, mergeAll, 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

containsValue, equals, hashCode, isEmpty, putAll, size

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

clearAndTrim, trim

Constructor Detail

Byte2ObjectLinkedOpenCustomHashMap

public Byte2ObjectLinkedOpenCustomHashMap(ByteStrategy strategy)

Default Constructor

Parameters:

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

Byte2ObjectLinkedOpenCustomHashMap

public Byte2ObjectLinkedOpenCustomHashMap(int minCapacity,
                                          ByteStrategy strategy)

Constructor that defines the minimum capacity

Parameters:

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

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

Byte2ObjectLinkedOpenCustomHashMap

public Byte2ObjectLinkedOpenCustomHashMap(int minCapacity,
                                          float loadFactor,
                                          ByteStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

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

Byte2ObjectLinkedOpenCustomHashMap

public Byte2ObjectLinkedOpenCustomHashMap(java.lang.Byte[] keys,
                                          V[] values,
                                          ByteStrategy strategy)

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.

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

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

Byte2ObjectLinkedOpenCustomHashMap

public Byte2ObjectLinkedOpenCustomHashMap(java.lang.Byte[] keys,
                                          V[] values,
                                          float loadFactor,
                                          ByteStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

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

Byte2ObjectLinkedOpenCustomHashMap

public Byte2ObjectLinkedOpenCustomHashMap(byte[] keys,
                                          V[] values,
                                          ByteStrategy strategy)

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.

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

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

Byte2ObjectLinkedOpenCustomHashMap

public Byte2ObjectLinkedOpenCustomHashMap(byte[] keys,
                                          V[] values,
                                          float loadFactor,
                                          ByteStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

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

Byte2ObjectLinkedOpenCustomHashMap

public Byte2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Byte,? extends V> map,
                                          ByteStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

Byte2ObjectLinkedOpenCustomHashMap

public Byte2ObjectLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Byte,? extends V> map,
                                          float loadFactor,
                                          ByteStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

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

Byte2ObjectLinkedOpenCustomHashMap

public Byte2ObjectLinkedOpenCustomHashMap(Byte2ObjectMap<V> map,
                                          ByteStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

Byte2ObjectLinkedOpenCustomHashMap

public Byte2ObjectLinkedOpenCustomHashMap(Byte2ObjectMap<V> map,
                                          float loadFactor,
                                          ByteStrategy strategy)

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

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

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

Method Detail

putAndMoveToFirst

public V putAndMoveToFirst(byte key,
                           V value)

Description copied from interface: Byte2ObjectOrderedMap

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

Specified by:

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

Description copied from interface: Byte2ObjectOrderedMap

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 Byte2ObjectOrderedMap<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(byte key)

Description copied from interface: Byte2ObjectOrderedMap

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

Specified by:

moveToFirst in interface Byte2ObjectOrderedMap<V>

Parameters:

key - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(byte key)

Description copied from interface: Byte2ObjectOrderedMap

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

Specified by:

moveToLast in interface Byte2ObjectOrderedMap<V>

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public V getAndMoveToFirst(byte key)

Description copied from interface: Byte2ObjectOrderedMap

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

Specified by:

getAndMoveToFirst in interface Byte2ObjectOrderedMap<V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public V getAndMoveToLast(byte key)

Description copied from interface: Byte2ObjectOrderedMap

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

Specified by:

getAndMoveToLast in interface Byte2ObjectOrderedMap<V>

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

copy

public Byte2ObjectLinkedOpenCustomHashMap<V> copy()

Description copied from interface: Byte2ObjectMap

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

Specified by:

copy in interface Byte2ObjectOrderedMap<V>

Overrides:

copy in class Byte2ObjectOpenCustomHashMap<V>

Returns:

a Shallow Copy of the Map

firstByteKey

public byte firstByteKey()

Description copied from interface: Byte2ObjectOrderedMap

A method to get the first Key of a Map.

Specified by:

firstByteKey in interface Byte2ObjectOrderedMap<V>

Returns:

the first key in the map

pollFirstByteKey

public byte pollFirstByteKey()

Description copied from interface: Byte2ObjectOrderedMap

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

Specified by:

pollFirstByteKey in interface Byte2ObjectOrderedMap<V>

Returns:

the first key in the map

lastByteKey

public byte lastByteKey()

Description copied from interface: Byte2ObjectOrderedMap

A method to get the last Key of a Map.

Specified by:

lastByteKey in interface Byte2ObjectOrderedMap<V>

Returns:

the last key in the map

pollLastByteKey

public byte pollLastByteKey()

Description copied from interface: Byte2ObjectOrderedMap

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

Specified by:

pollLastByteKey in interface Byte2ObjectOrderedMap<V>

Returns:

the last key in the map

firstValue

public V firstValue()

Description copied from interface: Byte2ObjectOrderedMap

A method to get the first Value of a Map.

Specified by:

firstValue in interface Byte2ObjectOrderedMap<V>

Returns:

the first key in the map

lastValue

public V lastValue()

Description copied from interface: Byte2ObjectOrderedMap

A method to get the last Value of a Map.

Specified by:

lastValue in interface Byte2ObjectOrderedMap<V>

Returns:

the last key in the map

byte2ObjectEntrySet

public ObjectOrderedSet<Byte2ObjectMap.Entry<V>> byte2ObjectEntrySet()

Description copied from interface: Byte2ObjectMap

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

Specified by:

byte2ObjectEntrySet in interface Byte2ObjectMap<V>

Specified by:

byte2ObjectEntrySet in interface Byte2ObjectOrderedMap<V>

Overrides:

byte2ObjectEntrySet in class Byte2ObjectOpenCustomHashMap<V>

Returns:

a EntrySet of the collection

keySet

public ByteOrderedSet keySet()

Specified by:

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

Specified by:

keySet in interface Byte2ObjectMap<V>

Specified by:

keySet in interface Byte2ObjectOrderedMap<V>

Overrides:

keySet in class Byte2ObjectOpenCustomHashMap<V>

values

public ObjectCollection<V> values()

Specified by:

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

Specified by:

values in interface Byte2ObjectMap<V>

Overrides:

values in class Byte2ObjectOpenCustomHashMap<V>

forEach

public void forEach(ByteObjectConsumer<V> action)

Description copied from interface: Byte2ObjectMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Byte2ObjectMap<V>

Overrides:

forEach in class Byte2ObjectOpenCustomHashMap<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.Byte,V>

Overrides:

clear in class Byte2ObjectOpenCustomHashMap<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 Byte2ObjectOpenCustomHashMap<V>

Parameters:

size - the amount of elements that should be allowed