speiger.src.collections.bytes.maps.impl.hash

Class Byte2CharLinkedOpenHashMap

java.lang.Object

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

speiger.src.collections.bytes.maps.abstracts.AbstractByte2CharMap

speiger.src.collections.bytes.maps.impl.hash.Byte2CharOpenHashMap

speiger.src.collections.bytes.maps.impl.hash.Byte2CharLinkedOpenHashMap

All Implemented Interfaces:

java.util.Map<java.lang.Byte,java.lang.Character>, Byte2CharFunction, Byte2CharMap, Byte2CharOrderedMap, ITrimmable

public class Byte2CharLinkedOpenHashMap
extends Byte2CharOpenHashMap
implements Byte2CharOrderedMap

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.bytes.maps.abstracts.AbstractByte2CharMap

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

Byte2CharOrderedMap.FastOrderedSet

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

Byte2CharMap.BuilderCache, Byte2CharMap.Entry, Byte2CharMap.FastEntrySet, Byte2CharMap.MapBuilder

Constructor Summary

Constructors

Constructor and Description
Byte2CharLinkedOpenHashMap() Default Constructor
Byte2CharLinkedOpenHashMap(byte[] keys, char[] values) Helper constructor that allow to create a map from unboxed values
Byte2CharLinkedOpenHashMap(byte[] keys, char[] values, float loadFactor) Helper constructor that allow to create a map from unboxed values
Byte2CharLinkedOpenHashMap(java.lang.Byte[] keys, java.lang.Character[] values) Helper constructor that allow to create a map from boxed values (it will unbox them)
Byte2CharLinkedOpenHashMap(java.lang.Byte[] keys, java.lang.Character[] values, float loadFactor) Helper constructor that allow to create a map from boxed values (it will unbox them)
Byte2CharLinkedOpenHashMap(Byte2CharMap map) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Byte2CharLinkedOpenHashMap(Byte2CharMap map, float loadFactor) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Byte2CharLinkedOpenHashMap(int minCapacity) Constructor that defines the minimum capacity
Byte2CharLinkedOpenHashMap(int minCapacity, float loadFactor) Constructor that defines the minimum capacity and load factor
Byte2CharLinkedOpenHashMap(java.util.Map<? extends java.lang.Byte,? extends java.lang.Character> map) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Byte2CharLinkedOpenHashMap(java.util.Map<? extends java.lang.Byte,? extends java.lang.Character> 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
ObjectOrderedSet<Byte2CharMap.Entry>	byte2CharEntrySet() 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
boolean	containsValue(char value) Type Specific method to reduce boxing/unboxing of values
boolean	containsValue(java.lang.Object value) Deprecated.
Byte2CharLinkedOpenHashMap	copy() A Function that does a shallow clone of the Map itself.
byte	firstByteKey() A method to get the first Key of a Map.
char	firstCharValue() A method to get the first Value of a Map.
void	forEach(ByteCharConsumer action) Type Specific forEach method to reduce boxing/unboxing
char	getAndMoveToFirst(byte key) A Specific get method that allows to move teh given key/value int the first index.
char	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.
char	lastCharValue() 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.
char	putAndMoveToFirst(byte key, char value) A customized put method that allows you to insert into the first index.
char	putAndMoveToLast(byte key, char value) A customized put method that allows you to insert into the last index.
CharCollection	values()

Methods inherited from class speiger.src.collections.bytes.maps.impl.hash.Byte2CharOpenHashMap

addTo, computeChar, computeCharIfAbsent, computeCharIfPresent, containsKey, containsKey, get, get, getOrDefault, mergeAllChar, mergeChar, put, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, size, subFrom, supplyCharIfAbsent, trim

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

addToAll, entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, replaceChars, replaceChars, 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.Byte2CharOrderedMap

synchronize, synchronize, unmodifiable

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

addTo, addToAll, builder, compute, computeChar, computeCharIfAbsent, computeCharIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, entrySet, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllChar, mergeChar, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceChars, replaceChars, setDefaultReturnValue, subFrom, supplyCharIfAbsent

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

Byte2CharLinkedOpenHashMap

public Byte2CharLinkedOpenHashMap()

Default Constructor

Byte2CharLinkedOpenHashMap

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

Byte2CharLinkedOpenHashMap

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

Byte2CharLinkedOpenHashMap

public Byte2CharLinkedOpenHashMap(java.lang.Byte[] keys,
                                  java.lang.Character[] 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

Byte2CharLinkedOpenHashMap

public Byte2CharLinkedOpenHashMap(java.lang.Byte[] keys,
                                  java.lang.Character[] 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

Byte2CharLinkedOpenHashMap

public Byte2CharLinkedOpenHashMap(byte[] keys,
                                  char[] 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

Byte2CharLinkedOpenHashMap

public Byte2CharLinkedOpenHashMap(byte[] keys,
                                  char[] 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

Byte2CharLinkedOpenHashMap

public Byte2CharLinkedOpenHashMap(java.util.Map<? extends java.lang.Byte,? extends java.lang.Character> 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

Byte2CharLinkedOpenHashMap

public Byte2CharLinkedOpenHashMap(java.util.Map<? extends java.lang.Byte,? extends java.lang.Character> 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

Byte2CharLinkedOpenHashMap

public Byte2CharLinkedOpenHashMap(Byte2CharMap 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

Byte2CharLinkedOpenHashMap

public Byte2CharLinkedOpenHashMap(Byte2CharMap 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 char putAndMoveToFirst(byte key,
                              char value)

Description copied from interface: Byte2CharOrderedMap

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

Specified by:

putAndMoveToFirst in interface Byte2CharOrderedMap

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

Description copied from interface: Byte2CharOrderedMap

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 Byte2CharOrderedMap

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

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

Specified by:

moveToFirst in interface Byte2CharOrderedMap

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

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

Specified by:

moveToLast in interface Byte2CharOrderedMap

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public char getAndMoveToFirst(byte key)

Description copied from interface: Byte2CharOrderedMap

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

Specified by:

getAndMoveToFirst in interface Byte2CharOrderedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public char getAndMoveToLast(byte key)

Description copied from interface: Byte2CharOrderedMap

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

Specified by:

getAndMoveToLast in interface Byte2CharOrderedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

containsValue

public boolean containsValue(char value)

Description copied from interface: Byte2CharMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsValue in interface Byte2CharMap

Overrides:

containsValue in class Byte2CharOpenHashMap

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.Byte,java.lang.Character>

Specified by:

containsValue in interface Byte2CharMap

Overrides:

containsValue in class Byte2CharOpenHashMap

Parameters:

value - that is searched for.

Returns:

true if found

See Also:

Map.containsValue(Object)

copy

public Byte2CharLinkedOpenHashMap copy()

Description copied from interface: Byte2CharMap

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 Byte2CharMap

Specified by:

copy in interface Byte2CharOrderedMap

Overrides:

copy in class Byte2CharOpenHashMap

Returns:

a Shallow Copy of the Map

firstByteKey

public byte firstByteKey()

Description copied from interface: Byte2CharOrderedMap

A method to get the first Key of a Map.

Specified by:

firstByteKey in interface Byte2CharOrderedMap

Returns:

the first key in the map

pollFirstByteKey

public byte pollFirstByteKey()

Description copied from interface: Byte2CharOrderedMap

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

Specified by:

pollFirstByteKey in interface Byte2CharOrderedMap

Returns:

the first key in the map

lastByteKey

public byte lastByteKey()

Description copied from interface: Byte2CharOrderedMap

A method to get the last Key of a Map.

Specified by:

lastByteKey in interface Byte2CharOrderedMap

Returns:

the last key in the map

pollLastByteKey

public byte pollLastByteKey()

Description copied from interface: Byte2CharOrderedMap

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

Specified by:

pollLastByteKey in interface Byte2CharOrderedMap

Returns:

the last key in the map

firstCharValue

public char firstCharValue()

Description copied from interface: Byte2CharOrderedMap

A method to get the first Value of a Map.

Specified by:

firstCharValue in interface Byte2CharOrderedMap

Returns:

the first key in the map

lastCharValue

public char lastCharValue()

Description copied from interface: Byte2CharOrderedMap

A method to get the last Value of a Map.

Specified by:

lastCharValue in interface Byte2CharOrderedMap

Returns:

the last key in the map

byte2CharEntrySet

public ObjectOrderedSet<Byte2CharMap.Entry> byte2CharEntrySet()

Description copied from interface: Byte2CharMap

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

Specified by:

byte2CharEntrySet in interface Byte2CharMap

Specified by:

byte2CharEntrySet in interface Byte2CharOrderedMap

Overrides:

byte2CharEntrySet in class Byte2CharOpenHashMap

Returns:

a EntrySet of the collection

keySet

public ByteOrderedSet keySet()

Specified by:

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

Specified by:

keySet in interface Byte2CharMap

Specified by:

keySet in interface Byte2CharOrderedMap

Overrides:

keySet in class Byte2CharOpenHashMap

values

public CharCollection values()

Specified by:

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

Specified by:

values in interface Byte2CharMap

Overrides:

values in class Byte2CharOpenHashMap

forEach

public void forEach(ByteCharConsumer action)

Description copied from interface: Byte2CharMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Byte2CharMap

Overrides:

forEach in class Byte2CharOpenHashMap

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,java.lang.Character>

Overrides:

clear in class Byte2CharOpenHashMap

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 Byte2CharOpenHashMap

Parameters:

size - the amount of elements that should be allowed