speiger.src.collections.booleans.maps.interfaces

Interface Boolean2BooleanMap

All Superinterfaces:

Boolean2BooleanFunction, java.util.Map<java.lang.Boolean,java.lang.Boolean>

All Known Implementing Classes:

AbstractBoolean2BooleanMap

public interface Boolean2BooleanMap
extends java.util.Map<java.lang.Boolean,java.lang.Boolean>, Boolean2BooleanFunction

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	Boolean2BooleanMap.Entry Type Specific Map Entry that reduces boxing/unboxing
static interface	Boolean2BooleanMap.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
ObjectSet<Boolean2BooleanMap.Entry>	boolean2BooleanEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
default java.lang.Boolean	compute(java.lang.Boolean key, java.util.function.BiFunction<? super java.lang.Boolean,? super java.lang.Boolean,? extends java.lang.Boolean> mappingFunction) Deprecated.
boolean	computeBoolean(boolean key, BooleanBooleanUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	computeBooleanIfAbsent(boolean key, Boolean2BooleanFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	computeBooleanIfPresent(boolean key, BooleanBooleanUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
default java.lang.Boolean	computeIfAbsent(java.lang.Boolean key, java.util.function.Function<? super java.lang.Boolean,? extends java.lang.Boolean> mappingFunction) Deprecated.
default java.lang.Boolean	computeIfPresent(java.lang.Boolean key, java.util.function.BiFunction<? super java.lang.Boolean,? super java.lang.Boolean,? extends java.lang.Boolean> mappingFunction) Deprecated.
boolean	containsKey(boolean key) Type Specific method to reduce boxing/unboxing of values
default boolean	containsKey(java.lang.Object key)
boolean	containsValue(boolean value) Type Specific method to reduce boxing/unboxing of values
default boolean	containsValue(java.lang.Object value)
Boolean2BooleanMap	copy() A Function that does a shallow clone of the Map itself.
ObjectSet<java.util.Map.Entry<java.lang.Boolean,java.lang.Boolean>>	entrySet() Deprecated.
default void	forEach(java.util.function.BiConsumer<? super java.lang.Boolean,? super java.lang.Boolean> action) Deprecated.
void	forEach(BooleanBooleanConsumer action) Type Specific forEach method to reduce boxing/unboxing
boolean	get(boolean key) A Type Specific get method to reduce boxing/unboxing
default java.lang.Boolean	get(java.lang.Object key) Deprecated.
boolean	getDefaultReturnValue() Method to see what the default return value is.
boolean	getOrDefault(boolean key, boolean defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
default java.lang.Boolean	getOrDefault(java.lang.Object key, java.lang.Boolean defaultValue) Deprecated.
BooleanSet	keySet()
default java.lang.Boolean	merge(java.lang.Boolean key, java.lang.Boolean value, java.util.function.BiFunction<? super java.lang.Boolean,? super java.lang.Boolean,? extends java.lang.Boolean> mappingFunction) Deprecated.
void	mergeAllBoolean(Boolean2BooleanMap m, BooleanBooleanUnaryOperator mappingFunction) A Bulk method for merging Maps.
boolean	mergeBoolean(boolean key, boolean value, BooleanBooleanUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
boolean	put(boolean key, boolean value) Type Specific method to reduce boxing/unboxing of values
default java.lang.Boolean	put(java.lang.Boolean key, java.lang.Boolean value) Deprecated.
default void	putAll(boolean[] keys, boolean[] 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.Boolean[] values) Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances
void	putAll(boolean[] keys, boolean[] 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.Boolean[] 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(Boolean2BooleanMap m) Type Specific function for the bull putting of values
void	putAllIfAbsent(Boolean2BooleanMap m) Type-Specific bulk put method put elements into the map if not present.
boolean	putIfAbsent(boolean key, boolean value) Type Specific method to reduce boxing/unboxing of values
default java.lang.Boolean	putIfAbsent(java.lang.Boolean key, java.lang.Boolean value) Deprecated.
boolean	remove(boolean key) Type Specific remove function to reduce boxing/unboxing
boolean	remove(boolean key, boolean value) Type Specific remove function to reduce boxing/unboxing
default java.lang.Boolean	remove(java.lang.Object key)
default boolean	remove(java.lang.Object key, java.lang.Object value)
boolean	removeOrDefault(boolean key, boolean defaultValue) Type-Specific Remove function with a default return value if wanted.
boolean	replace(boolean key, boolean value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
default java.lang.Boolean	replace(java.lang.Boolean key, java.lang.Boolean value) Deprecated.
boolean	replace(boolean key, boolean oldValue, boolean newValue) A Type Specific replace method to replace an existing value
default boolean	replace(java.lang.Boolean key, java.lang.Boolean oldValue, java.lang.Boolean newValue) Deprecated.
default void	replaceAll(java.util.function.BiFunction<? super java.lang.Boolean,? super java.lang.Boolean,? extends java.lang.Boolean> mappingFunction) Deprecated.
void	replaceBooleans(Boolean2BooleanMap m) Type-Specific bulk replace method.
void	replaceBooleans(BooleanBooleanUnaryOperator mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
Boolean2BooleanMap	setDefaultReturnValue(boolean v) Method to define the default return value if a requested key isn't present
boolean	supplyBooleanIfAbsent(boolean key, BooleanSupplier valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
BooleanCollection	values()

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

getDefaultReturnValue

boolean getDefaultReturnValue()

Method to see what the default return value is.

Returns:

default return value

setDefaultReturnValue

Boolean2BooleanMap setDefaultReturnValue(boolean 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

Boolean2BooleanMap 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

boolean put(boolean key,
            boolean 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,
                    boolean[] 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,
            boolean[] 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.Boolean[] 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.Boolean[] 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

boolean putIfAbsent(boolean key,
                    boolean 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(Boolean2BooleanMap m)

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

Parameters:

m - elements that should be added if not present.

putAll

void putAll(Boolean2BooleanMap 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.Boolean>

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(boolean 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.Boolean>

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

boolean 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.Boolean remove(java.lang.Object key)

Specified by:

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

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,
               boolean 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.Boolean>

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

boolean removeOrDefault(boolean key,
                        boolean 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,
                boolean oldValue,
                boolean 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

boolean replace(boolean key,
                boolean 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

replaceBooleans

void replaceBooleans(Boolean2BooleanMap m)

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

Parameters:

m - elements that should be replaced.

replaceBooleans

void replaceBooleans(BooleanBooleanUnaryOperator mappingFunction)

A Type Specific mass replace method to reduce boxing/unboxing

Parameters:

mappingFunction - operation to replace all values

computeBoolean

boolean computeBoolean(boolean key,
                       BooleanBooleanUnaryOperator 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

computeBooleanIfAbsent

boolean computeBooleanIfAbsent(boolean key,
                               Boolean2BooleanFunction 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

supplyBooleanIfAbsent

boolean supplyBooleanIfAbsent(boolean key,
                              BooleanSupplier 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

computeBooleanIfPresent

boolean computeBooleanIfPresent(boolean key,
                                BooleanBooleanUnaryOperator 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

mergeBoolean

boolean mergeBoolean(boolean key,
                     boolean value,
                     BooleanBooleanUnaryOperator 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

mergeAllBoolean

void mergeAllBoolean(Boolean2BooleanMap m,
                     BooleanBooleanUnaryOperator 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.Boolean oldValue,
                                     java.lang.Boolean newValue)

Deprecated.

Specified by:

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

replace

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

Deprecated.

Specified by:

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

get

boolean get(boolean key)

A Type Specific get method to reduce boxing/unboxing

Specified by:

get in interface Boolean2BooleanFunction

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

getOrDefault

boolean getOrDefault(boolean key,
                     boolean 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.Boolean get(java.lang.Object key)

Deprecated.

Specified by:

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

getOrDefault

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

Deprecated.

Specified by:

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

replaceAll

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

Deprecated.

Specified by:

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

compute

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

Deprecated.

Specified by:

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

computeIfAbsent

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

Deprecated.

Specified by:

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

computeIfPresent

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

Deprecated.

Specified by:

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

merge

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

Deprecated.

Specified by:

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

forEach

void forEach(BooleanBooleanConsumer 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.Boolean> action)

Deprecated.

Specified by:

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

keySet

BooleanSet keySet()

Specified by:

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

values

BooleanCollection values()

Specified by:

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

entrySet

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

Deprecated.

Specified by:

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

boolean2BooleanEntrySet

ObjectSet<Boolean2BooleanMap.Entry> boolean2BooleanEntrySet()

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

Returns:

a EntrySet of the collection

put

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

Deprecated.

Specified by:

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

putIfAbsent

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

Deprecated.

Specified by:

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