speiger.src.collections.booleans.maps.interfaces

Interface Boolean2LongMap

All Superinterfaces:

Boolean2LongFunction, java.util.Map<java.lang.Boolean,java.lang.Long>

All Known Implementing Classes:

AbstractBoolean2LongMap

public interface Boolean2LongMap
extends java.util.Map<java.lang.Boolean,java.lang.Long>, Boolean2LongFunction

A Type Specific Map that reduces memory overhead due to boxing/unboxing of Primitives and some extra helper functions.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Boolean2LongMap.Entry Type Specific Map Entry that reduces boxing/unboxing
static interface	Boolean2LongMap.FastEntrySet Fast Entry set that allows for a faster Entry Iterator by recycling the Entry Object and just exchanging 1 internal value

Method Summary

Modifier and Type	Method and Description
long	addTo(boolean key, long value) A Helper method to add a primitives together.
void	addToAll(Boolean2LongMap m) A Helper method to bulk add primitives together.
ObjectSet<Boolean2LongMap.Entry>	boolean2LongEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
default java.lang.Long	compute(java.lang.Boolean key, java.util.function.BiFunction<? super java.lang.Boolean,? super java.lang.Long,? extends java.lang.Long> mappingFunction) Deprecated.
default java.lang.Long	computeIfAbsent(java.lang.Boolean key, java.util.function.Function<? super java.lang.Boolean,? extends java.lang.Long> mappingFunction) Deprecated.
default java.lang.Long	computeIfPresent(java.lang.Boolean key, java.util.function.BiFunction<? super java.lang.Boolean,? super java.lang.Long,? extends java.lang.Long> mappingFunction) Deprecated.
long	computeLong(boolean key, BooleanLongUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
long	computeLongIfAbsent(boolean key, Boolean2LongFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
long	computeLongIfPresent(boolean key, BooleanLongUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	containsKey(boolean key) Type Specific method to reduce boxing/unboxing of values
default boolean	containsKey(java.lang.Object key)
boolean	containsValue(long value) Type Specific method to reduce boxing/unboxing of values
default boolean	containsValue(java.lang.Object value)
Boolean2LongMap	copy() A Function that does a shallow clone of the Map itself.
ObjectSet<java.util.Map.Entry<java.lang.Boolean,java.lang.Long>>	entrySet() Deprecated.
default void	forEach(java.util.function.BiConsumer<? super java.lang.Boolean,? super java.lang.Long> action) Deprecated.
void	forEach(BooleanLongConsumer action) Type Specific forEach method to reduce boxing/unboxing
long	get(boolean key) A Type Specific get method to reduce boxing/unboxing
default java.lang.Long	get(java.lang.Object key) Deprecated.
long	getDefaultReturnValue() Method to see what the default return value is.
long	getOrDefault(boolean key, long defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
default java.lang.Long	getOrDefault(java.lang.Object key, java.lang.Long defaultValue) Deprecated.
BooleanSet	keySet()
default java.lang.Long	merge(java.lang.Boolean key, java.lang.Long value, java.util.function.BiFunction<? super java.lang.Long,? super java.lang.Long,? extends java.lang.Long> mappingFunction) Deprecated.
void	mergeAllLong(Boolean2LongMap m, LongLongUnaryOperator mappingFunction) A Bulk method for merging Maps.
long	mergeLong(boolean key, long value, LongLongUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
long	put(boolean key, long value) Type Specific method to reduce boxing/unboxing of values
default java.lang.Long	put(java.lang.Boolean key, java.lang.Long value) Deprecated.
default void	putAll(boolean[] keys, long[] values) Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
default void	putAll(java.lang.Boolean[] keys, java.lang.Long[] values) Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances
void	putAll(boolean[] keys, long[] values, int offset, int size) Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
void	putAll(java.lang.Boolean[] keys, java.lang.Long[] values, int offset, int size) Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances
void	putAll(Boolean2LongMap m) Type Specific function for the bull putting of values
void	putAllIfAbsent(Boolean2LongMap m) Type-Specific bulk put method put elements into the map if not present.
long	putIfAbsent(boolean key, long value) Type Specific method to reduce boxing/unboxing of values
default java.lang.Long	putIfAbsent(java.lang.Boolean key, java.lang.Long value) Deprecated.
long	remove(boolean key) Type Specific remove function to reduce boxing/unboxing
boolean	remove(boolean key, long value) Type Specific remove function to reduce boxing/unboxing
default java.lang.Long	remove(java.lang.Object key)
default boolean	remove(java.lang.Object key, java.lang.Object value)
long	removeOrDefault(boolean key, long defaultValue) Type-Specific Remove function with a default return value if wanted.
long	replace(boolean key, long value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
default java.lang.Long	replace(java.lang.Boolean key, java.lang.Long value) Deprecated.
boolean	replace(boolean key, long oldValue, long newValue) A Type Specific replace method to replace an existing value
default boolean	replace(java.lang.Boolean key, java.lang.Long oldValue, java.lang.Long newValue) Deprecated.
default void	replaceAll(java.util.function.BiFunction<? super java.lang.Boolean,? super java.lang.Long,? extends java.lang.Long> mappingFunction) Deprecated.
void	replaceLongs(Boolean2LongMap m) Type-Specific bulk replace method.
void	replaceLongs(BooleanLongUnaryOperator mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
Boolean2LongMap	setDefaultReturnValue(long v) Method to define the default return value if a requested key isn't present
long	subFrom(boolean key, long value) A Helper method to subtract from primitive from each other.
long	supplyLongIfAbsent(boolean key, LongSupplier valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
LongCollection	values()

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

getDefaultReturnValue

long getDefaultReturnValue()

Method to see what the default return value is.

Returns:

default return value

setDefaultReturnValue

Boolean2LongMap setDefaultReturnValue(long v)

Method to define the default return value if a requested key isn't present

Parameters:

v - value that should be the default return value

Returns:

itself

copy

Boolean2LongMap copy()

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

Returns:

a Shallow Copy of the Map

Note:

Wrappers and view Maps will not support this feature

put

long put(boolean key,
         long value)

Type Specific method to reduce boxing/unboxing of values

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)

putAll

default void putAll(boolean[] keys,
                    long[] values)

Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances

Parameters:

keys - the keys that should be added

values - the values that should be added

Throws:

java.lang.IllegalStateException - if the arrays are not the same size

See Also:

Map.putAll(Map)

putAll

void putAll(boolean[] keys,
            long[] values,
            int offset,
            int size)

Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances

Parameters:

keys - the keys that should be added

values - the values that should be added

offset - where the to start in the array

size - how many elements should be added

Throws:

java.lang.IllegalStateException - if the arrays are not within the range

See Also:

Map.putAll(Map)

putAll

default void putAll(java.lang.Boolean[] keys,
                    java.lang.Long[] values)

Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances

Parameters:

keys - the keys that should be added

values - the values that should be added

Throws:

java.lang.IllegalStateException - if the arrays are not the same size

See Also:

Map.putAll(Map)

putAll

void putAll(java.lang.Boolean[] keys,
            java.lang.Long[] values,
            int offset,
            int size)

Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances

Parameters:

keys - the keys that should be added

values - the values that should be added

offset - where the to start in the array

size - how many elements should be added

Throws:

java.lang.IllegalStateException - if the arrays are not within the range

See Also:

Map.putAll(Map)

putIfAbsent

long putIfAbsent(boolean key,
                 long value)

Type Specific method to reduce boxing/unboxing of values

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)

putAllIfAbsent

void putAllIfAbsent(Boolean2LongMap m)

Type-Specific bulk put method put elements into the map if not present.

Parameters:

m - elements that should be added if not present.

addTo

long addTo(boolean key,
           long value)

A Helper method to add a primitives together. If key is not present then this functions as a put.

Parameters:

key - the key that should be inserted,

value - the value that should be inserted / added

Returns:

the last present value or default return value.

addToAll

void addToAll(Boolean2LongMap m)

A Helper method to bulk add primitives together.

Parameters:

m - the values that should be added/inserted

subFrom

long subFrom(boolean key,
             long value)

A Helper method to subtract from primitive from each other. If the key is not present it will just return the defaultValue How the implementation works is that it will subtract from the current value (if not present it will do nothing) and fence it to the getDefaultReturnValue() If the fence is reached the element will be automaticall removed

Parameters:

key - that should be subtract from

value - that should be subtract

Returns:

the last present or default return value

putAll

void putAll(Boolean2LongMap m)

Type Specific function for the bull putting of values

Parameters:

m - the elements that should be inserted

containsKey

boolean containsKey(boolean key)

Type Specific method to reduce boxing/unboxing of values

Parameters:

key - element that is searched for

Returns:

if the key is present

containsKey

default boolean containsKey(java.lang.Object key)

Specified by:

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

Parameters:

key - that is searched for.

Returns:

true if found

See Also:

Map.containsKey(Object)

Note:

in some implementations key does not have to be Boolean but just have to support equals with Boolean.

containsValue

boolean containsValue(long value)

Type Specific method to reduce boxing/unboxing of values

Parameters:

value - element that is searched for

Returns:

if the value is present

containsValue

default boolean containsValue(java.lang.Object value)

Specified by:

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

Parameters:

value - that is searched for.

Returns:

true if found

See Also:

Map.containsValue(Object)

Note:

in some implementations key does not have to be CLASS_VALUE but just have to support equals with CLASS_VALUE.

remove

long remove(boolean key)

Type Specific remove function to reduce boxing/unboxing

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

remove

default java.lang.Long remove(java.lang.Object key)

Specified by:

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

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

See Also:

Map.remove(Object)

Note:

in some implementations key does not have to be Boolean but just have to support equals with Boolean.

remove

boolean remove(boolean key,
               long value)

Type Specific remove function to reduce boxing/unboxing

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

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

Specified by:

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

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)

removeOrDefault

long removeOrDefault(boolean key,
                     long defaultValue)

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

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)

replace

boolean replace(boolean key,
                long oldValue,
                long newValue)

A Type Specific replace method to replace an existing value

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

Note:

this fails if the value is not present even if it matches the oldValue

replace

long replace(boolean key,
             long value)

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

Parameters:

key - the element that should be searched for

value - the value to replace with.

Returns:

the present value or default return value

Note:

this fails if the value is not present

replaceLongs

void replaceLongs(Boolean2LongMap m)

Type-Specific bulk replace method. Could be seen as putAllIfPresent

Parameters:

m - elements that should be replaced.

replaceLongs

void replaceLongs(BooleanLongUnaryOperator mappingFunction)

A Type Specific mass replace method to reduce boxing/unboxing

Parameters:

mappingFunction - operation to replace all values

computeLong

long computeLong(boolean key,
                 BooleanLongUnaryOperator mappingFunction)

A Type Specific compute method to reduce boxing/unboxing

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeLongIfAbsent

long computeLongIfAbsent(boolean key,
                         Boolean2LongFunction mappingFunction)

A Type Specific compute method to reduce boxing/unboxing

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

supplyLongIfAbsent

long supplyLongIfAbsent(boolean key,
                        LongSupplier valueProvider)

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

Parameters:

key - the key that should be computed

valueProvider - the value if not present

Returns:

the result of the computed value or present value

computeLongIfPresent

long computeLongIfPresent(boolean key,
                          BooleanLongUnaryOperator mappingFunction)

A Type Specific compute method to reduce boxing/unboxing

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

Note:

if not present then compute is not executed

mergeLong

long mergeLong(boolean key,
               long value,
               LongLongUnaryOperator mappingFunction)

A Type Specific merge method to reduce boxing/unboxing

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

Note:

if the result matches the default return value then the key is removed from the map

mergeAllLong

void mergeAllLong(Boolean2LongMap m,
                  LongLongUnaryOperator mappingFunction)

A Bulk method for merging Maps.

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

Note:

if the result matches the default return value then the key is removed from the map

replace

@Deprecated
default boolean replace(java.lang.Boolean key,
                                     java.lang.Long oldValue,
                                     java.lang.Long newValue)

Deprecated.

Specified by:

replace in interface java.util.Map<java.lang.Boolean,java.lang.Long>

replace

@Deprecated
default java.lang.Long replace(java.lang.Boolean key,
                                            java.lang.Long value)

Deprecated.

Specified by:

replace in interface java.util.Map<java.lang.Boolean,java.lang.Long>

get

long get(boolean key)

A Type Specific get method to reduce boxing/unboxing

Specified by:

get in interface Boolean2LongFunction

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

getOrDefault

long getOrDefault(boolean key,
                  long defaultValue)

A Type Specific getOrDefault method to reduce boxing/unboxing

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

get

@Deprecated
default java.lang.Long get(java.lang.Object key)

Deprecated.

Specified by:

get in interface java.util.Map<java.lang.Boolean,java.lang.Long>

getOrDefault

@Deprecated
default java.lang.Long getOrDefault(java.lang.Object key,
                                                 java.lang.Long defaultValue)

Deprecated.

Specified by:

getOrDefault in interface java.util.Map<java.lang.Boolean,java.lang.Long>

replaceAll

@Deprecated
default void replaceAll(java.util.function.BiFunction<? super java.lang.Boolean,? super java.lang.Long,? extends java.lang.Long> mappingFunction)

Deprecated.

Specified by:

replaceAll in interface java.util.Map<java.lang.Boolean,java.lang.Long>

compute

@Deprecated
default java.lang.Long compute(java.lang.Boolean key,
                                            java.util.function.BiFunction<? super java.lang.Boolean,? super java.lang.Long,? extends java.lang.Long> mappingFunction)

Deprecated.

Specified by:

compute in interface java.util.Map<java.lang.Boolean,java.lang.Long>

computeIfAbsent

@Deprecated
default java.lang.Long computeIfAbsent(java.lang.Boolean key,
                                                    java.util.function.Function<? super java.lang.Boolean,? extends java.lang.Long> mappingFunction)

Deprecated.

Specified by:

computeIfAbsent in interface java.util.Map<java.lang.Boolean,java.lang.Long>

computeIfPresent

@Deprecated
default java.lang.Long computeIfPresent(java.lang.Boolean key,
                                                     java.util.function.BiFunction<? super java.lang.Boolean,? super java.lang.Long,? extends java.lang.Long> mappingFunction)

Deprecated.

Specified by:

computeIfPresent in interface java.util.Map<java.lang.Boolean,java.lang.Long>

merge

@Deprecated
default java.lang.Long merge(java.lang.Boolean key,
                                          java.lang.Long value,
                                          java.util.function.BiFunction<? super java.lang.Long,? super java.lang.Long,? extends java.lang.Long> mappingFunction)

Deprecated.

Specified by:

merge in interface java.util.Map<java.lang.Boolean,java.lang.Long>

forEach

void forEach(BooleanLongConsumer action)

Type Specific forEach method to reduce boxing/unboxing

Parameters:

action - processor of the values that are iterator over

forEach

@Deprecated
default void forEach(java.util.function.BiConsumer<? super java.lang.Boolean,? super java.lang.Long> action)

Deprecated.

Specified by:

forEach in interface java.util.Map<java.lang.Boolean,java.lang.Long>

keySet

BooleanSet keySet()

Specified by:

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

values

LongCollection values()

Specified by:

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

entrySet

@Deprecated
ObjectSet<java.util.Map.Entry<java.lang.Boolean,java.lang.Long>> entrySet()

Deprecated.

Specified by:

entrySet in interface java.util.Map<java.lang.Boolean,java.lang.Long>

boolean2LongEntrySet

ObjectSet<Boolean2LongMap.Entry> boolean2LongEntrySet()

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

Returns:

a EntrySet of the collection

put

@Deprecated
default java.lang.Long put(java.lang.Boolean key,
                                        java.lang.Long value)

Deprecated.

Specified by:

put in interface java.util.Map<java.lang.Boolean,java.lang.Long>

putIfAbsent

@Deprecated
default java.lang.Long putIfAbsent(java.lang.Boolean key,
                                                java.lang.Long value)

Deprecated.

Specified by:

putIfAbsent in interface java.util.Map<java.lang.Boolean,java.lang.Long>