speiger.src.collections.shorts.maps.impl.misc

Class Short2BooleanArrayMap

java.lang.Object

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

speiger.src.collections.shorts.maps.abstracts.AbstractShort2BooleanMap

speiger.src.collections.shorts.maps.impl.misc.Short2BooleanArrayMap

All Implemented Interfaces:

java.util.Map<java.lang.Short,java.lang.Boolean>, Short2BooleanFunction, Short2BooleanMap, Short2BooleanOrderedMap

public class Short2BooleanArrayMap
extends AbstractShort2BooleanMap
implements Short2BooleanOrderedMap

A Very Specific Type Specific implementation of a ArrayMap. This type of map is for very specific use cases that usaully would have lead to Tupled Lists otherwise. It also does not allow duplication (except for array constructors) and checks from last to first. It is not designed to be used as a HashMap replacement due to the poor performance it would cause.

Note:

in this implementation SubMaps do NOT keep track of parent changes fully. For performance reasons it will just have a start/end index and not values Anything within that range will be updated appropiatly a shrink/growth of elements will break SubMaps in some ways. This can be useful but be careful, this implementation does not shrink and only grows.

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.shorts.maps.abstracts.AbstractShort2BooleanMap

AbstractShort2BooleanMap.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.Short2BooleanOrderedMap

Short2BooleanOrderedMap.FastOrderedSet

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

Short2BooleanMap.BuilderCache, Short2BooleanMap.Entry, Short2BooleanMap.FastEntrySet, Short2BooleanMap.MapBuilder

Constructor Summary

Constructors

Constructor and Description
Short2BooleanArrayMap() Default Constructor
Short2BooleanArrayMap(int minCapacity) Constructor that defines the minimum capacity
Short2BooleanArrayMap(java.util.Map<? extends java.lang.Short,? extends java.lang.Boolean> map) A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Short2BooleanArrayMap(short[] keys, boolean[] values) Helper constructor that allow to create a map from unboxed values
Short2BooleanArrayMap(java.lang.Short[] keys, java.lang.Boolean[] values) Helper constructor that allow to create a map from boxed values (it will unbox them)
Short2BooleanArrayMap(short[] keys, boolean[] values, int length) Helper constructor that allow to create a map from unboxed values
Short2BooleanArrayMap(java.lang.Short[] keys, java.lang.Boolean[] values, int length) Helper constructor that allow to create a map from boxed values (it will unbox them) with a custom length
Short2BooleanArrayMap(Short2BooleanMap map) 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()
boolean	computeBoolean(short key, ShortBooleanUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	computeBooleanIfAbsent(short key, Short2BooleanFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	computeBooleanIfPresent(short key, ShortBooleanUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	containsKey(java.lang.Object key)
boolean	containsKey(short key) Type Specific method to reduce boxing/unboxing of values
boolean	containsValue(boolean value) Type Specific method to reduce boxing/unboxing of values
boolean	containsValue(java.lang.Object value)
Short2BooleanArrayMap	copy() A Function that does a shallow clone of the Map itself.
boolean	firstBooleanValue() A method to get the first Value of a Map.
short	firstShortKey() A method to get the first Key of a Map.
void	forEach(ShortBooleanConsumer action) Type Specific forEach method to reduce boxing/unboxing
boolean	get(short key) A Type Specific get method to reduce boxing/unboxing
boolean	getAndMoveToFirst(short key) A Specific get method that allows to move teh given key/value int the first index.
boolean	getAndMoveToLast(short key) A Specific get method that allows to move teh given key/value int the last index.
boolean	getOrDefault(short key, boolean defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
ShortOrderedSet	keySet()
boolean	lastBooleanValue() A method to get the last Value of a Map.
short	lastShortKey() A method to get the last Key of a Map.
void	mergeAllBoolean(Short2BooleanMap m, BooleanBooleanUnaryOperator mappingFunction) A Bulk method for merging Maps.
boolean	mergeBoolean(short key, boolean value, BooleanBooleanUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
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.
boolean	put(short key, boolean value) Type Specific method to reduce boxing/unboxing of values
boolean	putAndMoveToFirst(short key, boolean value) A customized put method that allows you to insert into the first index.
boolean	putAndMoveToLast(short key, boolean value) A customized put method that allows you to insert into the last index.
boolean	putIfAbsent(short key, boolean value) Type Specific method to reduce boxing/unboxing of values
java.lang.Boolean	remove(java.lang.Object key)
boolean	remove(java.lang.Object key, java.lang.Object value)
boolean	remove(short key) Type Specific remove function to reduce boxing/unboxing
boolean	remove(short key, boolean value) Type Specific remove function to reduce boxing/unboxing
boolean	removeOrDefault(short key, boolean defaultValue) Type-Specific Remove function with a default return value if wanted.
boolean	replace(short key, boolean value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(short key, boolean oldValue, boolean newValue) A Type Specific replace method to replace an existing value
ObjectOrderedSet<Short2BooleanMap.Entry>	short2BooleanEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
int	size()
boolean	supplyBooleanIfAbsent(short key, BooleanSupplier valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
BooleanCollection	values()

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

entrySet, equals, get, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, replaceBooleans, replaceBooleans, 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.shorts.maps.interfaces.Short2BooleanOrderedMap

synchronize, synchronize, unmodifiable

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

builder, compute, computeIfAbsent, computeIfPresent, entrySet, forEach, get, getDefaultReturnValue, getOrDefault, merge, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, replace, replace, replaceAll, replaceBooleans, replaceBooleans, setDefaultReturnValue

Methods inherited from interface java.util.Map

equals, hashCode, isEmpty, putAll

Constructor Detail

Short2BooleanArrayMap

public Short2BooleanArrayMap()

Default Constructor

Short2BooleanArrayMap

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

Short2BooleanArrayMap

public Short2BooleanArrayMap(java.lang.Short[] keys,
                             java.lang.Boolean[] 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 length

Short2BooleanArrayMap

public Short2BooleanArrayMap(java.lang.Short[] keys,
                             java.lang.Boolean[] values,
                             int length)

Helper constructor that allow to create a map from boxed values (it will unbox them) with a custom length

Parameters:

keys - the keys that should be put into the map

values - the values that should be put into the map.

length - the amount of values that should be pulled from the array

Throws:

java.lang.IllegalStateException - if the keys and values do not match in length

Short2BooleanArrayMap

public Short2BooleanArrayMap(short[] keys,
                             boolean[] 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

Short2BooleanArrayMap

public Short2BooleanArrayMap(short[] keys,
                             boolean[] values,
                             int length)

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.

length - the amount of values that should be pulled from the array

Throws:

java.lang.IllegalStateException - if the keys and values do not match in lenght

Short2BooleanArrayMap

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

Short2BooleanArrayMap

public Short2BooleanArrayMap(Short2BooleanMap 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

Method Detail

put

public boolean put(short key,
                   boolean value)

Description copied from interface: Short2BooleanMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

put in interface Short2BooleanMap

Parameters:

key - the key that should be inserted,

value - the value that should be inserted

Returns:

the last present value or default return value.

See Also:

Map.put(Object, Object)

putIfAbsent

public boolean putIfAbsent(short key,
                           boolean value)

Description copied from interface: Short2BooleanMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

putIfAbsent in interface Short2BooleanMap

Parameters:

key - the key that should be inserted,

value - the value that should be inserted

Returns:

the last present value or default return value.

See Also:

Map.putIfAbsent(Object, Object)

putAndMoveToFirst

public boolean putAndMoveToFirst(short key,
                                 boolean value)

Description copied from interface: Short2BooleanOrderedMap

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

Specified by:

putAndMoveToFirst in interface Short2BooleanOrderedMap

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

Description copied from interface: Short2BooleanOrderedMap

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 Short2BooleanOrderedMap

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

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

Specified by:

moveToFirst in interface Short2BooleanOrderedMap

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

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

Specified by:

moveToLast in interface Short2BooleanOrderedMap

Parameters:

key - that should be moved to the first last

Returns:

true if the value was moved.

containsKey

public boolean containsKey(short key)

Description copied from interface: Short2BooleanMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsKey in interface Short2BooleanMap

Overrides:

containsKey in class AbstractShort2BooleanMap

Parameters:

key - element that is searched for

Returns:

if the key is present

containsValue

public boolean containsValue(boolean value)

Description copied from interface: Short2BooleanMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsValue in interface Short2BooleanMap

Overrides:

containsValue in class AbstractShort2BooleanMap

Parameters:

value - element that is searched for

Returns:

if the value is present

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<java.lang.Short,java.lang.Boolean>

Specified by:

containsKey in interface Short2BooleanMap

Overrides:

containsKey in class java.util.AbstractMap<java.lang.Short,java.lang.Boolean>

Parameters:

key - that is searched for.

Returns:

true if found

See Also:

Map.containsKey(Object)

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<java.lang.Short,java.lang.Boolean>

Specified by:

containsValue in interface Short2BooleanMap

Overrides:

containsValue in class java.util.AbstractMap<java.lang.Short,java.lang.Boolean>

Parameters:

value - that is searched for.

Returns:

true if found

See Also:

Map.containsValue(Object)

get

public boolean get(short key)

Description copied from interface: Short2BooleanMap

A Type Specific get method to reduce boxing/unboxing

Specified by:

get in interface Short2BooleanFunction

Specified by:

get in interface Short2BooleanMap

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

getOrDefault

public boolean getOrDefault(short key,
                            boolean defaultValue)

Description copied from interface: Short2BooleanMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Short2BooleanMap

Overrides:

getOrDefault in class AbstractShort2BooleanMap

Parameters:

key - the key that is searched for

defaultValue - the value that should be returned if the key is not present

Returns:

the searched value or defaultValue value

getAndMoveToFirst

public boolean getAndMoveToFirst(short key)

Description copied from interface: Short2BooleanOrderedMap

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

Specified by:

getAndMoveToFirst in interface Short2BooleanOrderedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

getAndMoveToLast

public boolean getAndMoveToLast(short key)

Description copied from interface: Short2BooleanOrderedMap

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

Specified by:

getAndMoveToLast in interface Short2BooleanOrderedMap

Parameters:

key - that is searched for

Returns:

the given value for the requested key or default return value

firstShortKey

public short firstShortKey()

Description copied from interface: Short2BooleanOrderedMap

A method to get the first Key of a Map.

Specified by:

firstShortKey in interface Short2BooleanOrderedMap

Returns:

the first key in the map

lastShortKey

public short lastShortKey()

Description copied from interface: Short2BooleanOrderedMap

A method to get the last Key of a Map.

Specified by:

lastShortKey in interface Short2BooleanOrderedMap

Returns:

the last key in the map

firstBooleanValue

public boolean firstBooleanValue()

Description copied from interface: Short2BooleanOrderedMap

A method to get the first Value of a Map.

Specified by:

firstBooleanValue in interface Short2BooleanOrderedMap

Returns:

the first key in the map

lastBooleanValue

public boolean lastBooleanValue()

Description copied from interface: Short2BooleanOrderedMap

A method to get the last Value of a Map.

Specified by:

lastBooleanValue in interface Short2BooleanOrderedMap

Returns:

the last key in the map

pollFirstShortKey

public short pollFirstShortKey()

Description copied from interface: Short2BooleanOrderedMap

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

Specified by:

pollFirstShortKey in interface Short2BooleanOrderedMap

Returns:

the first key in the map

pollLastShortKey

public short pollLastShortKey()

Description copied from interface: Short2BooleanOrderedMap

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

Specified by:

pollLastShortKey in interface Short2BooleanOrderedMap

Returns:

the last key in the map

remove

public boolean remove(short key)

Description copied from interface: Short2BooleanMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Short2BooleanMap

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

removeOrDefault

public boolean removeOrDefault(short key,
                               boolean defaultValue)

Description copied from interface: Short2BooleanMap

Type-Specific Remove function with a default return value if wanted.

Specified by:

removeOrDefault in interface Short2BooleanMap

Parameters:

key - the element that should be removed

defaultValue - the value that should be returned if the entry doesn't exist

Returns:

the value that was removed or default value

See Also:

Map.remove(Object, Object)

remove

public boolean remove(short key,
                      boolean value)

Description copied from interface: Short2BooleanMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Short2BooleanMap

Parameters:

key - the element that should be removed

value - the expected value that should be found

Returns:

true if the key and value was found and removed

See Also:

Map.remove(Object, Object)

remove

public java.lang.Boolean remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<java.lang.Short,java.lang.Boolean>

Specified by:

remove in interface Short2BooleanMap

Overrides:

remove in class AbstractShort2BooleanMap

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

See Also:

Map.remove(Object)

remove

public boolean remove(java.lang.Object key,
                      java.lang.Object value)

Specified by:

remove in interface java.util.Map<java.lang.Short,java.lang.Boolean>

Specified by:

remove in interface Short2BooleanMap

Parameters:

key - the element that should be removed

value - the expected value that should be found

Returns:

true if the key and value was found and removed

See Also:

Map.remove(Object, Object)

forEach

public void forEach(ShortBooleanConsumer action)

Description copied from interface: Short2BooleanMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Short2BooleanMap

Overrides:

forEach in class AbstractShort2BooleanMap

Parameters:

action - processor of the values that are iterator over

keySet

public ShortOrderedSet keySet()

Specified by:

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

Specified by:

keySet in interface Short2BooleanMap

Specified by:

keySet in interface Short2BooleanOrderedMap

Overrides:

keySet in class AbstractShort2BooleanMap

values

public BooleanCollection values()

Specified by:

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

Specified by:

values in interface Short2BooleanMap

Overrides:

values in class AbstractShort2BooleanMap

short2BooleanEntrySet

public ObjectOrderedSet<Short2BooleanMap.Entry> short2BooleanEntrySet()

Description copied from interface: Short2BooleanMap

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

Specified by:

short2BooleanEntrySet in interface Short2BooleanMap

Specified by:

short2BooleanEntrySet in interface Short2BooleanOrderedMap

Returns:

a EntrySet of the collection

replace

public boolean replace(short key,
                       boolean oldValue,
                       boolean newValue)

Description copied from interface: Short2BooleanMap

A Type Specific replace method to replace an existing value

Specified by:

replace in interface Short2BooleanMap

Overrides:

replace in class AbstractShort2BooleanMap

Parameters:

key - the element that should be searched for

oldValue - the expected value to be replaced

newValue - the value to replace the oldValue with.

Returns:

true if the value got replaced

replace

public boolean replace(short key,
                       boolean value)

Description copied from interface: Short2BooleanMap

A Type Specific replace method to reduce boxing/unboxing replace an existing value

Specified by:

replace in interface Short2BooleanMap

Overrides:

replace in class AbstractShort2BooleanMap

Parameters:

key - the element that should be searched for

value - the value to replace with.

Returns:

the present value or default return value

computeBoolean

public boolean computeBoolean(short key,
                              ShortBooleanUnaryOperator mappingFunction)

Description copied from interface: Short2BooleanMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeBoolean in interface Short2BooleanMap

Overrides:

computeBoolean in class AbstractShort2BooleanMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeBooleanIfAbsent

public boolean computeBooleanIfAbsent(short key,
                                      Short2BooleanFunction mappingFunction)

Description copied from interface: Short2BooleanMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeBooleanIfAbsent in interface Short2BooleanMap

Overrides:

computeBooleanIfAbsent in class AbstractShort2BooleanMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value if not present

Returns:

the result of the computed value or present value

supplyBooleanIfAbsent

public boolean supplyBooleanIfAbsent(short key,
                                     BooleanSupplier valueProvider)

Description copied from interface: Short2BooleanMap

A Supplier based computeIfAbsent function to fill the most used usecase of this function

Specified by:

supplyBooleanIfAbsent in interface Short2BooleanMap

Overrides:

supplyBooleanIfAbsent in class AbstractShort2BooleanMap

Parameters:

key - the key that should be computed

valueProvider - the value if not present

Returns:

the result of the computed value or present value

computeBooleanIfPresent

public boolean computeBooleanIfPresent(short key,
                                       ShortBooleanUnaryOperator mappingFunction)

Description copied from interface: Short2BooleanMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeBooleanIfPresent in interface Short2BooleanMap

Overrides:

computeBooleanIfPresent in class AbstractShort2BooleanMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value if present

Returns:

the result of the default return value or present value

mergeBoolean

public boolean mergeBoolean(short key,
                            boolean value,
                            BooleanBooleanUnaryOperator mappingFunction)

Description copied from interface: Short2BooleanMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeBoolean in interface Short2BooleanMap

Overrides:

mergeBoolean in class AbstractShort2BooleanMap

Parameters:

key - the key that should be be searched for

value - the value that should be merged with

mappingFunction - the operator that should generate the new Value

Returns:

the result of the merge

mergeAllBoolean

public void mergeAllBoolean(Short2BooleanMap m,
                            BooleanBooleanUnaryOperator mappingFunction)

Description copied from interface: Short2BooleanMap

A Bulk method for merging Maps.

Specified by:

mergeAllBoolean in interface Short2BooleanMap

Overrides:

mergeAllBoolean in class AbstractShort2BooleanMap

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

size

public int size()

Specified by:

size in interface java.util.Map<java.lang.Short,java.lang.Boolean>

Overrides:

size in class java.util.AbstractMap<java.lang.Short,java.lang.Boolean>

clear

public void clear()

Specified by:

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

Overrides:

clear in class java.util.AbstractMap<java.lang.Short,java.lang.Boolean>

copy

public Short2BooleanArrayMap copy()

Description copied from interface: Short2BooleanMap

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 Short2BooleanMap

Specified by:

copy in interface Short2BooleanOrderedMap

Overrides:

copy in class AbstractShort2BooleanMap

Returns:

a Shallow Copy of the Map