speiger.src.collections.ints.maps.abstracts

Class AbstractInt2CharMap

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ImmutableInt2CharOpenHashMap, Int2CharArrayMap, Int2CharAVLTreeMap, Int2CharConcurrentOpenHashMap, Int2CharMaps.EmptyMap, Int2CharMaps.SingletonMap, Int2CharMaps.SynchronizedMap, Int2CharMaps.UnmodifyableMap, Int2CharOpenCustomHashMap, Int2CharOpenHashMap, Int2CharRBTreeMap

public abstract class AbstractInt2CharMap
extends java.util.AbstractMap<java.lang.Integer,java.lang.Character>
implements Int2CharMap

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

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

Constructor Summary

Constructors

Constructor and Description
AbstractInt2CharMap()

Method Summary

Modifier and Type	Method and Description
void	addToAll(Int2CharMap m) A Helper method to bulk add primitives together.
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
boolean	containsKey(int key) Type Specific method to reduce boxing/unboxing of values
boolean	containsValue(char value) Type Specific method to reduce boxing/unboxing of values
Int2CharMap	copy() A Function that does a shallow clone of the Map itself.
ObjectSet<java.util.Map.Entry<java.lang.Integer,java.lang.Character>>	entrySet()
boolean	equals(java.lang.Object o)
void	forEach(IntCharConsumer action) Type Specific forEach method to reduce boxing/unboxing
java.lang.Character	get(java.lang.Object key)
char	getDefaultReturnValue() Method to see what the default return value is.
char	getOrDefault(int key, char defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
java.lang.Character	getOrDefault(java.lang.Object key, java.lang.Character defaultValue)
int	hashCode()
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
java.lang.Character	put(java.lang.Integer key, java.lang.Character value) Deprecated.
void	putAll(int[] keys, char[] 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(Int2CharMap m) Type Specific function for the bull putting of values
void	putAll(java.lang.Integer[] keys, java.lang.Character[] 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.Integer,? extends java.lang.Character> m)
void	putAllIfAbsent(Int2CharMap m) Type-Specific bulk put method put elements into the map if not present.
java.lang.Character	remove(java.lang.Object key)
char	replace(int key, char value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(int key, char oldValue, char newValue) A Type Specific replace method to replace an existing value
void	replaceChars(Int2CharMap m) Type-Specific bulk replace method.
void	replaceChars(IntCharUnaryOperator mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
AbstractInt2CharMap	setDefaultReturnValue(char v) Method to define the default return value if a requested key isn't present
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 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.ints.maps.interfaces.Int2CharMap

addTo, applyAsChar, builder, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, forEach, get, int2CharEntrySet, merge, put, put, put, putAll, putAll, putIfAbsent, putIfAbsent, remove, remove, remove, removeOrDefault, replace, replace, replaceAll, subFrom, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Map

clear, isEmpty, size

Constructor Detail

AbstractInt2CharMap

public AbstractInt2CharMap()

Method Detail

getDefaultReturnValue

public char getDefaultReturnValue()

Description copied from interface: Int2CharMap

Method to see what the default return value is.

Specified by:

getDefaultReturnValue in interface Int2CharMap

Returns:

default return value

setDefaultReturnValue

public AbstractInt2CharMap setDefaultReturnValue(char v)

Description copied from interface: Int2CharMap

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

Specified by:

setDefaultReturnValue in interface Int2CharMap

Parameters:

v - value that should be the default return value

Returns:

itself

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

Returns:

a Shallow Copy of the Map

put

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

Deprecated.

Specified by:

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

Specified by:

put in interface Int2CharMap

Overrides:

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

addToAll

public void addToAll(Int2CharMap m)

Description copied from interface: Int2CharMap

A Helper method to bulk add primitives together.

Specified by:

addToAll in interface Int2CharMap

Parameters:

m - the values that should be added/inserted

putAll

public void putAll(Int2CharMap m)

Description copied from interface: Int2CharMap

Type Specific function for the bull putting of values

Specified by:

putAll in interface Int2CharMap

Parameters:

m - the elements that should be inserted

putAll

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

Specified by:

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

Overrides:

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

putAll

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

Description copied from interface: Int2CharMap

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

Specified by:

putAll in interface Int2CharMap

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

Description copied from interface: Int2CharMap

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

Specified by:

putAll in interface Int2CharMap

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

Description copied from interface: Int2CharMap

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

Specified by:

putAllIfAbsent in interface Int2CharMap

Parameters:

m - elements that should be added if not present.

containsKey

public boolean containsKey(int key)

Description copied from interface: Int2CharMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsKey in interface Int2CharMap

Parameters:

key - element that is searched for

Returns:

if the key is present

containsValue

public boolean containsValue(char value)

Description copied from interface: Int2CharMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsValue in interface Int2CharMap

Parameters:

value - element that is searched for

Returns:

if the value is present

replace

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

Description copied from interface: Int2CharMap

A Type Specific replace method to replace an existing value

Specified by:

replace in interface Int2CharMap

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

Description copied from interface: Int2CharMap

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

Specified by:

replace in interface Int2CharMap

Parameters:

key - the element that should be searched for

value - the value to replace with.

Returns:

the present value or default return value

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

Parameters:

m - elements that should be replaced.

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

Parameters:

mappingFunction - operation to replace all values

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

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

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

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

Parameters:

key - the key that should be computed

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

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

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

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

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

get

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

Specified by:

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

Specified by:

get in interface Int2CharMap

Overrides:

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

getOrDefault

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

Specified by:

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

Specified by:

getOrDefault in interface Int2CharMap

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

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.Character remove(java.lang.Object key)

Specified by:

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

Specified by:

remove in interface Int2CharMap

Overrides:

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

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(IntCharConsumer action)

Description copied from interface: Int2CharMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Int2CharMap

Parameters:

action - processor of the values that are iterator over

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 java.util.AbstractMap<java.lang.Integer,java.lang.Character>

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 java.util.AbstractMap<java.lang.Integer,java.lang.Character>

entrySet

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

Specified by:

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

Specified by:

entrySet in interface Int2CharMap

Specified by:

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

equals

public boolean equals(java.lang.Object o)

Specified by:

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

Overrides:

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

hashCode

public int hashCode()

Specified by:

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

Overrides:

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