speiger.src.collections.shorts.maps.impl.hash

Class Short2CharLinkedOpenHashMap

java.lang.Object

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

speiger.src.collections.shorts.maps.abstracts.AbstractShort2CharMap

speiger.src.collections.shorts.maps.impl.hash.Short2CharOpenHashMap

speiger.src.collections.shorts.maps.impl.hash.Short2CharLinkedOpenHashMap

All Implemented Interfaces:

java.util.Map<java.lang.Short,java.lang.Character>, java.util.SortedMap<java.lang.Short,java.lang.Character>, Short2CharFunction, Short2CharMap, Short2CharSortedMap

public class Short2CharLinkedOpenHashMap
extends Short2CharOpenHashMap
implements Short2CharSortedMap

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.shorts.maps.abstracts.AbstractShort2CharMap

AbstractShort2CharMap.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.shorts.maps.interfaces.Short2CharSortedMap

Short2CharSortedMap.FastSortedSet

Nested classes/interfaces inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2CharMap

Short2CharMap.Entry, Short2CharMap.FastEntrySet

Constructor Summary

Constructors

Constructor and Description
Short2CharLinkedOpenHashMap() Default Constructor
Short2CharLinkedOpenHashMap(int minCapacity) Constructor that defines the minimum capacity
Short2CharLinkedOpenHashMap(int minCapacity, float loadFactor) Constructor that defines the minimum capacity and load factor
Short2CharLinkedOpenHashMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Character> map) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Short2CharLinkedOpenHashMap(java.util.Map<? extends java.lang.Short,? 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.
Short2CharLinkedOpenHashMap(short[] keys, char[] values) Helper constructor that allow to create a map from unboxed values
Short2CharLinkedOpenHashMap(short[] keys, char[] values, float loadFactor) Helper constructor that allow to create a map from unboxed values
Short2CharLinkedOpenHashMap(java.lang.Short[] keys, java.lang.Character[] values) Helper constructor that allow to create a map from boxed values (it will unbox them)
Short2CharLinkedOpenHashMap(java.lang.Short[] keys, java.lang.Character[] values, float loadFactor) Helper constructor that allow to create a map from boxed values (it will unbox them)
Short2CharLinkedOpenHashMap(Short2CharMap map) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Short2CharLinkedOpenHashMap(Short2CharMap map, float loadFactor) A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.

Method Summary

Modifier and Type	Method and Description
void	clear()
ShortComparator	comparator()
char	firstCharValue() A method to get the first Value of a Map.
short	firstShortKey() A method to get the first Key of a Map.
void	forEach(ShortCharConsumer action) Type Specific forEach method to reduce boxing/unboxing
char	getAndMoveToFirst(short key) A Specific get method that allows to move teh given key/value int the first index.
char	getAndMoveToLast(short key) A Specific get method that allows to move teh given key/value int the last index.
Short2CharSortedMap	headMap(short toKey) A Type Specific HeadMap method to reduce boxing/unboxing
ShortSet	keySet()
char	lastCharValue() A method to get the last Value of a Map.
short	lastShortKey() A method to get the last Key of a Map.
boolean	moveToFirst(short key) A specific move method to move a given key/value to the first index.
boolean	moveToLast(short key) A specific move method to move a given key/value to the last index.
short	pollFirstShortKey() A method to get and remove the first Key of a Map.
short	pollLastShortKey() A method to get and remove the last Key of a Map.
char	putAndMoveToFirst(short key, char value) A customized put method that allows you to insert into the first index.
char	putAndMoveToLast(short key, char value) A customized put method that allows you to insert into the last index.
ObjectSet<Short2CharMap.Entry>	short2CharEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
Short2CharSortedMap	subMap(short fromKey, short toKey) A Type Specific SubMap method to reduce boxing/unboxing
Short2CharSortedMap	tailMap(short fromKey) A Type Specific TailMap method to reduce boxing/unboxing
CharCollection	values()

Methods inherited from class speiger.src.collections.shorts.maps.impl.hash.Short2CharOpenHashMap

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

Methods inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2CharMap

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.shorts.maps.interfaces.Short2CharSortedMap

firstKey, headMap, lastKey, subMap, tailMap

Methods inherited from interface java.util.SortedMap

entrySet

Methods inherited from interface speiger.src.collections.shorts.maps.interfaces.Short2CharMap

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, remove, remove, remove, remShort, remShortOrDefault, replace, replace, replace, replace, replaceAll, replaceChars, replaceChars, setDefaultReturnValue

Methods inherited from interface java.util.Map

equals, hashCode, isEmpty, putAll, size

Constructor Detail

Short2CharLinkedOpenHashMap

public Short2CharLinkedOpenHashMap()

Default Constructor

Short2CharLinkedOpenHashMap

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

Short2CharLinkedOpenHashMap

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

Short2CharLinkedOpenHashMap

public Short2CharLinkedOpenHashMap(java.lang.Short[] 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

Short2CharLinkedOpenHashMap

public Short2CharLinkedOpenHashMap(java.lang.Short[] 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

Short2CharLinkedOpenHashMap

public Short2CharLinkedOpenHashMap(short[] 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

Short2CharLinkedOpenHashMap

public Short2CharLinkedOpenHashMap(short[] 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

Short2CharLinkedOpenHashMap

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

Short2CharLinkedOpenHashMap

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

Short2CharLinkedOpenHashMap

public Short2CharLinkedOpenHashMap(Short2CharMap 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

Short2CharLinkedOpenHashMap

public Short2CharLinkedOpenHashMap(Short2CharMap 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(short key,
                              char value)

Description copied from interface: Short2CharSortedMap

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

Specified by:

putAndMoveToFirst in interface Short2CharSortedMap

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

Description copied from interface: Short2CharSortedMap

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 Short2CharSortedMap

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

Description copied from interface: Short2CharSortedMap

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

Specified by:

moveToFirst in interface Short2CharSortedMap

Parameters:

key - that should be moved to the first index

Returns:

true if the value was moved.

moveToLast

public boolean moveToLast(short key)

Description copied from interface: Short2CharSortedMap

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

Specified by:

moveToLast in interface Short2CharSortedMap

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

getAndMoveToFirst

public char getAndMoveToFirst(short key)

Description copied from interface: Short2CharSortedMap

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

Specified by:

getAndMoveToFirst in interface Short2CharSortedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public char getAndMoveToLast(short key)

Description copied from interface: Short2CharSortedMap

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

Specified by:

getAndMoveToLast in interface Short2CharSortedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

comparator

public ShortComparator comparator()

Specified by:

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

Specified by:

comparator in interface Short2CharSortedMap

subMap

public Short2CharSortedMap subMap(short fromKey,
                                  short toKey)

Description copied from interface: Short2CharSortedMap

A Type Specific SubMap method to reduce boxing/unboxing

Specified by:

subMap in interface Short2CharSortedMap

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 Short2CharSortedMap headMap(short toKey)

Description copied from interface: Short2CharSortedMap

A Type Specific HeadMap method to reduce boxing/unboxing

Specified by:

headMap in interface Short2CharSortedMap

Parameters:

toKey - where the headMap should end

Returns:

a HeadMap that is within the range of the desired range

tailMap

public Short2CharSortedMap tailMap(short fromKey)

Description copied from interface: Short2CharSortedMap

A Type Specific TailMap method to reduce boxing/unboxing

Specified by:

tailMap in interface Short2CharSortedMap

Parameters:

fromKey - where the TailMap should start

Returns:

a TailMap that is within the range of the desired range

firstShortKey

public short firstShortKey()

Description copied from interface: Short2CharSortedMap

A method to get the first Key of a Map.

Specified by:

firstShortKey in interface Short2CharSortedMap

Returns:

the first key in the map

pollFirstShortKey

public short pollFirstShortKey()

Description copied from interface: Short2CharSortedMap

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

Specified by:

pollFirstShortKey in interface Short2CharSortedMap

Returns:

the first key in the map

lastShortKey

public short lastShortKey()

Description copied from interface: Short2CharSortedMap

A method to get the last Key of a Map.

Specified by:

lastShortKey in interface Short2CharSortedMap

Returns:

the last key in the map

pollLastShortKey

public short pollLastShortKey()

Description copied from interface: Short2CharSortedMap

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

Specified by:

pollLastShortKey in interface Short2CharSortedMap

Returns:

the last key in the map

firstCharValue

public char firstCharValue()

Description copied from interface: Short2CharSortedMap

A method to get the first Value of a Map.

Specified by:

firstCharValue in interface Short2CharSortedMap

Returns:

the first key in the map

lastCharValue

public char lastCharValue()

Description copied from interface: Short2CharSortedMap

A method to get the last Value of a Map.

Specified by:

lastCharValue in interface Short2CharSortedMap

Returns:

the last key in the map

short2CharEntrySet

public ObjectSet<Short2CharMap.Entry> short2CharEntrySet()

Description copied from interface: Short2CharMap

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

Specified by:

short2CharEntrySet in interface Short2CharMap

Overrides:

short2CharEntrySet in class Short2CharOpenHashMap

Returns:

a EntrySet of the collection

keySet

public ShortSet keySet()

Specified by:

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

Specified by:

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

Specified by:

keySet in interface Short2CharMap

Specified by:

keySet in interface Short2CharSortedMap

Overrides:

keySet in class Short2CharOpenHashMap

values

public CharCollection values()

Specified by:

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

Specified by:

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

Specified by:

values in interface Short2CharMap

Specified by:

values in interface Short2CharSortedMap

Overrides:

values in class Short2CharOpenHashMap

forEach

public void forEach(ShortCharConsumer action)

Description copied from interface: Short2CharMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Short2CharMap

Overrides:

forEach in class Short2CharOpenHashMap

Parameters:

action - processor of the values that are iterator over

clear

public void clear()

Specified by:

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

Overrides:

clear in class Short2CharOpenHashMap