speiger.src.collections.longs.maps.impl.hash

Class Long2CharLinkedOpenHashMap

java.lang.Object

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

speiger.src.collections.longs.maps.abstracts.AbstractLong2CharMap

speiger.src.collections.longs.maps.impl.hash.Long2CharOpenHashMap

speiger.src.collections.longs.maps.impl.hash.Long2CharLinkedOpenHashMap

All Implemented Interfaces:

java.util.Map<java.lang.Long,java.lang.Character>, java.util.SortedMap<java.lang.Long,java.lang.Character>, Long2CharFunction, Long2CharMap, Long2CharSortedMap

public class Long2CharLinkedOpenHashMap
extends Long2CharOpenHashMap
implements Long2CharSortedMap

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.longs.maps.abstracts.AbstractLong2CharMap

AbstractLong2CharMap.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.Long2CharSortedMap

Long2CharSortedMap.FastSortedSet

Nested classes/interfaces inherited from interface speiger.src.collections.longs.maps.interfaces.Long2CharMap

Long2CharMap.Entry, Long2CharMap.FastEntrySet

Constructor Summary

Constructors

Constructor and Description
Long2CharLinkedOpenHashMap() Default Constructor
Long2CharLinkedOpenHashMap(int minCapacity) Constructor that defines the minimum capacity
Long2CharLinkedOpenHashMap(int minCapacity, float loadFactor) Constructor that defines the minimum capacity and load factor
Long2CharLinkedOpenHashMap(long[] keys, char[] values) Helper constructor that allow to create a map from unboxed values
Long2CharLinkedOpenHashMap(long[] keys, char[] values, float loadFactor) Helper constructor that allow to create a map from unboxed values
Long2CharLinkedOpenHashMap(java.lang.Long[] keys, java.lang.Character[] values) Helper constructor that allow to create a map from boxed values (it will unbox them)
Long2CharLinkedOpenHashMap(java.lang.Long[] keys, java.lang.Character[] values, float loadFactor) Helper constructor that allow to create a map from boxed values (it will unbox them)
Long2CharLinkedOpenHashMap(Long2CharMap map) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Long2CharLinkedOpenHashMap(Long2CharMap map, float loadFactor) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Long2CharLinkedOpenHashMap(java.util.Map<? extends java.lang.Long,? extends java.lang.Character> map) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Long2CharLinkedOpenHashMap(java.util.Map<? extends java.lang.Long,? 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
void	clear()
LongComparator	comparator()
char	firstCharValue() A method to get the first Value of a Map.
long	firstLongKey() A method to get the first Key of a Map.
void	forEach(LongCharConsumer action) Type Specific forEach method to reduce boxing/unboxing
char	getAndMoveToFirst(long key) A Specific get method that allows to move teh given key/value int the first index.
char	getAndMoveToLast(long key) A Specific get method that allows to move teh given key/value int the last index.
Long2CharSortedMap	headMap(long toKey) A Type Specific HeadMap method to reduce boxing/unboxing
LongSet	keySet()
char	lastCharValue() A method to get the last Value of a Map.
long	lastLongKey() A method to get the last Key of a Map.
ObjectSet<Long2CharMap.Entry>	long2CharEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
boolean	moveToFirst(long key) A specific move method to move a given key/value to the first index.
boolean	moveToLast(long key) A specific move method to move a given key/value to the last index.
long	pollFirstLongKey() A method to get and remove the first Key of a Map.
long	pollLastLongKey() A method to get and remove the last Key of a Map.
char	putAndMoveToFirst(long key, char value) A customized put method that allows you to insert into the first index.
char	putAndMoveToLast(long key, char value) A customized put method that allows you to insert into the last index.
Long2CharSortedMap	subMap(long fromKey, long toKey) A Type Specific SubMap method to reduce boxing/unboxing
Long2CharSortedMap	tailMap(long fromKey) A Type Specific TailMap method to reduce boxing/unboxing
CharCollection	values()

Methods inherited from class speiger.src.collections.longs.maps.impl.hash.Long2CharOpenHashMap

addTo, computeChar, computeCharIfAbsent, computeCharIfPresent, containsKey, containsKey, containsValue, containsValue, get, getChar, getOrDefault, mergeAllChar, mergeChar, put, putIfAbsent, remLong, remLongOrDefault, remove, remove, remove, replace, replace, size

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

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

firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from interface java.util.SortedMap

entrySet

Methods inherited from interface speiger.src.collections.longs.maps.interfaces.Long2CharMap

addTo, addToAll, compute, computeChar, computeCharIfAbsent, computeCharIfPresent, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, get, getChar, getDefaultReturnValue, getOrDefault, getOrDefault, merge, mergeAllChar, mergeChar, put, put, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, putIfAbsent, remLong, remLongOrDefault, remove, remove, remove, replace, replace, replace, replace, replaceAll, replaceChars, replaceChars, setDefaultReturnValue

Methods inherited from interface java.util.Map

equals, hashCode, isEmpty, putAll, size

Constructor Detail

Long2CharLinkedOpenHashMap

public Long2CharLinkedOpenHashMap()

Default Constructor

Long2CharLinkedOpenHashMap

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

Long2CharLinkedOpenHashMap

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

Long2CharLinkedOpenHashMap

public Long2CharLinkedOpenHashMap(java.lang.Long[] 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

Long2CharLinkedOpenHashMap

public Long2CharLinkedOpenHashMap(java.lang.Long[] 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

Long2CharLinkedOpenHashMap

public Long2CharLinkedOpenHashMap(long[] 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

Long2CharLinkedOpenHashMap

public Long2CharLinkedOpenHashMap(long[] 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

Long2CharLinkedOpenHashMap

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

Long2CharLinkedOpenHashMap

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

Long2CharLinkedOpenHashMap

public Long2CharLinkedOpenHashMap(Long2CharMap 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

Long2CharLinkedOpenHashMap

public Long2CharLinkedOpenHashMap(Long2CharMap 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(long key,
                              char value)

Description copied from interface: Long2CharSortedMap

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

Specified by:

putAndMoveToFirst in interface Long2CharSortedMap

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

Description copied from interface: Long2CharSortedMap

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 Long2CharSortedMap

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

Description copied from interface: Long2CharSortedMap

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

Specified by:

moveToFirst in interface Long2CharSortedMap

Parameters:

key - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(long key)

Description copied from interface: Long2CharSortedMap

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

Specified by:

moveToLast in interface Long2CharSortedMap

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public char getAndMoveToFirst(long key)

Description copied from interface: Long2CharSortedMap

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

Specified by:

getAndMoveToFirst in interface Long2CharSortedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public char getAndMoveToLast(long key)

Description copied from interface: Long2CharSortedMap

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

Specified by:

getAndMoveToLast in interface Long2CharSortedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

comparator

public LongComparator comparator()

Specified by:

comparator in interface java.util.SortedMap<java.lang.Long,java.lang.Character>

Specified by:

comparator in interface Long2CharSortedMap

subMap

public Long2CharSortedMap subMap(long fromKey,
                                 long toKey)

Description copied from interface: Long2CharSortedMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Long2CharSortedMap

Parameters:

fromKey - where the submap should start

toKey - where the subMap should end

Returns:

a SubMap that is within the range of the desired range

headMap

public Long2CharSortedMap headMap(long toKey)

Description copied from interface: Long2CharSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Long2CharSortedMap

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

public Long2CharSortedMap tailMap(long fromKey)

Description copied from interface: Long2CharSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Long2CharSortedMap

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range

firstLongKey

public long firstLongKey()

Description copied from interface: Long2CharSortedMap

A method to get the first Key of a Map.

Specified by:

firstLongKey in interface Long2CharSortedMap

Returns:

the first key in the map

pollFirstLongKey

public long pollFirstLongKey()

Description copied from interface: Long2CharSortedMap

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

Specified by:

pollFirstLongKey in interface Long2CharSortedMap

Returns:

the first key in the map

lastLongKey

public long lastLongKey()

Description copied from interface: Long2CharSortedMap

A method to get the last Key of a Map.

Specified by:

lastLongKey in interface Long2CharSortedMap

Returns:

the last key in the map

pollLastLongKey

public long pollLastLongKey()

Description copied from interface: Long2CharSortedMap

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

Specified by:

pollLastLongKey in interface Long2CharSortedMap

Returns:

the last key in the map

firstCharValue

public char firstCharValue()

Description copied from interface: Long2CharSortedMap

A method to get the first Value of a Map.

Specified by:

firstCharValue in interface Long2CharSortedMap

Returns:

the first key in the map

lastCharValue

public char lastCharValue()

Description copied from interface: Long2CharSortedMap

A method to get the last Value of a Map.

Specified by:

lastCharValue in interface Long2CharSortedMap

Returns:

the last key in the map

long2CharEntrySet

public ObjectSet<Long2CharMap.Entry> long2CharEntrySet()

Description copied from interface: Long2CharMap

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

Specified by:

long2CharEntrySet in interface Long2CharMap

Overrides:

long2CharEntrySet in class Long2CharOpenHashMap

Returns:

a EntrySet of the collection

keySet

public LongSet keySet()

Specified by:

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

Specified by:

keySet in interface java.util.SortedMap<java.lang.Long,java.lang.Character>

Specified by:

keySet in interface Long2CharMap

Specified by:

keySet in interface Long2CharSortedMap

Overrides:

keySet in class Long2CharOpenHashMap

values

public CharCollection values()

Specified by:

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

Specified by:

values in interface java.util.SortedMap<java.lang.Long,java.lang.Character>

Specified by:

values in interface Long2CharMap

Specified by:

values in interface Long2CharSortedMap

Overrides:

values in class Long2CharOpenHashMap

forEach

public void forEach(LongCharConsumer action)

Description copied from interface: Long2CharMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Long2CharMap

Overrides:

forEach in class Long2CharOpenHashMap

Parameters:

action - processor of the values that are iterator over

clear

public void clear()

Specified by:

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

Overrides:

clear in class Long2CharOpenHashMap