speiger.src.collections.ints.utils.maps

Class Int2CharMaps.UnmodifyableMap

java.lang.Object

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

speiger.src.collections.ints.maps.abstracts.AbstractInt2CharMap

speiger.src.collections.ints.utils.maps.Int2CharMaps.UnmodifyableMap

All Implemented Interfaces:

java.util.Map<java.lang.Integer,java.lang.Character>, Int2CharFunction, Int2CharMap

Direct Known Subclasses:

Int2CharMaps.UnmodifyableOrderedMap, Int2CharMaps.UnmodifyableSortedMap

Enclosing class:

Int2CharMaps

public static class Int2CharMaps.UnmodifyableMap
extends AbstractInt2CharMap
implements Int2CharMap

The Unmodifyable Map implementation that is sued for the unmodifyableMap function

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.ints.maps.abstracts.AbstractInt2CharMap

AbstractInt2CharMap.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.ints.maps.interfaces.Int2CharMap

Int2CharMap.BuilderCache, Int2CharMap.Entry, Int2CharMap.FastEntrySet, Int2CharMap.MapBuilder

Method Summary

Modifier and Type	Method and Description
char	addTo(int key, char value) A Helper method to add a primitives together.
void	clear()
char	computeChar(int key, IntCharUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
char	computeCharIfAbsent(int key, Int2CharFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
char	computeCharIfPresent(int key, IntCharUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
Int2CharMap	copy() A Function that does a shallow clone of the Map itself.
char	get(int key) A Type Specific get method to reduce boxing/unboxing
char	getOrDefault(int key, char defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
ObjectSet<Int2CharMap.Entry>	int2CharEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
IntSet	keySet()
void	mergeAllChar(Int2CharMap m, CharCharUnaryOperator mappingFunction) A Bulk method for merging Maps.
char	mergeChar(int key, char value, CharCharUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
char	put(int key, char value) Type Specific method to reduce boxing/unboxing of values
char	putIfAbsent(int key, char value) Type Specific method to reduce boxing/unboxing of values
char	remove(int key) Type Specific remove function to reduce boxing/unboxing
boolean	remove(int key, char value) Type Specific remove function to reduce boxing/unboxing
char	removeOrDefault(int key, char defaultValue) Type-Specific Remove function with a default return value if wanted.
void	replaceChars(Int2CharMap m) Type-Specific bulk replace method.
void	replaceChars(IntCharUnaryOperator mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
char	subFrom(int key, char value) A Helper method to subtract from primitive from each other.
char	supplyCharIfAbsent(int 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.ints.maps.abstracts.AbstractInt2CharMap

addToAll, 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.ints.maps.interfaces.Int2CharMap

addToAll, 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 char put(int key,
                char value)

Description copied from interface: Int2CharMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

put in interface Int2CharMap

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

Description copied from interface: Int2CharMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

putIfAbsent in interface Int2CharMap

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

Description copied from interface: Int2CharMap

A Helper method to add a primitives together. If key is not present then this functions as a put.

Specified by:

addTo in interface Int2CharMap

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

Description copied from interface: Int2CharMap

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 Int2CharMap.getDefaultReturnValue() If the fence is reached the element will be automaticall removed

Specified by:

subFrom in interface Int2CharMap

Parameters:

key - that should be subtract from

value - that should be subtract

Returns:

the last present or default return value

remove

public char remove(int key)

Description copied from interface: Int2CharMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Int2CharMap

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

removeOrDefault

public char removeOrDefault(int key,
                            char defaultValue)

Description copied from interface: Int2CharMap

Type-Specific Remove function with a default return value if wanted.

Specified by:

removeOrDefault in interface Int2CharMap

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

Description copied from interface: Int2CharMap

Type Specific remove function to reduce boxing/unboxing

Specified by:

remove in interface Int2CharMap

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(int key)

Description copied from interface: Int2CharMap

A Type Specific get method to reduce boxing/unboxing

Specified by:

get in interface Int2CharFunction

Specified by:

get in interface Int2CharMap

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

getOrDefault

public char getOrDefault(int key,
                         char defaultValue)

Description copied from interface: Int2CharMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Int2CharMap

Overrides:

getOrDefault in class AbstractInt2CharMap

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(int key,
                        IntCharUnaryOperator mappingFunction)

Description copied from interface: Int2CharMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeChar in interface Int2CharMap

Overrides:

computeChar in class AbstractInt2CharMap

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(int key,
                                Int2CharFunction mappingFunction)

Description copied from interface: Int2CharMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeCharIfAbsent in interface Int2CharMap

Overrides:

computeCharIfAbsent in class AbstractInt2CharMap

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(int key,
                                 IntCharUnaryOperator mappingFunction)

Description copied from interface: Int2CharMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeCharIfPresent in interface Int2CharMap

Overrides:

computeCharIfPresent in class AbstractInt2CharMap

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(int key,
                               CharSupplier valueProvider)

Description copied from interface: Int2CharMap

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

Specified by:

supplyCharIfAbsent in interface Int2CharMap

Overrides:

supplyCharIfAbsent in class AbstractInt2CharMap

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(int key,
                      char value,
                      CharCharUnaryOperator mappingFunction)

Description copied from interface: Int2CharMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeChar in interface Int2CharMap

Overrides:

mergeChar in class AbstractInt2CharMap

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(Int2CharMap m,
                         CharCharUnaryOperator mappingFunction)

Description copied from interface: Int2CharMap

A Bulk method for merging Maps.

Specified by:

mergeAllChar in interface Int2CharMap

Overrides:

mergeAllChar in class AbstractInt2CharMap

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

replaceChars

public void replaceChars(IntCharUnaryOperator mappingFunction)

Description copied from interface: Int2CharMap

A Type Specific mass replace method to reduce boxing/unboxing

Specified by:

replaceChars in interface Int2CharMap

Overrides:

replaceChars in class AbstractInt2CharMap

Parameters:

mappingFunction - operation to replace all values

replaceChars

public void replaceChars(Int2CharMap m)

Description copied from interface: Int2CharMap

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

Specified by:

replaceChars in interface Int2CharMap

Overrides:

replaceChars in class AbstractInt2CharMap

Parameters:

m - elements that should be replaced.

copy

public Int2CharMap copy()

Description copied from interface: Int2CharMap

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 Int2CharMap

Overrides:

copy in class AbstractInt2CharMap

Returns:

a Shallow Copy of the Map

clear

public void clear()

Specified by:

clear in interface java.util.Map<java.lang.Integer,java.lang.Character>

Overrides:

clear in class java.util.AbstractMap<java.lang.Integer,java.lang.Character>

keySet

public IntSet keySet()

Specified by:

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

Specified by:

keySet in interface Int2CharMap

Overrides:

keySet in class AbstractInt2CharMap

values

public CharCollection values()

Specified by:

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

Specified by:

values in interface Int2CharMap

Overrides:

values in class AbstractInt2CharMap

int2CharEntrySet

public ObjectSet<Int2CharMap.Entry> int2CharEntrySet()

Description copied from interface: Int2CharMap

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

Specified by:

int2CharEntrySet in interface Int2CharMap

Returns:

a EntrySet of the collection