speiger.src.collections.objects.maps.impl.misc

Class Enum2ObjectMap<T extends java.lang.Enum<T>,V>

java.lang.Object

java.util.AbstractMap<T,V>

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

speiger.src.collections.objects.maps.impl.misc.Enum2ObjectMap<T,V>

Type Parameters:

T - the keyType of elements maintained by this Collection

V - the keyType of elements maintained by this Collection

All Implemented Interfaces:

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

Direct Known Subclasses:

LinkedEnum2ObjectMap

public class Enum2ObjectMap<T extends java.lang.Enum<T>,V>
extends AbstractObject2ObjectMap<T,V>

A Type Specific EnumMap implementation that allows for Primitive Values. Unlike javas implementation this one does not jump around between a single long or long array implementation based around the enum size This will cause a bit more memory usage but allows for a simpler implementation.

Nested Class Summary

Nested classes/interfaces inherited from class speiger.src.collections.objects.maps.abstracts.AbstractObject2ObjectMap

AbstractObject2ObjectMap.BasicEntry<T,V>

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.BuilderCache<T,V>, Object2ObjectMap.Entry<T,V>, Object2ObjectMap.FastEntrySet<T,V>, Object2ObjectMap.MapBuilder

Constructor Summary

Constructors

Constructor and Description
Enum2ObjectMap(java.lang.Class<T> keyType) Default Constructor
Enum2ObjectMap(java.util.Map<? extends T,? extends V> map) A Helper constructor that allows to create a EnumMap with exactly the same values as the provided map.
Enum2ObjectMap(Object2ObjectMap<T,V> map) A Type Specific Helper function that allows to create a new EnumMap with exactly the same values as the provided map.
Enum2ObjectMap(T[] keys, V[] values) Helper constructor that allow to create a EnumMap from unboxed values

Method Summary

Modifier and Type	Method and Description
void	clear()
V	compute(T key, ObjectObjectUnaryOperator<T,V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
V	computeIfAbsent(T key, UnaryOperator<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)
Enum2ObjectMap<T,V>	copy() A Function that does a shallow clone of the Map itself.
void	forEach(ObjectObjectConsumer<T,V> action) Type Specific forEach method to reduce boxing/unboxing
V	getObject(T key) A Type Specific get method to reduce boxing/unboxing
V	getOrDefault(java.lang.Object key, V defaultValue)
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.
ObjectSet<Object2ObjectMap.Entry<T,V>>	object2ObjectEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
V	put(T key, V value) Type Specific method to reduce boxing/unboxing of values
V	putIfAbsent(T key, V value) Type Specific method to reduce boxing/unboxing of values
V	rem(T key) Type Specific remove function to reduce boxing/unboxing
V	remOrDefault(T key, V defaultValue) Type-Specific Remove function with a default return value if wanted.
V	remove(java.lang.Object key)
boolean	remove(java.lang.Object key, java.lang.Object value)
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
int	size()
V	supplyIfAbsent(T key, ObjectSupplier<V> valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
ObjectCollection<V>	values()

Methods inherited from class speiger.src.collections.objects.maps.abstracts.AbstractObject2ObjectMap

entrySet, equals, get, getDefaultReturnValue, hashCode, putAll, putAll, putAll, putAllIfAbsent, replaceObjects, replaceObjects, setDefaultReturnValue

Methods inherited from class java.util.AbstractMap

isEmpty, 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

apply, builder, compute, computeIfAbsent, computeIfPresent, forEach, merge, put, putAll, replaceAll, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Map

isEmpty

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

andThen, compose, identity

Methods inherited from interface java.util.function.Function

andThen, compose

Constructor Detail

Enum2ObjectMap

public Enum2ObjectMap(java.lang.Class<T> keyType)

Default Constructor

Parameters:

keyType - the type of Enum that should be used

Enum2ObjectMap

public Enum2ObjectMap(T[] keys,
                      V[] values)

Helper constructor that allow to create a EnumMap from unboxed values

Parameters:

keys - the keys that should be put into the map

values - the values that should be put into the map.

Throws:

java.lang.IllegalStateException - if the keys and values do not match in lenght

Enum2ObjectMap

public Enum2ObjectMap(java.util.Map<? extends T,? extends V> map)

A Helper constructor that allows to create a EnumMap with exactly the same values as the provided map.

Parameters:

map - the values that should be present in the map

Enum2ObjectMap

public Enum2ObjectMap(Object2ObjectMap<T,V> map)

A Type Specific Helper function that allows to create a new EnumMap with exactly the same values as the provided map.

Parameters:

map - the values that should be present in the map

Method Detail

put

public V put(T key,
             V value)

Description copied from interface: Object2ObjectMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

put in interface java.util.Map<T extends java.lang.Enum<T>,V>

Specified by:

put in interface Object2ObjectMap<T extends java.lang.Enum<T>,V>

Overrides:

put in class java.util.AbstractMap<T extends java.lang.Enum<T>,V>

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

Description copied from interface: Object2ObjectMap

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)

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

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

Overrides:

containsKey in class AbstractObject2ObjectMap<T extends java.lang.Enum<T>,V>

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

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

Overrides:

containsValue in class AbstractObject2ObjectMap<T extends java.lang.Enum<T>,V>

remove

public V remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<T extends java.lang.Enum<T>,V>

Specified by:

remove in interface Object2ObjectMap<T extends java.lang.Enum<T>,V>

Overrides:

remove in class AbstractObject2ObjectMap<T extends java.lang.Enum<T>,V>

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

See Also:

Map.remove(Object)

rem

public V rem(T key)

Description copied from interface: Object2ObjectMap

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

remOrDefault

public V remOrDefault(T key,
                      V defaultValue)

Description copied from interface: Object2ObjectMap

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(java.lang.Object key,
                      java.lang.Object value)

getObject

public V getObject(T key)

Description copied from interface: Object2ObjectMap

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 V getOrDefault(java.lang.Object key,
                      V defaultValue)

Specified by:

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

Overrides:

getOrDefault in class AbstractObject2ObjectMap<T extends java.lang.Enum<T>,V>

copy

public Enum2ObjectMap<T,V> copy()

Description copied from interface: Object2ObjectMap

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 Object2ObjectMap<T extends java.lang.Enum<T>,V>

Overrides:

copy in class AbstractObject2ObjectMap<T extends java.lang.Enum<T>,V>

Returns:

a Shallow Copy of the Map

object2ObjectEntrySet

public ObjectSet<Object2ObjectMap.Entry<T,V>> object2ObjectEntrySet()

Description copied from interface: Object2ObjectMap

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

Returns:

a EntrySet of the collection

keySet

public ObjectSet<T> keySet()

Specified by:

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

Specified by:

keySet in interface Object2ObjectMap<T extends java.lang.Enum<T>,V>

Overrides:

keySet in class AbstractObject2ObjectMap<T extends java.lang.Enum<T>,V>

values

public ObjectCollection<V> values()

Specified by:

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

Specified by:

values in interface Object2ObjectMap<T extends java.lang.Enum<T>,V>

Overrides:

values in class AbstractObject2ObjectMap<T extends java.lang.Enum<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 extends java.lang.Enum<T>,V>

Overrides:

forEach in class AbstractObject2ObjectMap<T extends java.lang.Enum<T>,V>

Parameters:

action - processor of the values that are iterator over

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 extends java.lang.Enum<T>,V>

Specified by:

replace in interface Object2ObjectMap<T extends java.lang.Enum<T>,V>

Overrides:

replace in class AbstractObject2ObjectMap<T extends java.lang.Enum<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 extends java.lang.Enum<T>,V>

Specified by:

replace in interface Object2ObjectMap<T extends java.lang.Enum<T>,V>

Overrides:

replace in class AbstractObject2ObjectMap<T extends java.lang.Enum<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

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 extends java.lang.Enum<T>,V>

Overrides:

compute in class AbstractObject2ObjectMap<T extends java.lang.Enum<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,
                         UnaryOperator<T,V> mappingFunction)

Description copied from interface: Object2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIfAbsent in interface Object2ObjectMap<T extends java.lang.Enum<T>,V>

Overrides:

computeIfAbsent in class AbstractObject2ObjectMap<T extends java.lang.Enum<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

supplyIfAbsent

public V supplyIfAbsent(T key,
                        ObjectSupplier<V> valueProvider)

Description copied from interface: Object2ObjectMap

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

Specified by:

supplyIfAbsent in interface Object2ObjectMap<T extends java.lang.Enum<T>,V>

Overrides:

supplyIfAbsent in class AbstractObject2ObjectMap<T extends java.lang.Enum<T>,V>

Parameters:

key - the key that should be computed

valueProvider - 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 extends java.lang.Enum<T>,V>

Overrides:

computeIfPresent in class AbstractObject2ObjectMap<T extends java.lang.Enum<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 extends java.lang.Enum<T>,V>

Overrides:

merge in class AbstractObject2ObjectMap<T extends java.lang.Enum<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 extends java.lang.Enum<T>,V>

Overrides:

mergeAll in class AbstractObject2ObjectMap<T extends java.lang.Enum<T>,V>

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

clear

public void clear()

Specified by:

clear in interface java.util.Map<T extends java.lang.Enum<T>,V>

Overrides:

clear in class java.util.AbstractMap<T extends java.lang.Enum<T>,V>

size

public int size()

Specified by:

size in interface java.util.Map<T extends java.lang.Enum<T>,V>

Overrides:

size in class java.util.AbstractMap<T extends java.lang.Enum<T>,V>