speiger.src.collections.shorts.maps.impl.customHash

Class Short2ByteLinkedOpenCustomHashMap

java.lang.Object

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

speiger.src.collections.shorts.maps.abstracts.AbstractShort2ByteMap

speiger.src.collections.shorts.maps.impl.customHash.Short2ByteOpenCustomHashMap

speiger.src.collections.shorts.maps.impl.customHash.Short2ByteLinkedOpenCustomHashMap

All Implemented Interfaces:

java.util.Map<java.lang.Short,java.lang.Byte>, Short2ByteFunction, Short2ByteMap, Short2ByteOrderedMap, ITrimmable

public class Short2ByteLinkedOpenCustomHashMap
extends Short2ByteOpenCustomHashMap
implements Short2ByteOrderedMap

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.shorts.maps.abstracts.AbstractShort2ByteMap

AbstractShort2ByteMap.BasicEntry

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.shorts.maps.interfaces.Short2ByteOrderedMap

Short2ByteOrderedMap.FastOrderedSet

Nested classes/interfaces inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2ByteMap

Short2ByteMap.BuilderCache, Short2ByteMap.Entry, Short2ByteMap.FastEntrySet, Short2ByteMap.MapBuilder

Constructor Summary

Constructors

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

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
Short2ByteLinkedOpenCustomHashMap	copy() A Function that does a shallow clone of the Map itself.
byte	firstByteValue() A method to get the first Value of a Map.
short	firstShortKey() A method to get the first Key of a Map.
void	forEach(ShortByteConsumer action) Type Specific forEach method to reduce boxing/unboxing
byte	getAndMoveToFirst(short key) A Specific get method that allows to move teh given key/value int the first index.
byte	getAndMoveToLast(short key) A Specific get method that allows to move teh given key/value int the last index.
ShortOrderedSet	keySet()
byte	lastByteValue() A method to get the last Value of a Map.
short	lastShortKey() A method to get the last Key of a Map.
boolean	moveToFirst(short key) A specific move method to move a given key/value to the first index.
boolean	moveToLast(short key) A specific move method to move a given key/value to the last index.
short	pollFirstShortKey() A method to get and remove the first Key of a Map.
short	pollLastShortKey() A method to get and remove the last Key of a Map.
byte	putAndMoveToFirst(short key, byte value) A customized put method that allows you to insert into the first index.
byte	putAndMoveToLast(short key, byte value) A customized put method that allows you to insert into the last index.
ObjectOrderedSet<Short2ByteMap.Entry>	short2ByteEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
ByteCollection	values()

Methods inherited from class speiger.src.collections.shorts.maps.impl.customHash.Short2ByteOpenCustomHashMap

addTo, computeByte, computeByteIfAbsent, computeByteIfPresent, containsKey, containsKey, containsValue, containsValue, get, get, getOrDefault, mergeAllByte, mergeByte, put, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, size, subFrom, supplyByteIfAbsent, trim

Methods inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2ByteMap

addToAll, entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, replaceBytes, replaceBytes, 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.shorts.maps.interfaces.Short2ByteOrderedMap

synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2ByteMap

addTo, addToAll, builder, compute, computeByte, computeByteIfAbsent, computeByteIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllByte, mergeByte, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceBytes, replaceBytes, setDefaultReturnValue, subFrom, supplyByteIfAbsent

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

Short2ByteLinkedOpenCustomHashMap

public Short2ByteLinkedOpenCustomHashMap(ShortStrategy strategy)

Default Constructor

Parameters:

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

Short2ByteLinkedOpenCustomHashMap

public Short2ByteLinkedOpenCustomHashMap(int minCapacity,
                                         ShortStrategy 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

Short2ByteLinkedOpenCustomHashMap

public Short2ByteLinkedOpenCustomHashMap(int minCapacity,
                                         float loadFactor,
                                         ShortStrategy 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

Short2ByteLinkedOpenCustomHashMap

public Short2ByteLinkedOpenCustomHashMap(java.lang.Short[] keys,
                                         java.lang.Byte[] values,
                                         ShortStrategy 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

Short2ByteLinkedOpenCustomHashMap

public Short2ByteLinkedOpenCustomHashMap(java.lang.Short[] keys,
                                         java.lang.Byte[] values,
                                         float loadFactor,
                                         ShortStrategy 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

Short2ByteLinkedOpenCustomHashMap

public Short2ByteLinkedOpenCustomHashMap(short[] keys,
                                         byte[] values,
                                         ShortStrategy 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

Short2ByteLinkedOpenCustomHashMap

public Short2ByteLinkedOpenCustomHashMap(short[] keys,
                                         byte[] values,
                                         float loadFactor,
                                         ShortStrategy 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

Short2ByteLinkedOpenCustomHashMap

public Short2ByteLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Byte> map,
                                         ShortStrategy 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

Short2ByteLinkedOpenCustomHashMap

public Short2ByteLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Byte> map,
                                         float loadFactor,
                                         ShortStrategy 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

Short2ByteLinkedOpenCustomHashMap

public Short2ByteLinkedOpenCustomHashMap(Short2ByteMap map,
                                         ShortStrategy 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

Short2ByteLinkedOpenCustomHashMap

public Short2ByteLinkedOpenCustomHashMap(Short2ByteMap map,
                                         float loadFactor,
                                         ShortStrategy 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 byte putAndMoveToFirst(short key,
                              byte value)

Description copied from interface: Short2ByteOrderedMap

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

Specified by:

putAndMoveToFirst in interface Short2ByteOrderedMap

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 byte putAndMoveToLast(short key,
                             byte value)

Description copied from interface: Short2ByteOrderedMap

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 Short2ByteOrderedMap

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(short key)

Description copied from interface: Short2ByteOrderedMap

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

Specified by:

moveToFirst in interface Short2ByteOrderedMap

Parameters:

key - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(short key)

Description copied from interface: Short2ByteOrderedMap

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

Specified by:

moveToLast in interface Short2ByteOrderedMap

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public byte getAndMoveToFirst(short key)

Description copied from interface: Short2ByteOrderedMap

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

Specified by:

getAndMoveToFirst in interface Short2ByteOrderedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public byte getAndMoveToLast(short key)

Description copied from interface: Short2ByteOrderedMap

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

Specified by:

getAndMoveToLast in interface Short2ByteOrderedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

copy

public Short2ByteLinkedOpenCustomHashMap copy()

Description copied from interface: Short2ByteMap

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 Short2ByteMap

Specified by:

copy in interface Short2ByteOrderedMap

Overrides:

copy in class Short2ByteOpenCustomHashMap

Returns:

a Shallow Copy of the Map

firstShortKey

public short firstShortKey()

Description copied from interface: Short2ByteOrderedMap

A method to get the first Key of a Map.

Specified by:

firstShortKey in interface Short2ByteOrderedMap

Returns:

the first key in the map

pollFirstShortKey

public short pollFirstShortKey()

Description copied from interface: Short2ByteOrderedMap

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

Specified by:

pollFirstShortKey in interface Short2ByteOrderedMap

Returns:

the first key in the map

lastShortKey

public short lastShortKey()

Description copied from interface: Short2ByteOrderedMap

A method to get the last Key of a Map.

Specified by:

lastShortKey in interface Short2ByteOrderedMap

Returns:

the last key in the map

pollLastShortKey

public short pollLastShortKey()

Description copied from interface: Short2ByteOrderedMap

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

Specified by:

pollLastShortKey in interface Short2ByteOrderedMap

Returns:

the last key in the map

firstByteValue

public byte firstByteValue()

Description copied from interface: Short2ByteOrderedMap

A method to get the first Value of a Map.

Specified by:

firstByteValue in interface Short2ByteOrderedMap

Returns:

the first key in the map

lastByteValue

public byte lastByteValue()

Description copied from interface: Short2ByteOrderedMap

A method to get the last Value of a Map.

Specified by:

lastByteValue in interface Short2ByteOrderedMap

Returns:

the last key in the map

short2ByteEntrySet

public ObjectOrderedSet<Short2ByteMap.Entry> short2ByteEntrySet()

Description copied from interface: Short2ByteMap

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

Specified by:

short2ByteEntrySet in interface Short2ByteMap

Specified by:

short2ByteEntrySet in interface Short2ByteOrderedMap

Overrides:

short2ByteEntrySet in class Short2ByteOpenCustomHashMap

Returns:

a EntrySet of the collection

keySet

public ShortOrderedSet keySet()

Specified by:

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

Specified by:

keySet in interface Short2ByteMap

Specified by:

keySet in interface Short2ByteOrderedMap

Overrides:

keySet in class Short2ByteOpenCustomHashMap

values

public ByteCollection values()

Specified by:

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

Specified by:

values in interface Short2ByteMap

Overrides:

values in class Short2ByteOpenCustomHashMap

forEach

public void forEach(ShortByteConsumer action)

Description copied from interface: Short2ByteMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Short2ByteMap

Overrides:

forEach in class Short2ByteOpenCustomHashMap

Parameters:

action - processor of the values that are iterator over

clear

public void clear()

Specified by:

clear in interface java.util.Map<java.lang.Short,java.lang.Byte>

Overrides:

clear in class Short2ByteOpenCustomHashMap

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 Short2ByteOpenCustomHashMap

Parameters:

size - the amount of elements that should be allowed