speiger.src.collections.shorts.maps.abstracts

Class AbstractShort2CharMap

java.lang.Object

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

speiger.src.collections.shorts.maps.abstracts.AbstractShort2CharMap

All Implemented Interfaces:

java.util.Map<java.lang.Short,java.lang.Character>, Short2CharFunction, Short2CharMap

Direct Known Subclasses:

ImmutableShort2CharOpenHashMap, Short2CharArrayMap, Short2CharAVLTreeMap, Short2CharConcurrentOpenHashMap, Short2CharMaps.EmptyMap, Short2CharMaps.SingletonMap, Short2CharMaps.SynchronizedMap, Short2CharMaps.UnmodifyableMap, Short2CharOpenCustomHashMap, Short2CharOpenHashMap, Short2CharRBTreeMap

public abstract class AbstractShort2CharMap
extends java.util.AbstractMap<java.lang.Short,java.lang.Character>
implements Short2CharMap

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

Short2CharMap.BuilderCache, Short2CharMap.Entry, Short2CharMap.FastEntrySet, Short2CharMap.MapBuilder

Constructor Summary

Constructors

Constructor and Description
AbstractShort2CharMap()

Method Summary

Modifier and Type	Method and Description
void	addToAll(Short2CharMap m) A Helper method to bulk add primitives together.
char	computeChar(short key, ShortCharUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
char	computeCharIfAbsent(short key, Short2CharFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
char	computeCharIfPresent(short key, ShortCharUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	containsKey(short key) Type Specific method to reduce boxing/unboxing of values
boolean	containsValue(char value) Type Specific method to reduce boxing/unboxing of values
Short2CharMap	copy() A Function that does a shallow clone of the Map itself.
ObjectSet<java.util.Map.Entry<java.lang.Short,java.lang.Character>>	entrySet()
boolean	equals(java.lang.Object o)
void	forEach(ShortCharConsumer 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.
java.lang.Character	getOrDefault(java.lang.Object key, java.lang.Character defaultValue)
char	getOrDefault(short key, char defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
int	hashCode()
ShortSet	keySet()
void	mergeAllChar(Short2CharMap m, CharCharUnaryOperator mappingFunction) A Bulk method for merging Maps.
char	mergeChar(short key, char value, CharCharUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
java.lang.Character	put(java.lang.Short key, java.lang.Character value) Deprecated.
void	putAll(java.util.Map<? extends java.lang.Short,? extends java.lang.Character> m)
void	putAll(short[] 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(java.lang.Short[] 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(Short2CharMap m) Type Specific function for the bull putting of values
void	putAllIfAbsent(Short2CharMap m) Type-Specific bulk put method put elements into the map if not present.
java.lang.Character	remove(java.lang.Object key)
char	replace(short key, char value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(short key, char oldValue, char newValue) A Type Specific replace method to replace an existing value
void	replaceChars(Short2CharMap m) Type-Specific bulk replace method.
void	replaceChars(ShortCharUnaryOperator mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
AbstractShort2CharMap	setDefaultReturnValue(char v) Method to define the default return value if a requested key isn't present
char	supplyCharIfAbsent(short 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.shorts.maps.interfaces.Short2CharMap

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

Methods inherited from interface java.util.Map

clear, isEmpty, size

Constructor Detail

AbstractShort2CharMap

public AbstractShort2CharMap()

Method Detail

getDefaultReturnValue

public char getDefaultReturnValue()

Description copied from interface: Short2CharMap

Method to see what the default return value is.

Specified by:

getDefaultReturnValue in interface Short2CharMap

Returns:

default return value

setDefaultReturnValue

public AbstractShort2CharMap setDefaultReturnValue(char v)

Description copied from interface: Short2CharMap

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

Specified by:

setDefaultReturnValue in interface Short2CharMap

Parameters:

v - value that should be the default return value

Returns:

itself

copy

public Short2CharMap copy()

Description copied from interface: Short2CharMap

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 Short2CharMap

Returns:

a Shallow Copy of the Map

put

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

Deprecated.

Specified by:

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

Specified by:

put in interface Short2CharMap

Overrides:

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

addToAll

public void addToAll(Short2CharMap m)

Description copied from interface: Short2CharMap

A Helper method to bulk add primitives together.

Specified by:

addToAll in interface Short2CharMap

Parameters:

m - the values that should be added/inserted

putAll

public void putAll(Short2CharMap m)

Description copied from interface: Short2CharMap

Type Specific function for the bull putting of values

Specified by:

putAll in interface Short2CharMap

Parameters:

m - the elements that should be inserted

putAll

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

Specified by:

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

Overrides:

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

putAll

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

Description copied from interface: Short2CharMap

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

Specified by:

putAll in interface Short2CharMap

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

Description copied from interface: Short2CharMap

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

Specified by:

putAll in interface Short2CharMap

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

Description copied from interface: Short2CharMap

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

Specified by:

putAllIfAbsent in interface Short2CharMap

Parameters:

m - elements that should be added if not present.

containsKey

public boolean containsKey(short key)

Description copied from interface: Short2CharMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsKey in interface Short2CharMap

Parameters:

key - element that is searched for

Returns:

if the key is present

containsValue

public boolean containsValue(char value)

Description copied from interface: Short2CharMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsValue in interface Short2CharMap

Parameters:

value - element that is searched for

Returns:

if the value is present

replace

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

Description copied from interface: Short2CharMap

A Type Specific replace method to replace an existing value

Specified by:

replace in interface Short2CharMap

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

Description copied from interface: Short2CharMap

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

Specified by:

replace in interface Short2CharMap

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

Description copied from interface: Short2CharMap

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

Specified by:

replaceChars in interface Short2CharMap

Parameters:

m - elements that should be replaced.

replaceChars

public void replaceChars(ShortCharUnaryOperator mappingFunction)

Description copied from interface: Short2CharMap

A Type Specific mass replace method to reduce boxing/unboxing

Specified by:

replaceChars in interface Short2CharMap

Parameters:

mappingFunction - operation to replace all values

computeChar

public char computeChar(short key,
                        ShortCharUnaryOperator mappingFunction)

Description copied from interface: Short2CharMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeChar in interface Short2CharMap

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(short key,
                                Short2CharFunction mappingFunction)

Description copied from interface: Short2CharMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeCharIfAbsent in interface Short2CharMap

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

Description copied from interface: Short2CharMap

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

Specified by:

supplyCharIfAbsent in interface Short2CharMap

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(short key,
                                 ShortCharUnaryOperator mappingFunction)

Description copied from interface: Short2CharMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeCharIfPresent in interface Short2CharMap

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

Description copied from interface: Short2CharMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeChar in interface Short2CharMap

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

Description copied from interface: Short2CharMap

A Bulk method for merging Maps.

Specified by:

mergeAllChar in interface Short2CharMap

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

Specified by:

get in interface Short2CharMap

Overrides:

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

Specified by:

getOrDefault in interface Short2CharMap

getOrDefault

public char getOrDefault(short key,
                         char defaultValue)

Description copied from interface: Short2CharMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Short2CharMap

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

Specified by:

remove in interface Short2CharMap

Overrides:

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

Description copied from interface: Short2CharMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Short2CharMap

Parameters:

action - processor of the values that are iterator over

keySet

public ShortSet keySet()

Specified by:

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

Specified by:

keySet in interface Short2CharMap

Overrides:

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

values

public CharCollection values()

Specified by:

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

Specified by:

values in interface Short2CharMap

Overrides:

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

entrySet

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

Specified by:

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

Specified by:

entrySet in interface Short2CharMap

Specified by:

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

equals

public boolean equals(java.lang.Object o)

Specified by:

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

Overrides:

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

hashCode

public int hashCode()

Specified by:

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

Overrides:

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