speiger.src.collections.chars.maps.impl.customHash

Class Char2ShortLinkedOpenCustomHashMap

java.lang.Object

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

speiger.src.collections.chars.maps.abstracts.AbstractChar2ShortMap

speiger.src.collections.chars.maps.impl.customHash.Char2ShortOpenCustomHashMap

speiger.src.collections.chars.maps.impl.customHash.Char2ShortLinkedOpenCustomHashMap

All Implemented Interfaces:

java.util.Map<java.lang.Character,java.lang.Short>, Char2ShortFunction, Char2ShortMap, Char2ShortOrderedMap, ITrimmable

public class Char2ShortLinkedOpenCustomHashMap
extends Char2ShortOpenCustomHashMap
implements Char2ShortOrderedMap

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.chars.maps.abstracts.AbstractChar2ShortMap

AbstractChar2ShortMap.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.chars.maps.interfaces.Char2ShortOrderedMap

Char2ShortOrderedMap.FastOrderedSet

Nested classes/interfaces inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ShortMap

Char2ShortMap.BuilderCache, Char2ShortMap.Entry, Char2ShortMap.FastEntrySet, Char2ShortMap.MapBuilder

Constructor Summary

Constructors

Constructor and Description
Char2ShortLinkedOpenCustomHashMap(char[] keys, short[] values, CharStrategy strategy) Helper constructor that allow to create a map from unboxed values
Char2ShortLinkedOpenCustomHashMap(char[] keys, short[] values, float loadFactor, CharStrategy strategy) Helper constructor that allow to create a map from unboxed values
Char2ShortLinkedOpenCustomHashMap(Char2ShortMap map, CharStrategy strategy) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Char2ShortLinkedOpenCustomHashMap(Char2ShortMap map, float loadFactor, CharStrategy strategy) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Char2ShortLinkedOpenCustomHashMap(java.lang.Character[] keys, java.lang.Short[] values, CharStrategy strategy) Helper constructor that allow to create a map from boxed values (it will unbox them)
Char2ShortLinkedOpenCustomHashMap(java.lang.Character[] keys, java.lang.Short[] values, float loadFactor, CharStrategy strategy) Helper constructor that allow to create a map from boxed values (it will unbox them)
Char2ShortLinkedOpenCustomHashMap(CharStrategy strategy) Default Constructor
Char2ShortLinkedOpenCustomHashMap(int minCapacity, CharStrategy strategy) Constructor that defines the minimum capacity
Char2ShortLinkedOpenCustomHashMap(int minCapacity, float loadFactor, CharStrategy strategy) Constructor that defines the minimum capacity and load factor
Char2ShortLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Character,? extends java.lang.Short> map, CharStrategy strategy) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Char2ShortLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Character,? extends java.lang.Short> map, float loadFactor, CharStrategy 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<Char2ShortMap.Entry>	char2ShortEntrySet() 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
Char2ShortLinkedOpenCustomHashMap	copy() A Function that does a shallow clone of the Map itself.
char	firstCharKey() A method to get the first Key of a Map.
short	firstShortValue() A method to get the first Value of a Map.
void	forEach(CharShortConsumer action) Type Specific forEach method to reduce boxing/unboxing
short	getAndMoveToFirst(char key) A Specific get method that allows to move teh given key/value int the first index.
short	getAndMoveToLast(char key) A Specific get method that allows to move teh given key/value int the last index.
CharOrderedSet	keySet()
char	lastCharKey() A method to get the last Key of a Map.
short	lastShortValue() A method to get the last Value of a Map.
boolean	moveToFirst(char key) A specific move method to move a given key/value to the first index.
boolean	moveToLast(char key) A specific move method to move a given key/value to the last index.
char	pollFirstCharKey() A method to get and remove the first Key of a Map.
char	pollLastCharKey() A method to get and remove the last Key of a Map.
short	putAndMoveToFirst(char key, short value) A customized put method that allows you to insert into the first index.
short	putAndMoveToLast(char key, short value) A customized put method that allows you to insert into the last index.
ShortCollection	values()

Methods inherited from class speiger.src.collections.chars.maps.impl.customHash.Char2ShortOpenCustomHashMap

addTo, computeShort, computeShortIfAbsent, computeShortIfPresent, containsKey, containsKey, containsValue, containsValue, get, get, getOrDefault, mergeAllShort, mergeShort, put, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, size, subFrom, supplyShortIfAbsent, trim

Methods inherited from class speiger.src.collections.chars.maps.abstracts.AbstractChar2ShortMap

addToAll, entrySet, equals, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, replaceShorts, replaceShorts, 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.chars.maps.interfaces.Char2ShortOrderedMap

synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.chars.maps.interfaces.Char2ShortMap

addTo, addToAll, builder, compute, computeIfAbsent, computeIfPresent, computeShort, computeShortIfAbsent, computeShortIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, get, get, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllShort, mergeShort, put, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remove, remove, remove, remove, removeOrDefault, replace, replace, replace, replace, replaceAll, replaceShorts, replaceShorts, setDefaultReturnValue, subFrom, supplyShortIfAbsent

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

Char2ShortLinkedOpenCustomHashMap

public Char2ShortLinkedOpenCustomHashMap(CharStrategy strategy)

Default Constructor

Parameters:

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

Char2ShortLinkedOpenCustomHashMap

public Char2ShortLinkedOpenCustomHashMap(int minCapacity,
                                         CharStrategy 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

Char2ShortLinkedOpenCustomHashMap

public Char2ShortLinkedOpenCustomHashMap(int minCapacity,
                                         float loadFactor,
                                         CharStrategy 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

Char2ShortLinkedOpenCustomHashMap

public Char2ShortLinkedOpenCustomHashMap(java.lang.Character[] keys,
                                         java.lang.Short[] values,
                                         CharStrategy 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

Char2ShortLinkedOpenCustomHashMap

public Char2ShortLinkedOpenCustomHashMap(java.lang.Character[] keys,
                                         java.lang.Short[] values,
                                         float loadFactor,
                                         CharStrategy 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

Char2ShortLinkedOpenCustomHashMap

public Char2ShortLinkedOpenCustomHashMap(char[] keys,
                                         short[] values,
                                         CharStrategy 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

Char2ShortLinkedOpenCustomHashMap

public Char2ShortLinkedOpenCustomHashMap(char[] keys,
                                         short[] values,
                                         float loadFactor,
                                         CharStrategy 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

Char2ShortLinkedOpenCustomHashMap

public Char2ShortLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Character,? extends java.lang.Short> map,
                                         CharStrategy 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

Char2ShortLinkedOpenCustomHashMap

public Char2ShortLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Character,? extends java.lang.Short> map,
                                         float loadFactor,
                                         CharStrategy 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

Char2ShortLinkedOpenCustomHashMap

public Char2ShortLinkedOpenCustomHashMap(Char2ShortMap map,
                                         CharStrategy 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

Char2ShortLinkedOpenCustomHashMap

public Char2ShortLinkedOpenCustomHashMap(Char2ShortMap map,
                                         float loadFactor,
                                         CharStrategy 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 short putAndMoveToFirst(char key,
                               short value)

Description copied from interface: Char2ShortOrderedMap

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

Specified by:

putAndMoveToFirst in interface Char2ShortOrderedMap

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

Description copied from interface: Char2ShortOrderedMap

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 Char2ShortOrderedMap

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

Description copied from interface: Char2ShortOrderedMap

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

Specified by:

moveToFirst in interface Char2ShortOrderedMap

Parameters:

key - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(char key)

Description copied from interface: Char2ShortOrderedMap

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

Specified by:

moveToLast in interface Char2ShortOrderedMap

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public short getAndMoveToFirst(char key)

Description copied from interface: Char2ShortOrderedMap

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

Specified by:

getAndMoveToFirst in interface Char2ShortOrderedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public short getAndMoveToLast(char key)

Description copied from interface: Char2ShortOrderedMap

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

Specified by:

getAndMoveToLast in interface Char2ShortOrderedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

copy

public Char2ShortLinkedOpenCustomHashMap copy()

Description copied from interface: Char2ShortMap

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 Char2ShortMap

Specified by:

copy in interface Char2ShortOrderedMap

Overrides:

copy in class Char2ShortOpenCustomHashMap

Returns:

a Shallow Copy of the Map

firstCharKey

public char firstCharKey()

Description copied from interface: Char2ShortOrderedMap

A method to get the first Key of a Map.

Specified by:

firstCharKey in interface Char2ShortOrderedMap

Returns:

the first key in the map

pollFirstCharKey

public char pollFirstCharKey()

Description copied from interface: Char2ShortOrderedMap

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

Specified by:

pollFirstCharKey in interface Char2ShortOrderedMap

Returns:

the first key in the map

lastCharKey

public char lastCharKey()

Description copied from interface: Char2ShortOrderedMap

A method to get the last Key of a Map.

Specified by:

lastCharKey in interface Char2ShortOrderedMap

Returns:

the last key in the map

pollLastCharKey

public char pollLastCharKey()

Description copied from interface: Char2ShortOrderedMap

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

Specified by:

pollLastCharKey in interface Char2ShortOrderedMap

Returns:

the last key in the map

firstShortValue

public short firstShortValue()

Description copied from interface: Char2ShortOrderedMap

A method to get the first Value of a Map.

Specified by:

firstShortValue in interface Char2ShortOrderedMap

Returns:

the first key in the map

lastShortValue

public short lastShortValue()

Description copied from interface: Char2ShortOrderedMap

A method to get the last Value of a Map.

Specified by:

lastShortValue in interface Char2ShortOrderedMap

Returns:

the last key in the map

char2ShortEntrySet

public ObjectOrderedSet<Char2ShortMap.Entry> char2ShortEntrySet()

Description copied from interface: Char2ShortMap

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

Specified by:

char2ShortEntrySet in interface Char2ShortMap

Specified by:

char2ShortEntrySet in interface Char2ShortOrderedMap

Overrides:

char2ShortEntrySet in class Char2ShortOpenCustomHashMap

Returns:

a EntrySet of the collection

keySet

public CharOrderedSet keySet()

Specified by:

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

Specified by:

keySet in interface Char2ShortMap

Specified by:

keySet in interface Char2ShortOrderedMap

Overrides:

keySet in class Char2ShortOpenCustomHashMap

values

public ShortCollection values()

Specified by:

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

Specified by:

values in interface Char2ShortMap

Overrides:

values in class Char2ShortOpenCustomHashMap

forEach

public void forEach(CharShortConsumer action)

Description copied from interface: Char2ShortMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Char2ShortMap

Overrides:

forEach in class Char2ShortOpenCustomHashMap

Parameters:

action - processor of the values that are iterator over

clear

public void clear()

Specified by:

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

Overrides:

clear in class Char2ShortOpenCustomHashMap

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 Char2ShortOpenCustomHashMap

Parameters:

size - the amount of elements that should be allowed