speiger.src.collections.chars.maps.abstracts

Class AbstractChar2BooleanMap

java.lang.Object

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

speiger.src.collections.chars.maps.abstracts.AbstractChar2BooleanMap

All Implemented Interfaces:

java.util.Map<java.lang.Character,java.lang.Boolean>, Char2BooleanFunction, Char2BooleanMap

Direct Known Subclasses:

Char2BooleanArrayMap, Char2BooleanAVLTreeMap, Char2BooleanConcurrentOpenHashMap, Char2BooleanMaps.EmptyMap, Char2BooleanMaps.SingletonMap, Char2BooleanMaps.SynchronizedMap, Char2BooleanMaps.UnmodifyableMap, Char2BooleanOpenCustomHashMap, Char2BooleanOpenHashMap, Char2BooleanRBTreeMap, ImmutableChar2BooleanOpenHashMap

public abstract class AbstractChar2BooleanMap
extends java.util.AbstractMap<java.lang.Character,java.lang.Boolean>
implements Char2BooleanMap

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	AbstractChar2BooleanMap.BasicEntry 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.chars.maps.interfaces.Char2BooleanMap

Char2BooleanMap.BuilderCache, Char2BooleanMap.Entry, Char2BooleanMap.FastEntrySet, Char2BooleanMap.MapBuilder

Constructor Summary

Constructors

Constructor and Description
AbstractChar2BooleanMap()

Method Summary

Modifier and Type	Method and Description
boolean	computeBoolean(char key, CharBooleanUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	computeBooleanIfAbsent(char key, Char2BooleanFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	computeBooleanIfPresent(char key, CharBooleanUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	containsKey(char key) Type Specific method to reduce boxing/unboxing of values
boolean	containsValue(boolean value) Type Specific method to reduce boxing/unboxing of values
Char2BooleanMap	copy() A Function that does a shallow clone of the Map itself.
ObjectSet<java.util.Map.Entry<java.lang.Character,java.lang.Boolean>>	entrySet()
boolean	equals(java.lang.Object o)
void	forEach(CharBooleanConsumer 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.
boolean	getOrDefault(char key, boolean defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
java.lang.Boolean	getOrDefault(java.lang.Object key, java.lang.Boolean defaultValue)
int	hashCode()
CharSet	keySet()
void	mergeAllBoolean(Char2BooleanMap m, BooleanBooleanUnaryOperator mappingFunction) A Bulk method for merging Maps.
boolean	mergeBoolean(char key, boolean value, BooleanBooleanUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
java.lang.Boolean	put(java.lang.Character key, java.lang.Boolean value) Deprecated.
void	putAll(char[] 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(Char2BooleanMap m) Type Specific function for the bull putting of values
void	putAll(java.lang.Character[] 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(java.util.Map<? extends java.lang.Character,? extends java.lang.Boolean> m)
void	putAllIfAbsent(Char2BooleanMap m) Type-Specific bulk put method put elements into the map if not present.
java.lang.Boolean	remove(java.lang.Object key)
boolean	replace(char key, boolean value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(char key, boolean oldValue, boolean newValue) A Type Specific replace method to replace an existing value
void	replaceBooleans(Char2BooleanMap m) Type-Specific bulk replace method.
void	replaceBooleans(CharBooleanUnaryOperator mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
AbstractChar2BooleanMap	setDefaultReturnValue(boolean v) Method to define the default return value if a requested key isn't present
boolean	supplyBooleanIfAbsent(char 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, containsKey, containsValue, isEmpty, size, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.chars.maps.interfaces.Char2BooleanMap

builder, char2BooleanEntrySet, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, forEach, get, merge, put, putAll, putAll, putIfAbsent, putIfAbsent, remove, remove, remove, removeOrDefault, replace, replace, replaceAll, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Map

clear, isEmpty, size

Constructor Detail

AbstractChar2BooleanMap

public AbstractChar2BooleanMap()

Method Detail

getDefaultReturnValue

public boolean getDefaultReturnValue()

Description copied from interface: Char2BooleanMap

Method to see what the default return value is.

Specified by:

getDefaultReturnValue in interface Char2BooleanMap

Returns:

default return value

setDefaultReturnValue

public AbstractChar2BooleanMap setDefaultReturnValue(boolean v)

Description copied from interface: Char2BooleanMap

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

Specified by:

setDefaultReturnValue in interface Char2BooleanMap

Parameters:

v - value that should be the default return value

Returns:

itself

copy

public Char2BooleanMap copy()

Description copied from interface: Char2BooleanMap

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 Char2BooleanMap

Returns:

a Shallow Copy of the Map

put

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

Deprecated.

Specified by:

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

Specified by:

put in interface Char2BooleanMap

Overrides:

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

putAll

public void putAll(Char2BooleanMap m)

Description copied from interface: Char2BooleanMap

Type Specific function for the bull putting of values

Specified by:

putAll in interface Char2BooleanMap

Parameters:

m - the elements that should be inserted

putAll

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

Specified by:

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

Overrides:

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

putAll

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

Description copied from interface: Char2BooleanMap

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

Specified by:

putAll in interface Char2BooleanMap

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(java.lang.Character[] keys,
                   java.lang.Boolean[] values,
                   int offset,
                   int size)

Description copied from interface: Char2BooleanMap

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

Specified by:

putAll in interface Char2BooleanMap

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(Char2BooleanMap m)

Description copied from interface: Char2BooleanMap

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

Specified by:

putAllIfAbsent in interface Char2BooleanMap

Parameters:

m - elements that should be added if not present.

containsKey

public boolean containsKey(char key)

Description copied from interface: Char2BooleanMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsKey in interface Char2BooleanMap

Parameters:

key - element that is searched for

Returns:

if the key is present

containsValue

public boolean containsValue(boolean value)

Description copied from interface: Char2BooleanMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsValue in interface Char2BooleanMap

Parameters:

value - element that is searched for

Returns:

if the value is present

replace

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

Description copied from interface: Char2BooleanMap

A Type Specific replace method to replace an existing value

Specified by:

replace in interface Char2BooleanMap

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

Description copied from interface: Char2BooleanMap

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

Specified by:

replace in interface Char2BooleanMap

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(Char2BooleanMap m)

Description copied from interface: Char2BooleanMap

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

Specified by:

replaceBooleans in interface Char2BooleanMap

Parameters:

m - elements that should be replaced.

replaceBooleans

public void replaceBooleans(CharBooleanUnaryOperator mappingFunction)

Description copied from interface: Char2BooleanMap

A Type Specific mass replace method to reduce boxing/unboxing

Specified by:

replaceBooleans in interface Char2BooleanMap

Parameters:

mappingFunction - operation to replace all values

computeBoolean

public boolean computeBoolean(char key,
                              CharBooleanUnaryOperator mappingFunction)

Description copied from interface: Char2BooleanMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeBoolean in interface Char2BooleanMap

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(char key,
                                      Char2BooleanFunction mappingFunction)

Description copied from interface: Char2BooleanMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeBooleanIfAbsent in interface Char2BooleanMap

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

Description copied from interface: Char2BooleanMap

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

Specified by:

supplyBooleanIfAbsent in interface Char2BooleanMap

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(char key,
                                       CharBooleanUnaryOperator mappingFunction)

Description copied from interface: Char2BooleanMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeBooleanIfPresent in interface Char2BooleanMap

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

Description copied from interface: Char2BooleanMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeBoolean in interface Char2BooleanMap

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

Description copied from interface: Char2BooleanMap

A Bulk method for merging Maps.

Specified by:

mergeAllBoolean in interface Char2BooleanMap

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<java.lang.Character,java.lang.Boolean>

Specified by:

get in interface Char2BooleanMap

Overrides:

get in class java.util.AbstractMap<java.lang.Character,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<java.lang.Character,java.lang.Boolean>

Specified by:

getOrDefault in interface Char2BooleanMap

getOrDefault

public boolean getOrDefault(char key,
                            boolean defaultValue)

Description copied from interface: Char2BooleanMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Char2BooleanMap

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

remove

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

Specified by:

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

Specified by:

remove in interface Char2BooleanMap

Overrides:

remove in class java.util.AbstractMap<java.lang.Character,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(CharBooleanConsumer action)

Description copied from interface: Char2BooleanMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Char2BooleanMap

Parameters:

action - processor of the values that are iterator over

keySet

public CharSet keySet()

Specified by:

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

Specified by:

keySet in interface Char2BooleanMap

Overrides:

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

values

public BooleanCollection values()

Specified by:

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

Specified by:

values in interface Char2BooleanMap

Overrides:

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

entrySet

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

Specified by:

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

Specified by:

entrySet in interface Char2BooleanMap

Specified by:

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

equals

public boolean equals(java.lang.Object o)

Specified by:

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

Overrides:

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

hashCode

public int hashCode()

Specified by:

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

Overrides:

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