speiger.src.collections.objects.maps.abstracts

Class AbstractObject2ObjectMap<T,V>

java.lang.Object

java.util.AbstractMap<T,V>

speiger.src.collections.objects.maps.abstracts.AbstractObject2ObjectMap<T,V>

Type Parameters:

T - the type of elements maintained by this Collection

V - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.Function<T,V>, java.util.Map<T,V>, Object2ObjectFunction<T,V>, Object2ObjectMap<T,V>

Direct Known Subclasses:

Enum2ObjectMap, Object2ObjectArrayMap, Object2ObjectAVLTreeMap, Object2ObjectMaps.EmptyMap, Object2ObjectMaps.SingletonMap, Object2ObjectMaps.SynchronizedMap, Object2ObjectMaps.UnmodifyableMap, Object2ObjectOpenCustomHashMap, Object2ObjectOpenHashMap, Object2ObjectRBTreeMap

public abstract class AbstractObject2ObjectMap<T,V>
extends java.util.AbstractMap<T,V>
implements Object2ObjectMap<T,V>

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	AbstractObject2ObjectMap.BasicEntry<T,V> 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.objects.maps.interfaces.Object2ObjectMap

Object2ObjectMap.Entry<T,V>, Object2ObjectMap.FastEntrySet<T,V>

Constructor Summary

Constructors

Constructor and Description
AbstractObject2ObjectMap()

Method Summary

Modifier and Type	Method and Description
V	compute(T key, ObjectObjectUnaryOperator<T,V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
V	computeIfAbsent(T key, Object2ObjectFunction<T,V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
V	computeIfPresent(T key, ObjectObjectUnaryOperator<T,V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
ObjectSet<java.util.Map.Entry<T,V>>	entrySet()
boolean	equals(java.lang.Object o)
void	forEach(ObjectObjectConsumer<T,V> action) Type Specific forEach method to reduce boxing/unboxing
V	get(java.lang.Object key)
V	getDefaultReturnValue() Method to see what the default return value is.
V	getOrDefault(java.lang.Object key, V defaultValue)
int	hashCode()
ObjectSet<T>	keySet()
V	merge(T key, V value, ObjectObjectUnaryOperator<V,V> mappingFunction) A Type Specific merge method to reduce boxing/unboxing
void	mergeAll(Object2ObjectMap<T,V> m, ObjectObjectUnaryOperator<V,V> mappingFunction) A Bulk method for merging Maps.
void	putAll(java.util.Map<? extends T,? extends V> m)
void	putAll(Object2ObjectMap<T,V> m) Type Specific function for the bull putting of values
void	putAll(T[] keys, V[] values, int offset, int size) Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
void	putAllIfAbsent(Object2ObjectMap<T,V> m) Type-Specific bulk put method put elements into the map if not present.
V	replace(T key, V value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(T key, V oldValue, V newValue) A Type Specific replace method to replace an existing value
void	replaceObjects(Object2ObjectMap<T,V> m) Type-Specific bulk replace method.
void	replaceObjects(ObjectObjectUnaryOperator<T,V> mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
AbstractObject2ObjectMap<T,V>	setDefaultReturnValue(V v) Method to define the default return value if a requested key isn't present
ObjectCollection<V>	values()

Methods inherited from class java.util.AbstractMap

clear, isEmpty, put, remove, size, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.objects.maps.interfaces.Object2ObjectMap

compute, computeIfAbsent, computeIfPresent, forEach, merge, object2ObjectEntrySet, put, putAll, putIfAbsent, rem, remOrDefault, remove, replaceAll

Methods inherited from interface java.util.Map

clear, isEmpty, remove, size

Methods inherited from interface speiger.src.collections.objects.functions.function.Object2ObjectFunction

apply, getObject

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Constructor Detail

AbstractObject2ObjectMap

public AbstractObject2ObjectMap()

Method Detail

getDefaultReturnValue

public V getDefaultReturnValue()

Description copied from interface: Object2ObjectMap

Method to see what the default return value is.

Specified by:

getDefaultReturnValue in interface Object2ObjectMap<T,V>

Returns:

default return value

setDefaultReturnValue

public AbstractObject2ObjectMap<T,V> setDefaultReturnValue(V v)

Description copied from interface: Object2ObjectMap

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

Specified by:

setDefaultReturnValue in interface Object2ObjectMap<T,V>

Parameters:

v - value that should be the default return value

Returns:

itself

putAll

public void putAll(Object2ObjectMap<T,V> m)

Description copied from interface: Object2ObjectMap

Type Specific function for the bull putting of values

Specified by:

putAll in interface Object2ObjectMap<T,V>

Parameters:

m - the elements that should be inserted

putAll

public void putAll(java.util.Map<? extends T,? extends V> m)

Specified by:

putAll in interface java.util.Map<T,V>

Overrides:

putAll in class java.util.AbstractMap<T,V>

putAll

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

Description copied from interface: Object2ObjectMap

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

Specified by:

putAll in interface Object2ObjectMap<T,V>

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(Object2ObjectMap<T,V> m)

Description copied from interface: Object2ObjectMap

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

Specified by:

putAllIfAbsent in interface Object2ObjectMap<T,V>

Parameters:

m - elements that should be added if not present.

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<T,V>

Overrides:

containsKey in class java.util.AbstractMap<T,V>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<T,V>

Overrides:

containsValue in class java.util.AbstractMap<T,V>

replace

public boolean replace(T key,
                       V oldValue,
                       V newValue)

Description copied from interface: Object2ObjectMap

A Type Specific replace method to replace an existing value

Specified by:

replace in interface java.util.Map<T,V>

Specified by:

replace in interface Object2ObjectMap<T,V>

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 V replace(T key,
                 V value)

Description copied from interface: Object2ObjectMap

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

Specified by:

replace in interface java.util.Map<T,V>

Specified by:

replace in interface Object2ObjectMap<T,V>

Parameters:

key - the element that should be searched for

value - the value to replace with.

Returns:

the present value or default return value

replaceObjects

public void replaceObjects(Object2ObjectMap<T,V> m)

Description copied from interface: Object2ObjectMap

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

Specified by:

replaceObjects in interface Object2ObjectMap<T,V>

Parameters:

m - elements that should be replaced.

replaceObjects

public void replaceObjects(ObjectObjectUnaryOperator<T,V> mappingFunction)

Description copied from interface: Object2ObjectMap

A Type Specific mass replace method to reduce boxing/unboxing

Specified by:

replaceObjects in interface Object2ObjectMap<T,V>

Parameters:

mappingFunction - operation to replace all values

compute

public V compute(T key,
                 ObjectObjectUnaryOperator<T,V> mappingFunction)

Description copied from interface: Object2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

compute in interface Object2ObjectMap<T,V>

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeIfAbsent

public V computeIfAbsent(T key,
                         Object2ObjectFunction<T,V> mappingFunction)

Description copied from interface: Object2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIfAbsent in interface Object2ObjectMap<T,V>

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

computeIfPresent

public V computeIfPresent(T key,
                          ObjectObjectUnaryOperator<T,V> mappingFunction)

Description copied from interface: Object2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIfPresent in interface Object2ObjectMap<T,V>

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

merge

public V merge(T key,
               V value,
               ObjectObjectUnaryOperator<V,V> mappingFunction)

Description copied from interface: Object2ObjectMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

merge in interface Object2ObjectMap<T,V>

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

mergeAll

public void mergeAll(Object2ObjectMap<T,V> m,
                     ObjectObjectUnaryOperator<V,V> mappingFunction)

Description copied from interface: Object2ObjectMap

A Bulk method for merging Maps.

Specified by:

mergeAll in interface Object2ObjectMap<T,V>

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

get

public V get(java.lang.Object key)

Specified by:

get in interface java.util.Map<T,V>

Overrides:

get in class java.util.AbstractMap<T,V>

getOrDefault

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

Specified by:

getOrDefault in interface java.util.Map<T,V>

forEach

public void forEach(ObjectObjectConsumer<T,V> action)

Description copied from interface: Object2ObjectMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Object2ObjectMap<T,V>

Parameters:

action - processor of the values that are iterator over

keySet

public ObjectSet<T> keySet()

Specified by:

keySet in interface java.util.Map<T,V>

Specified by:

keySet in interface Object2ObjectMap<T,V>

Overrides:

keySet in class java.util.AbstractMap<T,V>

values

public ObjectCollection<V> values()

Specified by:

values in interface java.util.Map<T,V>

Specified by:

values in interface Object2ObjectMap<T,V>

Overrides:

values in class java.util.AbstractMap<T,V>

entrySet

public ObjectSet<java.util.Map.Entry<T,V>> entrySet()

Specified by:

entrySet in interface java.util.Map<T,V>

Specified by:

entrySet in interface Object2ObjectMap<T,V>

Specified by:

entrySet in class java.util.AbstractMap<T,V>

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.Map<T,V>

Overrides:

equals in class java.util.AbstractMap<T,V>

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map<T,V>

Overrides:

hashCode in class java.util.AbstractMap<T,V>