speiger.src.collections.objects.maps.abstracts

Class AbstractObject2BooleanMap<T>

java.lang.Object

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

speiger.src.collections.objects.maps.abstracts.AbstractObject2BooleanMap<T>

Type Parameters:

T - the keyType of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.Predicate<T>, java.util.Map<T,java.lang.Boolean>, Object2BooleanMap<T>

Direct Known Subclasses:

Enum2BooleanMap, ImmutableObject2BooleanOpenHashMap, Object2BooleanArrayMap, Object2BooleanAVLTreeMap, Object2BooleanConcurrentOpenHashMap, Object2BooleanMaps.EmptyMap, Object2BooleanMaps.SingletonMap, Object2BooleanMaps.SynchronizedMap, Object2BooleanMaps.UnmodifyableMap, Object2BooleanOpenCustomHashMap, Object2BooleanOpenHashMap, Object2BooleanRBTreeMap

public abstract class AbstractObject2BooleanMap<T>
extends java.util.AbstractMap<T,java.lang.Boolean>
implements Object2BooleanMap<T>

A Base Implementation of a Type Specific Map to reduce boxing/unboxing

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractObject2BooleanMap.BasicEntry<T> A Simple Type Specific Entry class to reduce boxing/unboxing

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.objects.maps.interfaces.Object2BooleanMap

Object2BooleanMap.BuilderCache<T>, Object2BooleanMap.Entry<T>, Object2BooleanMap.FastEntrySet<T>, Object2BooleanMap.MapBuilder

Constructor Summary

Constructors

Constructor and Description
AbstractObject2BooleanMap()

Method Summary

Modifier and Type	Method and Description
boolean	computeBoolean(T key, ObjectBooleanUnaryOperator<T> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	computeBooleanIfAbsent(T key, java.util.function.Predicate<T> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	computeBooleanIfPresent(T key, ObjectBooleanUnaryOperator<T> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	containsKey(java.lang.Object key)
boolean	containsValue(boolean value) Type Specific method to reduce boxing/unboxing of values
Object2BooleanMap<T>	copy() A Function that does a shallow clone of the Map itself.
ObjectSet<java.util.Map.Entry<T,java.lang.Boolean>>	entrySet()
boolean	equals(java.lang.Object o)
void	forEach(ObjectBooleanConsumer<T> action) Type Specific forEach method to reduce boxing/unboxing
java.lang.Boolean	get(java.lang.Object key)
boolean	getDefaultReturnValue() Method to see what the default return value is.
java.lang.Boolean	getOrDefault(java.lang.Object key, java.lang.Boolean defaultValue)
int	hashCode()
ObjectSet<T>	keySet()
void	mergeAllBoolean(Object2BooleanMap<T> m, BooleanBooleanUnaryOperator mappingFunction) A Bulk method for merging Maps.
boolean	mergeBoolean(T key, boolean value, BooleanBooleanUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
java.lang.Boolean	put(T key, java.lang.Boolean value) Deprecated.
void	putAll(java.util.Map<? extends T,? extends java.lang.Boolean> m)
void	putAll(Object2BooleanMap<T> m) Type Specific function for the bull putting of values
void	putAll(T[] 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(T[] 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	putAllIfAbsent(Object2BooleanMap<T> m) Type-Specific bulk put method put elements into the map if not present.
java.lang.Boolean	remove(java.lang.Object key)
boolean	replace(T key, boolean value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(T key, boolean oldValue, boolean newValue) A Type Specific replace method to replace an existing value
void	replaceBooleans(Object2BooleanMap<T> m) Type-Specific bulk replace method.
void	replaceBooleans(ObjectBooleanUnaryOperator<T> mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
AbstractObject2BooleanMap<T>	setDefaultReturnValue(boolean v) Method to define the default return value if a requested key isn't present
boolean	supplyBooleanIfAbsent(T key, BooleanSupplier valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
BooleanCollection	values()

Methods inherited from class java.util.AbstractMap

clear, containsValue, isEmpty, size, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2BooleanMap

builder, compute, computeIfAbsent, computeIfPresent, containsValue, forEach, getBoolean, getOrDefault, merge, object2BooleanEntrySet, put, put, put, putAll, putAll, putIfAbsent, putIfAbsent, rem, remOrDefault, remove, remove, replace, replace, replaceAll, synchronize, synchronize, test, unmodifiable

Methods inherited from interface java.util.Map

clear, isEmpty, size

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Constructor Detail

AbstractObject2BooleanMap

public AbstractObject2BooleanMap()

Method Detail

getDefaultReturnValue

public boolean getDefaultReturnValue()

Description copied from interface: Object2BooleanMap

Method to see what the default return value is.

Specified by:

getDefaultReturnValue in interface Object2BooleanMap<T>

Returns:

default return value

setDefaultReturnValue

public AbstractObject2BooleanMap<T> setDefaultReturnValue(boolean v)

Description copied from interface: Object2BooleanMap

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

Specified by:

setDefaultReturnValue in interface Object2BooleanMap<T>

Parameters:

v - value that should be the default return value

Returns:

itself

copy

public Object2BooleanMap<T> copy()

Description copied from interface: Object2BooleanMap

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 Object2BooleanMap<T>

Returns:

a Shallow Copy of the Map

put

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

Deprecated.

Specified by:

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

Specified by:

put in interface Object2BooleanMap<T>

Overrides:

put in class java.util.AbstractMap<T,java.lang.Boolean>

putAll

public void putAll(Object2BooleanMap<T> m)

Description copied from interface: Object2BooleanMap

Type Specific function for the bull putting of values

Specified by:

putAll in interface Object2BooleanMap<T>

Parameters:

m - the elements that should be inserted

putAll

public void putAll(java.util.Map<? extends T,? extends java.lang.Boolean> m)

Specified by:

putAll in interface java.util.Map<T,java.lang.Boolean>

Overrides:

putAll in class java.util.AbstractMap<T,java.lang.Boolean>

putAll

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

Description copied from interface: Object2BooleanMap

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

Specified by:

putAll in interface Object2BooleanMap<T>

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

See Also:

Map.putAll(Map)

putAll

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

Description copied from interface: Object2BooleanMap

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

Specified by:

putAll in interface Object2BooleanMap<T>

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

See Also:

Map.putAll(Map)

putAllIfAbsent

public void putAllIfAbsent(Object2BooleanMap<T> m)

Description copied from interface: Object2BooleanMap

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

Specified by:

putAllIfAbsent in interface Object2BooleanMap<T>

Parameters:

m - elements that should be added if not present.

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

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

Overrides:

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

containsValue

public boolean containsValue(boolean value)

Description copied from interface: Object2BooleanMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsValue in interface Object2BooleanMap<T>

Parameters:

value - element that is searched for

Returns:

if the value is present

replace

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

Description copied from interface: Object2BooleanMap

A Type Specific replace method to replace an existing value

Specified by:

replace in interface Object2BooleanMap<T>

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

Description copied from interface: Object2BooleanMap

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

Specified by:

replace in interface Object2BooleanMap<T>

Parameters:

key - the element that should be searched for

value - the value to replace with.

Returns:

the present value or default return value

replaceBooleans

public void replaceBooleans(Object2BooleanMap<T> m)

Description copied from interface: Object2BooleanMap

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

Specified by:

replaceBooleans in interface Object2BooleanMap<T>

Parameters:

m - elements that should be replaced.

replaceBooleans

public void replaceBooleans(ObjectBooleanUnaryOperator<T> mappingFunction)

Description copied from interface: Object2BooleanMap

A Type Specific mass replace method to reduce boxing/unboxing

Specified by:

replaceBooleans in interface Object2BooleanMap<T>

Parameters:

mappingFunction - operation to replace all values

computeBoolean

public boolean computeBoolean(T key,
                              ObjectBooleanUnaryOperator<T> mappingFunction)

Description copied from interface: Object2BooleanMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeBoolean in interface Object2BooleanMap<T>

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(T key,
                                      java.util.function.Predicate<T> mappingFunction)

Description copied from interface: Object2BooleanMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeBooleanIfAbsent in interface Object2BooleanMap<T>

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(T key,
                                     BooleanSupplier valueProvider)

Description copied from interface: Object2BooleanMap

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

Specified by:

supplyBooleanIfAbsent in interface Object2BooleanMap<T>

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(T key,
                                       ObjectBooleanUnaryOperator<T> mappingFunction)

Description copied from interface: Object2BooleanMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeBooleanIfPresent in interface Object2BooleanMap<T>

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(T key,
                            boolean value,
                            BooleanBooleanUnaryOperator mappingFunction)

Description copied from interface: Object2BooleanMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeBoolean in interface Object2BooleanMap<T>

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(Object2BooleanMap<T> m,
                            BooleanBooleanUnaryOperator mappingFunction)

Description copied from interface: Object2BooleanMap

A Bulk method for merging Maps.

Specified by:

mergeAllBoolean in interface Object2BooleanMap<T>

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

get

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

Specified by:

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

Specified by:

get in interface Object2BooleanMap<T>

Overrides:

get in class java.util.AbstractMap<T,java.lang.Boolean>

getOrDefault

public java.lang.Boolean getOrDefault(java.lang.Object key,
                                      java.lang.Boolean defaultValue)

Specified by:

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

Specified by:

getOrDefault in interface Object2BooleanMap<T>

remove

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

Specified by:

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

Specified by:

remove in interface Object2BooleanMap<T>

Overrides:

remove in class java.util.AbstractMap<T,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)

forEach

public void forEach(ObjectBooleanConsumer<T> action)

Description copied from interface: Object2BooleanMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Object2BooleanMap<T>

Parameters:

action - processor of the values that are iterator over

keySet

public ObjectSet<T> keySet()

Specified by:

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

Specified by:

keySet in interface Object2BooleanMap<T>

Overrides:

keySet in class java.util.AbstractMap<T,java.lang.Boolean>

values

public BooleanCollection values()

Specified by:

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

Specified by:

values in interface Object2BooleanMap<T>

Overrides:

values in class java.util.AbstractMap<T,java.lang.Boolean>

entrySet

public ObjectSet<java.util.Map.Entry<T,java.lang.Boolean>> entrySet()

Specified by:

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

Specified by:

entrySet in interface Object2BooleanMap<T>

Specified by:

entrySet in class java.util.AbstractMap<T,java.lang.Boolean>

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.Map<T,java.lang.Boolean>

Overrides:

equals in class java.util.AbstractMap<T,java.lang.Boolean>

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map<T,java.lang.Boolean>

Overrides:

hashCode in class java.util.AbstractMap<T,java.lang.Boolean>