speiger.src.collections.bytes.utils.maps

Class Byte2CharMaps.SingletonMap

java.lang.Object

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

speiger.src.collections.bytes.maps.abstracts.AbstractByte2CharMap

speiger.src.collections.bytes.utils.maps.Byte2CharMaps.SingletonMap

All Implemented Interfaces:

java.util.Map<java.lang.Byte,java.lang.Character>, Byte2CharFunction, Byte2CharMap

Enclosing class:

Byte2CharMaps

public static class Byte2CharMaps.SingletonMap
extends AbstractByte2CharMap

Singleton Map instance that is used in the helper method

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.bytes.maps.abstracts.AbstractByte2CharMap

AbstractByte2CharMap.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.bytes.maps.interfaces.Byte2CharMap

Byte2CharMap.BuilderCache, Byte2CharMap.Entry, Byte2CharMap.FastEntrySet, Byte2CharMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
char	addTo(byte key, char value) A Helper method to add a primitives together.
ObjectSet<Byte2CharMap.Entry>	byte2CharEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
char	computeChar(byte key, ByteCharUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
char	computeCharIfAbsent(byte key, Byte2CharFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
char	computeCharIfPresent(byte key, ByteCharUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
Byte2CharMaps.SingletonMap	copy() A Function that does a shallow clone of the Map itself.
char	get(byte key) A Type Specific get method to reduce boxing/unboxing
char	getOrDefault(byte key, char defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
ByteSet	keySet()
void	mergeAllChar(Byte2CharMap m, CharCharUnaryOperator mappingFunction) A Bulk method for merging Maps.
char	mergeChar(byte key, char value, CharCharUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
char	put(byte key, char value) Type Specific method to reduce boxing/unboxing of values
char	putIfAbsent(byte key, char value) Type Specific method to reduce boxing/unboxing of values
char	remove(byte key) Type Specific remove function to reduce boxing/unboxing
boolean	remove(byte key, char value) Type Specific remove function to reduce boxing/unboxing
char	removeOrDefault(byte key, char defaultValue) Type-Specific Remove function with a default return value if wanted.
char	subFrom(byte key, char value) A Helper method to subtract from primitive from each other.
char	supplyCharIfAbsent(byte key, CharSupplier valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
CharCollection	values()

Methods inherited from class speiger.src.collections.bytes.maps.abstracts.AbstractByte2CharMap

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

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.bytes.maps.interfaces.Byte2CharMap

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

Methods inherited from interface java.util.Map

clear, isEmpty, size

Method Detail

put

public char put(byte key,
                char value)

Description copied from interface: Byte2CharMap

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)

putIfAbsent

public char putIfAbsent(byte key,
                        char value)

Description copied from interface: Byte2CharMap

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)

addTo

public char addTo(byte key,
                  char value)

Description copied from interface: Byte2CharMap

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.

subFrom

public char subFrom(byte key,
                    char value)

Description copied from interface: Byte2CharMap

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

remove

public char remove(byte key)

Description copied from interface: Byte2CharMap

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

removeOrDefault

public char removeOrDefault(byte key,
                            char defaultValue)

Description copied from interface: Byte2CharMap

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)

remove

public boolean remove(byte key,
                      char value)

Description copied from interface: Byte2CharMap

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)

get

public char get(byte key)

Description copied from interface: Byte2CharMap

A Type Specific get method to reduce boxing/unboxing

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

getOrDefault

public char getOrDefault(byte key,
                         char defaultValue)

Description copied from interface: Byte2CharMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Byte2CharMap

Overrides:

getOrDefault in class AbstractByte2CharMap

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

computeChar

public char computeChar(byte key,
                        ByteCharUnaryOperator mappingFunction)

Description copied from interface: Byte2CharMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeChar in interface Byte2CharMap

Overrides:

computeChar in class AbstractByte2CharMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeCharIfAbsent

public char computeCharIfAbsent(byte key,
                                Byte2CharFunction mappingFunction)

Description copied from interface: Byte2CharMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeCharIfAbsent in interface Byte2CharMap

Overrides:

computeCharIfAbsent in class AbstractByte2CharMap

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

computeCharIfPresent

public char computeCharIfPresent(byte key,
                                 ByteCharUnaryOperator mappingFunction)

Description copied from interface: Byte2CharMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeCharIfPresent in interface Byte2CharMap

Overrides:

computeCharIfPresent in class AbstractByte2CharMap

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

supplyCharIfAbsent

public char supplyCharIfAbsent(byte key,
                               CharSupplier valueProvider)

Description copied from interface: Byte2CharMap

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

Specified by:

supplyCharIfAbsent in interface Byte2CharMap

Overrides:

supplyCharIfAbsent in class AbstractByte2CharMap

Parameters:

key - the key that should be computed

valueProvider - the value if not present

Returns:

the result of the computed value or present value

mergeChar

public char mergeChar(byte key,
                      char value,
                      CharCharUnaryOperator mappingFunction)

Description copied from interface: Byte2CharMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeChar in interface Byte2CharMap

Overrides:

mergeChar in class AbstractByte2CharMap

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

mergeAllChar

public void mergeAllChar(Byte2CharMap m,
                         CharCharUnaryOperator mappingFunction)

Description copied from interface: Byte2CharMap

A Bulk method for merging Maps.

Specified by:

mergeAllChar in interface Byte2CharMap

Overrides:

mergeAllChar in class AbstractByte2CharMap

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

copy

public Byte2CharMaps.SingletonMap copy()

Description copied from interface: Byte2CharMap

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 Byte2CharMap

Overrides:

copy in class AbstractByte2CharMap

Returns:

a Shallow Copy of the Map

keySet

public ByteSet keySet()

Specified by:

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

Specified by:

keySet in interface Byte2CharMap

Overrides:

keySet in class AbstractByte2CharMap

values

public CharCollection values()

Specified by:

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

Specified by:

values in interface Byte2CharMap

Overrides:

values in class AbstractByte2CharMap

byte2CharEntrySet

public ObjectSet<Byte2CharMap.Entry> byte2CharEntrySet()

Description copied from interface: Byte2CharMap

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

Returns:

a EntrySet of the collection