speiger.src.collections.ints.maps.abstracts

Class AbstractInt2ObjectMap<V>

java.lang.Object

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

speiger.src.collections.ints.maps.abstracts.AbstractInt2ObjectMap<V>

Type Parameters:

V - the keyType of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.IntFunction<V>, java.util.Map<java.lang.Integer,V>, Int2ObjectMap<V>

Direct Known Subclasses:

ImmutableInt2ObjectOpenHashMap, Int2ObjectArrayMap, Int2ObjectAVLTreeMap, Int2ObjectConcurrentOpenHashMap, Int2ObjectMaps.EmptyMap, Int2ObjectMaps.SingletonMap, Int2ObjectMaps.SynchronizedMap, Int2ObjectMaps.UnmodifyableMap, Int2ObjectOpenCustomHashMap, Int2ObjectOpenHashMap, Int2ObjectRBTreeMap

public abstract class AbstractInt2ObjectMap<V>
extends java.util.AbstractMap<java.lang.Integer,V>
implements Int2ObjectMap<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	AbstractInt2ObjectMap.BasicEntry<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.ints.maps.interfaces.Int2ObjectMap

Int2ObjectMap.BuilderCache<V>, Int2ObjectMap.Entry<V>, Int2ObjectMap.FastEntrySet<V>, Int2ObjectMap.MapBuilder

Constructor Summary

Constructors

Constructor and Description
AbstractInt2ObjectMap()

Method Summary

Modifier and Type	Method and Description
V	compute(int key, IntObjectUnaryOperator<V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
V	computeIfAbsent(int key, IntFunction<V> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
V	computeIfPresent(int key, IntObjectUnaryOperator<V> 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(java.lang.Object value)
Int2ObjectMap<V>	copy() A Function that does a shallow clone of the Map itself.
ObjectSet<java.util.Map.Entry<java.lang.Integer,V>>	entrySet()
boolean	equals(java.lang.Object o)
void	forEach(IntObjectConsumer<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(int key, V defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
V	getOrDefault(java.lang.Object key, V defaultValue)
int	hashCode()
IntSet	keySet()
V	merge(int key, V value, ObjectObjectUnaryOperator<V,V> mappingFunction) A Type Specific merge method to reduce boxing/unboxing
void	mergeAll(Int2ObjectMap<V> m, ObjectObjectUnaryOperator<V,V> mappingFunction) A Bulk method for merging Maps.
V	put(java.lang.Integer key, V value) Deprecated.
void	putAll(int[] 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	putAll(Int2ObjectMap<V> m) Type Specific function for the bull putting of values
void	putAll(java.lang.Integer[] keys, V[] 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 V> m)
void	putAllIfAbsent(Int2ObjectMap<V> m) Type-Specific bulk put method put elements into the map if not present.
V	remove(java.lang.Object key)
V	replace(int key, V value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(int key, V oldValue, V newValue) A Type Specific replace method to replace an existing value
void	replaceObjects(Int2ObjectMap<V> m) Type-Specific bulk replace method.
void	replaceObjects(IntObjectUnaryOperator<V> mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
AbstractInt2ObjectMap<V>	setDefaultReturnValue(V v) Method to define the default return value if a requested key isn't present
V	supplyIfAbsent(int 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 java.util.AbstractMap

clear, containsKey, 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.Int2ObjectMap

apply, builder, compute, computeIfAbsent, computeIfPresent, containsKey, forEach, get, int2ObjectEntrySet, merge, put, put, put, putAll, putAll, putIfAbsent, putIfAbsent, remove, remove, remove, removeOrDefault, replace, replace, replaceAll, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Map

clear, isEmpty, size

Constructor Detail

AbstractInt2ObjectMap

public AbstractInt2ObjectMap()

Method Detail

getDefaultReturnValue

public V getDefaultReturnValue()

Description copied from interface: Int2ObjectMap

Method to see what the default return value is.

Specified by:

getDefaultReturnValue in interface Int2ObjectMap<V>

Returns:

default return value

setDefaultReturnValue

public AbstractInt2ObjectMap<V> setDefaultReturnValue(V v)

Description copied from interface: Int2ObjectMap

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

Specified by:

setDefaultReturnValue in interface Int2ObjectMap<V>

Parameters:

v - value that should be the default return value

Returns:

itself

copy

public Int2ObjectMap<V> copy()

Description copied from interface: Int2ObjectMap

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 Int2ObjectMap<V>

Returns:

a Shallow Copy of the Map

put

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

Deprecated.

Specified by:

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

Specified by:

put in interface Int2ObjectMap<V>

Overrides:

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

putAll

public void putAll(Int2ObjectMap<V> m)

Description copied from interface: Int2ObjectMap

Type Specific function for the bull putting of values

Specified by:

putAll in interface Int2ObjectMap<V>

Parameters:

m - the elements that should be inserted

putAll

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

Specified by:

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

Overrides:

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

putAll

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

Description copied from interface: Int2ObjectMap

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

Specified by:

putAll in interface Int2ObjectMap<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)

putAll

public void putAll(java.lang.Integer[] keys,
                   V[] values,
                   int offset,
                   int size)

Description copied from interface: Int2ObjectMap

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

Specified by:

putAll in interface Int2ObjectMap<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(Int2ObjectMap<V> m)

Description copied from interface: Int2ObjectMap

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

Specified by:

putAllIfAbsent in interface Int2ObjectMap<V>

Parameters:

m - elements that should be added if not present.

containsKey

public boolean containsKey(int key)

Description copied from interface: Int2ObjectMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsKey in interface Int2ObjectMap<V>

Parameters:

key - element that is searched for

Returns:

if the key is present

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<java.lang.Integer,V>

Overrides:

containsValue in class java.util.AbstractMap<java.lang.Integer,V>

replace

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

Description copied from interface: Int2ObjectMap

A Type Specific replace method to replace an existing value

Specified by:

replace in interface Int2ObjectMap<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(int key,
                 V value)

Description copied from interface: Int2ObjectMap

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

Specified by:

replace in interface Int2ObjectMap<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(Int2ObjectMap<V> m)

Description copied from interface: Int2ObjectMap

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

Specified by:

replaceObjects in interface Int2ObjectMap<V>

Parameters:

m - elements that should be replaced.

replaceObjects

public void replaceObjects(IntObjectUnaryOperator<V> mappingFunction)

Description copied from interface: Int2ObjectMap

A Type Specific mass replace method to reduce boxing/unboxing

Specified by:

replaceObjects in interface Int2ObjectMap<V>

Parameters:

mappingFunction - operation to replace all values

compute

public V compute(int key,
                 IntObjectUnaryOperator<V> mappingFunction)

Description copied from interface: Int2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

compute in interface Int2ObjectMap<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(int key,
                         IntFunction<V> mappingFunction)

Description copied from interface: Int2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIfAbsent in interface Int2ObjectMap<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(int key,
                        ObjectSupplier<V> valueProvider)

Description copied from interface: Int2ObjectMap

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

Specified by:

supplyIfAbsent in interface Int2ObjectMap<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(int key,
                          IntObjectUnaryOperator<V> mappingFunction)

Description copied from interface: Int2ObjectMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeIfPresent in interface Int2ObjectMap<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(int key,
               V value,
               ObjectObjectUnaryOperator<V,V> mappingFunction)

Description copied from interface: Int2ObjectMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

merge in interface Int2ObjectMap<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(Int2ObjectMap<V> m,
                     ObjectObjectUnaryOperator<V,V> mappingFunction)

Description copied from interface: Int2ObjectMap

A Bulk method for merging Maps.

Specified by:

mergeAll in interface Int2ObjectMap<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<java.lang.Integer,V>

Specified by:

get in interface Int2ObjectMap<V>

Overrides:

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

getOrDefault

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

Specified by:

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

Specified by:

getOrDefault in interface Int2ObjectMap<V>

getOrDefault

public V getOrDefault(int key,
                      V defaultValue)

Description copied from interface: Int2ObjectMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Int2ObjectMap<V>

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

Specified by:

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

Specified by:

remove in interface Int2ObjectMap<V>

Overrides:

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

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(IntObjectConsumer<V> action)

Description copied from interface: Int2ObjectMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Int2ObjectMap<V>

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

Specified by:

keySet in interface Int2ObjectMap<V>

Overrides:

keySet in class java.util.AbstractMap<java.lang.Integer,V>

values

public ObjectCollection<V> values()

Specified by:

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

Specified by:

values in interface Int2ObjectMap<V>

Overrides:

values in class java.util.AbstractMap<java.lang.Integer,V>

entrySet

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

Specified by:

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

Specified by:

entrySet in interface Int2ObjectMap<V>

Specified by:

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

equals

public boolean equals(java.lang.Object o)

Specified by:

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

Overrides:

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

hashCode

public int hashCode()

Specified by:

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

Overrides:

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