speiger.src.collections.shorts.utils.maps

Class Short2BooleanMaps.UnmodifyableMap

java.lang.Object

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

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

speiger.src.collections.shorts.utils.maps.Short2BooleanMaps.UnmodifyableMap

All Implemented Interfaces:

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

Direct Known Subclasses:

Short2BooleanMaps.UnmodifyableOrderedMap, Short2BooleanMaps.UnmodifyableSortedMap

Enclosing class:

Short2BooleanMaps

public static class Short2BooleanMaps.UnmodifyableMap
extends AbstractShort2BooleanMap
implements Short2BooleanMap

The Unmodifyable Map implementation that is sued for the unmodifyableMap function

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.Short2BooleanMap

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

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
Short2BooleanMap	copy() A Function that does a shallow clone of the Map itself.
boolean	get(short key) A Type Specific get method to reduce boxing/unboxing
boolean	getOrDefault(short key, boolean defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
ShortSet	keySet()
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	put(short key, boolean value) Type Specific method to reduce boxing/unboxing of values
boolean	putIfAbsent(short key, boolean value) Type Specific method to reduce boxing/unboxing of values
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.
void	replaceBooleans(Short2BooleanMap m) Type-Specific bulk replace method.
void	replaceBooleans(ShortBooleanUnaryOperator mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
ObjectSet<Short2BooleanMap.Entry>	short2BooleanEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
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

containsKey, containsValue, entrySet, equals, forEach, get, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, remove, replace, replace, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap

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.shorts.maps.interfaces.Short2BooleanMap

builder, compute, computeIfAbsent, computeIfPresent, containsKey, containsKey, containsValue, containsValue, entrySet, forEach, forEach, get, getDefaultReturnValue, getOrDefault, merge, put, putAll, putAll, putAll, putAll, putAll, putAllIfAbsent, putIfAbsent, remove, remove, replace, replace, replace, replace, replaceAll, setDefaultReturnValue, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Map

equals, hashCode, isEmpty, putAll, size

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)

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)

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

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

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

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

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

replaceBooleans

public void replaceBooleans(ShortBooleanUnaryOperator mappingFunction)

Description copied from interface: Short2BooleanMap

A Type Specific mass replace method to reduce boxing/unboxing

Specified by:

replaceBooleans in interface Short2BooleanMap

Overrides:

replaceBooleans in class AbstractShort2BooleanMap

Parameters:

mappingFunction - operation to replace all values

replaceBooleans

public void replaceBooleans(Short2BooleanMap m)

Description copied from interface: Short2BooleanMap

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

Specified by:

replaceBooleans in interface Short2BooleanMap

Overrides:

replaceBooleans in class AbstractShort2BooleanMap

Parameters:

m - elements that should be replaced.

copy

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

Overrides:

copy in class AbstractShort2BooleanMap

Returns:

a Shallow Copy of the Map

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>

keySet

public ShortSet keySet()

Specified by:

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

Specified by:

keySet in interface Short2BooleanMap

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 ObjectSet<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

Returns:

a EntrySet of the collection