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

Class Char2CharLinkedOpenCustomHashMap

java.lang.Object

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

speiger.src.collections.chars.maps.abstracts.AbstractChar2CharMap

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

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

All Implemented Interfaces:

java.util.Map<java.lang.Character,java.lang.Character>, Char2CharFunction, Char2CharMap, Char2CharOrderedMap, ITrimmable

public class Char2CharLinkedOpenCustomHashMap
extends Char2CharOpenCustomHashMap
implements Char2CharOrderedMap

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.AbstractChar2CharMap

AbstractChar2CharMap.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.Char2CharOrderedMap

Char2CharOrderedMap.FastOrderedSet

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

Char2CharMap.BuilderCache, Char2CharMap.Entry, Char2CharMap.FastEntrySet, Char2CharMap.MapBuilder

Constructor Summary

Constructors

Constructor and Description
Char2CharLinkedOpenCustomHashMap(char[] keys, char[] values, CharStrategy strategy) Helper constructor that allow to create a map from unboxed values
Char2CharLinkedOpenCustomHashMap(char[] keys, char[] values, float loadFactor, CharStrategy strategy) Helper constructor that allow to create a map from unboxed values
Char2CharLinkedOpenCustomHashMap(Char2CharMap map, CharStrategy strategy) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Char2CharLinkedOpenCustomHashMap(Char2CharMap 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.
Char2CharLinkedOpenCustomHashMap(java.lang.Character[] keys, java.lang.Character[] values, CharStrategy strategy) Helper constructor that allow to create a map from boxed values (it will unbox them)
Char2CharLinkedOpenCustomHashMap(java.lang.Character[] keys, java.lang.Character[] values, float loadFactor, CharStrategy strategy) Helper constructor that allow to create a map from boxed values (it will unbox them)
Char2CharLinkedOpenCustomHashMap(CharStrategy strategy) Default Constructor
Char2CharLinkedOpenCustomHashMap(int minCapacity, CharStrategy strategy) Constructor that defines the minimum capacity
Char2CharLinkedOpenCustomHashMap(int minCapacity, float loadFactor, CharStrategy strategy) Constructor that defines the minimum capacity and load factor
Char2CharLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Character,? extends java.lang.Character> map, CharStrategy strategy) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Char2CharLinkedOpenCustomHashMap(java.util.Map<? extends java.lang.Character,? extends java.lang.Character> 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<Char2CharMap.Entry>	char2CharEntrySet() 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
Char2CharLinkedOpenCustomHashMap	copy() A Function that does a shallow clone of the Map itself.
char	firstCharKey() A method to get the first Key of a Map.
char	firstCharValue() A method to get the first Value of a Map.
void	forEach(CharCharConsumer action) Type Specific forEach method to reduce boxing/unboxing
char	getAndMoveToFirst(char key) A Specific get method that allows to move teh given key/value int the first index.
char	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.
char	lastCharValue() 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.
char	putAndMoveToFirst(char key, char value) A customized put method that allows you to insert into the first index.
char	putAndMoveToLast(char 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.chars.maps.impl.customHash.Char2CharOpenCustomHashMap

addTo, computeChar, computeCharIfAbsent, computeCharIfPresent, containsKey, containsKey, containsValue, containsValue, 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.chars.maps.abstracts.AbstractChar2CharMap

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

synchronize, synchronize, unmodifiable

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

addTo, addToAll, builder, compute, computeChar, computeCharIfAbsent, computeCharIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, 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

Char2CharLinkedOpenCustomHashMap

public Char2CharLinkedOpenCustomHashMap(CharStrategy strategy)

Default Constructor

Parameters:

strategy - the strategy that allows hash control.

Throws:

java.lang.NullPointerException - if Strategy is null

Char2CharLinkedOpenCustomHashMap

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

Char2CharLinkedOpenCustomHashMap

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

Char2CharLinkedOpenCustomHashMap

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

Char2CharLinkedOpenCustomHashMap

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

Char2CharLinkedOpenCustomHashMap

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

Char2CharLinkedOpenCustomHashMap

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

Char2CharLinkedOpenCustomHashMap

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

Char2CharLinkedOpenCustomHashMap

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

Char2CharLinkedOpenCustomHashMap

public Char2CharLinkedOpenCustomHashMap(Char2CharMap 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

Char2CharLinkedOpenCustomHashMap

public Char2CharLinkedOpenCustomHashMap(Char2CharMap 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 char putAndMoveToFirst(char key,
                              char value)

Description copied from interface: Char2CharOrderedMap

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

Specified by:

putAndMoveToFirst in interface Char2CharOrderedMap

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

Description copied from interface: Char2CharOrderedMap

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 Char2CharOrderedMap

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

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

Specified by:

moveToFirst in interface Char2CharOrderedMap

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

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

Specified by:

moveToLast in interface Char2CharOrderedMap

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public char getAndMoveToFirst(char key)

Description copied from interface: Char2CharOrderedMap

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

Specified by:

getAndMoveToFirst in interface Char2CharOrderedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public char getAndMoveToLast(char key)

Description copied from interface: Char2CharOrderedMap

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

Specified by:

getAndMoveToLast in interface Char2CharOrderedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

copy

public Char2CharLinkedOpenCustomHashMap copy()

Description copied from interface: Char2CharMap

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 Char2CharMap

Specified by:

copy in interface Char2CharOrderedMap

Overrides:

copy in class Char2CharOpenCustomHashMap

Returns:

a Shallow Copy of the Map

firstCharKey

public char firstCharKey()

Description copied from interface: Char2CharOrderedMap

A method to get the first Key of a Map.

Specified by:

firstCharKey in interface Char2CharOrderedMap

Returns:

the first key in the map

pollFirstCharKey

public char pollFirstCharKey()

Description copied from interface: Char2CharOrderedMap

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

Specified by:

pollFirstCharKey in interface Char2CharOrderedMap

Returns:

the first key in the map

lastCharKey

public char lastCharKey()

Description copied from interface: Char2CharOrderedMap

A method to get the last Key of a Map.

Specified by:

lastCharKey in interface Char2CharOrderedMap

Returns:

the last key in the map

pollLastCharKey

public char pollLastCharKey()

Description copied from interface: Char2CharOrderedMap

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

Specified by:

pollLastCharKey in interface Char2CharOrderedMap

Returns:

the last key in the map

firstCharValue

public char firstCharValue()

Description copied from interface: Char2CharOrderedMap

A method to get the first Value of a Map.

Specified by:

firstCharValue in interface Char2CharOrderedMap

Returns:

the first key in the map

lastCharValue

public char lastCharValue()

Description copied from interface: Char2CharOrderedMap

A method to get the last Value of a Map.

Specified by:

lastCharValue in interface Char2CharOrderedMap

Returns:

the last key in the map

char2CharEntrySet

public ObjectOrderedSet<Char2CharMap.Entry> char2CharEntrySet()

Description copied from interface: Char2CharMap

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

Specified by:

char2CharEntrySet in interface Char2CharMap

Specified by:

char2CharEntrySet in interface Char2CharOrderedMap

Overrides:

char2CharEntrySet in class Char2CharOpenCustomHashMap

Returns:

a EntrySet of the collection

keySet

public CharOrderedSet keySet()

Specified by:

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

Specified by:

keySet in interface Char2CharMap

Specified by:

keySet in interface Char2CharOrderedMap

Overrides:

keySet in class Char2CharOpenCustomHashMap

values

public CharCollection values()

Specified by:

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

Specified by:

values in interface Char2CharMap

Overrides:

values in class Char2CharOpenCustomHashMap

forEach

public void forEach(CharCharConsumer action)

Description copied from interface: Char2CharMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Char2CharMap

Overrides:

forEach in class Char2CharOpenCustomHashMap

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.Character>

Overrides:

clear in class Char2CharOpenCustomHashMap

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 Char2CharOpenCustomHashMap

Parameters:

size - the amount of elements that should be allowed