speiger.src.collections.longs.maps.impl.customHash

Class Long2ByteOpenCustomHashMap

java.lang.Object

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

speiger.src.collections.longs.maps.abstracts.AbstractLong2ByteMap

speiger.src.collections.longs.maps.impl.customHash.Long2ByteOpenCustomHashMap

All Implemented Interfaces:

java.util.Map<java.lang.Long,java.lang.Byte>, Long2ByteFunction, Long2ByteMap

Direct Known Subclasses:

Long2ByteLinkedOpenCustomHashMap

public class Long2ByteOpenCustomHashMap
extends AbstractLong2ByteMap

A Type Specific HashMap that allows for custom HashControl. For cases where Objects/primitive do not allow hashcoding this can be really useful and provide a lot of control.

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.longs.maps.abstracts.AbstractLong2ByteMap

AbstractLong2ByteMap.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.longs.maps.interfaces.Long2ByteMap

Long2ByteMap.Entry, Long2ByteMap.FastEntrySet

Constructor Summary

Constructors

Constructor and Description
Long2ByteOpenCustomHashMap(int minCapacity, float loadFactor, LongStrategy strategy) Constructor that defines the minimum capacity and load factor
Long2ByteOpenCustomHashMap(int minCapacity, LongStrategy strategy) Constructor that defines the minimum capacity
Long2ByteOpenCustomHashMap(long[] keys, byte[] values, float loadFactor, LongStrategy strategy) Helper constructor that allow to create a map from unboxed values
Long2ByteOpenCustomHashMap(java.lang.Long[] keys, java.lang.Byte[] values, float loadFactor, LongStrategy strategy) Helper constructor that allow to create a map from boxed values (it will unbox them)
Long2ByteOpenCustomHashMap(long[] keys, byte[] values, LongStrategy strategy) Helper constructor that allow to create a map from unboxed values
Long2ByteOpenCustomHashMap(java.lang.Long[] keys, java.lang.Byte[] values, LongStrategy strategy) Helper constructor that allow to create a map from boxed values (it will unbox them)
Long2ByteOpenCustomHashMap(Long2ByteMap map, float loadFactor, LongStrategy strategy) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Long2ByteOpenCustomHashMap(Long2ByteMap map, LongStrategy strategy) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Long2ByteOpenCustomHashMap(LongStrategy strategy) Default Contstructor
Long2ByteOpenCustomHashMap(java.util.Map<? extends java.lang.Long,? extends java.lang.Byte> map, float loadFactor, LongStrategy strategy) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Long2ByteOpenCustomHashMap(java.util.Map<? extends java.lang.Long,? extends java.lang.Byte> map, LongStrategy 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
byte	addTo(long key, byte value) A Helper method to add a primitives together.
void	clear()
byte	computeByte(long key, LongByteUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
byte	computeByteIfAbsent(long key, Long2ByteFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
byte	computeByteIfPresent(long key, LongByteUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	containsKey(long key) Type Specific method to reduce boxing/unboxing of values
boolean	containsKey(java.lang.Object key) Deprecated.
boolean	containsValue(byte value) Type Specific method to reduce boxing/unboxing of values
boolean	containsValue(java.lang.Object value) Deprecated.
void	forEach(LongByteConsumer action) Type Specific forEach method to reduce boxing/unboxing
java.lang.Byte	get(java.lang.Object key)
byte	getByte(long key) A Type Specific get method to reduce boxing/unboxing
byte	getOrDefault(long key, byte defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
LongSet	keySet()
ObjectSet<Long2ByteMap.Entry>	long2ByteEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
void	mergeAllByte(Long2ByteMap m, ByteByteUnaryOperator mappingFunction) A Bulk method for merging Maps.
byte	mergeByte(long key, byte value, ByteByteUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
byte	put(long key, byte value) Type Specific method to reduce boxing/unboxing of values
byte	putIfAbsent(long key, byte value) Type Specific method to reduce boxing/unboxing of values
byte	remLong(long key) Type Specific remove function to reduce boxing/unboxing
byte	remLongOrDefault(long key, byte defaultValue) Type-Specific Remove function with a default return value if wanted.
boolean	remove(long key, byte value) Type Specific remove function to reduce boxing/unboxing
java.lang.Byte	remove(java.lang.Object key) Deprecated.
boolean	remove(java.lang.Object key, java.lang.Object value)
byte	replace(long key, byte value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(long key, byte oldValue, byte newValue) A Type Specific replace method to replace an existing value
int	size()
ByteCollection	values()

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

addToAll, entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, putAll, putAll, putAll, putAllIfAbsent, replaceBytes, replaceBytes, 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 speiger.src.collections.longs.maps.interfaces.Long2ByteMap

compute, computeIfAbsent, computeIfPresent, forEach, merge, put, putAll, putIfAbsent, replace, replace, replaceAll

Methods inherited from interface java.util.Map

isEmpty

Constructor Detail

Long2ByteOpenCustomHashMap

public Long2ByteOpenCustomHashMap(LongStrategy strategy)

Default Contstructor

Parameters:

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

Long2ByteOpenCustomHashMap

public Long2ByteOpenCustomHashMap(int minCapacity,
                                  LongStrategy 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

Long2ByteOpenCustomHashMap

public Long2ByteOpenCustomHashMap(int minCapacity,
                                  float loadFactor,
                                  LongStrategy 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

Long2ByteOpenCustomHashMap

public Long2ByteOpenCustomHashMap(java.lang.Long[] keys,
                                  java.lang.Byte[] values,
                                  LongStrategy 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

Long2ByteOpenCustomHashMap

public Long2ByteOpenCustomHashMap(java.lang.Long[] keys,
                                  java.lang.Byte[] values,
                                  float loadFactor,
                                  LongStrategy 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

Long2ByteOpenCustomHashMap

public Long2ByteOpenCustomHashMap(long[] keys,
                                  byte[] values,
                                  LongStrategy 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

Long2ByteOpenCustomHashMap

public Long2ByteOpenCustomHashMap(long[] keys,
                                  byte[] values,
                                  float loadFactor,
                                  LongStrategy 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

Long2ByteOpenCustomHashMap

public Long2ByteOpenCustomHashMap(java.util.Map<? extends java.lang.Long,? extends java.lang.Byte> map,
                                  LongStrategy 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

Long2ByteOpenCustomHashMap

public Long2ByteOpenCustomHashMap(java.util.Map<? extends java.lang.Long,? extends java.lang.Byte> map,
                                  float loadFactor,
                                  LongStrategy 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

Long2ByteOpenCustomHashMap

public Long2ByteOpenCustomHashMap(Long2ByteMap map,
                                  LongStrategy 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

Long2ByteOpenCustomHashMap

public Long2ByteOpenCustomHashMap(Long2ByteMap map,
                                  float loadFactor,
                                  LongStrategy 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

put

public byte put(long key,
                byte value)

Description copied from interface: Long2ByteMap

Type Specific method to reduce boxing/unboxing of values

Parameters:

key - the key that should be inserted,

value - the value that should be inserted

Returns:

the last present value or default return value.

See Also:

Map.put(Object, Object)

putIfAbsent

public byte putIfAbsent(long key,
                        byte value)

Description copied from interface: Long2ByteMap

Type Specific method to reduce boxing/unboxing of values

Parameters:

key - the key that should be inserted,

value - the value that should be inserted

Returns:

the last present value or default return value.

See Also:

Map.putIfAbsent(Object, Object)

addTo

public byte addTo(long key,
                  byte value)

Description copied from interface: Long2ByteMap

A Helper method to add a primitives together. If key is not present then this functions as a put.

Parameters:

key - the key that should be inserted,

value - the value that should be inserted / added

Returns:

the last present value or default return value.

containsKey

public boolean containsKey(long key)

Description copied from interface: Long2ByteMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsKey in interface Long2ByteMap

Overrides:

containsKey in class AbstractLong2ByteMap

Parameters:

key - element that is searched for

Returns:

if the key is present

containsKey

@Deprecated
public boolean containsKey(java.lang.Object key)

Deprecated.

Specified by:

containsKey in interface java.util.Map<java.lang.Long,java.lang.Byte>

Specified by:

containsKey in interface Long2ByteMap

Overrides:

containsKey in class java.util.AbstractMap<java.lang.Long,java.lang.Byte>

Parameters:

key - that is searched for.

Returns:

true if found

See Also:

Map.containsKey(Object)

containsValue

public boolean containsValue(byte value)

Description copied from interface: Long2ByteMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsValue in interface Long2ByteMap

Overrides:

containsValue in class AbstractLong2ByteMap

Parameters:

value - element that is searched for

Returns:

if the value is present

containsValue

@Deprecated
public boolean containsValue(java.lang.Object value)

Deprecated.

Specified by:

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

Specified by:

containsValue in interface Long2ByteMap

Overrides:

containsValue in class java.util.AbstractMap<java.lang.Long,java.lang.Byte>

Parameters:

value - that is searched for.

Returns:

true if found

See Also:

Map.containsValue(Object)

remLong

public byte remLong(long key)

Description copied from interface: Long2ByteMap

Type Specific remove function to reduce boxing/unboxing

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

remLongOrDefault

public byte remLongOrDefault(long key,
                             byte defaultValue)

Description copied from interface: Long2ByteMap

Type-Specific Remove function with a default return value if wanted.

Parameters:

key - the element that should be removed

defaultValue - the value that should be returned if the entry doesn't exist

Returns:

the value that was removed or default value

See Also:

Map.remove(Object, Object)

remove

@Deprecated
public java.lang.Byte remove(java.lang.Object key)

Deprecated.

Specified by:

remove in interface java.util.Map<java.lang.Long,java.lang.Byte>

Specified by:

remove in interface Long2ByteMap

Overrides:

remove in class java.util.AbstractMap<java.lang.Long,java.lang.Byte>

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

See Also:

Map.remove(Object)

remove

public boolean remove(long key,
                      byte value)

Description copied from interface: Long2ByteMap

Type Specific remove function to reduce boxing/unboxing

Parameters:

key - the element that should be removed

value - the expected value that should be found

Returns:

true if the key and value was found and removed

See Also:

Map.remove(Object, Object)

remove

public boolean remove(java.lang.Object key,
                      java.lang.Object value)

Parameters:

key - the element that should be removed

value - the expected value that should be found

Returns:

true if the key and value was found and removed

See Also:

Map.remove(Object, Object)

getByte

public byte getByte(long key)

Description copied from interface: Long2ByteMap

A Type Specific get method to reduce boxing/unboxing

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

get

public java.lang.Byte get(java.lang.Object key)

Specified by:

get in interface java.util.Map<java.lang.Long,java.lang.Byte>

Specified by:

get in interface Long2ByteMap

Overrides:

get in class AbstractLong2ByteMap

getOrDefault

public byte getOrDefault(long key,
                         byte defaultValue)

Description copied from interface: Long2ByteMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Long2ByteMap

Overrides:

getOrDefault in class AbstractLong2ByteMap

Parameters:

key - the key that is searched for

defaultValue - the value that should be returned if the key is not present

Returns:

the searched value or defaultValue value

long2ByteEntrySet

public ObjectSet<Long2ByteMap.Entry> long2ByteEntrySet()

Description copied from interface: Long2ByteMap

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

Returns:

a EntrySet of the collection

keySet

public LongSet keySet()

Specified by:

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

Specified by:

keySet in interface Long2ByteMap

Overrides:

keySet in class AbstractLong2ByteMap

values

public ByteCollection values()

Specified by:

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

Specified by:

values in interface Long2ByteMap

Overrides:

values in class AbstractLong2ByteMap

forEach

public void forEach(LongByteConsumer action)

Description copied from interface: Long2ByteMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Long2ByteMap

Overrides:

forEach in class AbstractLong2ByteMap

Parameters:

action - processor of the values that are iterator over

replace

public boolean replace(long key,
                       byte oldValue,
                       byte newValue)

Description copied from interface: Long2ByteMap

A Type Specific replace method to replace an existing value

Specified by:

replace in interface Long2ByteMap

Overrides:

replace in class AbstractLong2ByteMap

Parameters:

key - the element that should be searched for

oldValue - the expected value to be replaced

newValue - the value to replace the oldValue with.

Returns:

true if the value got replaced

replace

public byte replace(long key,
                    byte value)

Description copied from interface: Long2ByteMap

A Type Specific replace method to reduce boxing/unboxing replace an existing value

Specified by:

replace in interface Long2ByteMap

Overrides:

replace in class AbstractLong2ByteMap

Parameters:

key - the element that should be searched for

value - the value to replace with.

Returns:

the present value or default return value

computeByte

public byte computeByte(long key,
                        LongByteUnaryOperator mappingFunction)

Description copied from interface: Long2ByteMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeByte in interface Long2ByteMap

Overrides:

computeByte in class AbstractLong2ByteMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeByteIfAbsent

public byte computeByteIfAbsent(long key,
                                Long2ByteFunction mappingFunction)

Description copied from interface: Long2ByteMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeByteIfAbsent in interface Long2ByteMap

Overrides:

computeByteIfAbsent in class AbstractLong2ByteMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value if not present

Returns:

the result of the computed value or present value

computeByteIfPresent

public byte computeByteIfPresent(long key,
                                 LongByteUnaryOperator mappingFunction)

Description copied from interface: Long2ByteMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeByteIfPresent in interface Long2ByteMap

Overrides:

computeByteIfPresent in class AbstractLong2ByteMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value if present

Returns:

the result of the default return value or present value

mergeByte

public byte mergeByte(long key,
                      byte value,
                      ByteByteUnaryOperator mappingFunction)

Description copied from interface: Long2ByteMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeByte in interface Long2ByteMap

Overrides:

mergeByte in class AbstractLong2ByteMap

Parameters:

key - the key that should be be searched for

value - the value that should be merged with

mappingFunction - the operator that should generate the new Value

Returns:

the result of the merge

mergeAllByte

public void mergeAllByte(Long2ByteMap m,
                         ByteByteUnaryOperator mappingFunction)

Description copied from interface: Long2ByteMap

A Bulk method for merging Maps.

Specified by:

mergeAllByte in interface Long2ByteMap

Overrides:

mergeAllByte in class AbstractLong2ByteMap

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

size

public int size()

Specified by:

size in interface java.util.Map<java.lang.Long,java.lang.Byte>

Overrides:

size in class java.util.AbstractMap<java.lang.Long,java.lang.Byte>

clear

public void clear()

Specified by:

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

Overrides:

clear in class java.util.AbstractMap<java.lang.Long,java.lang.Byte>