speiger.src.collections.objects.maps.abstracts

Class AbstractObject2LongMap<T>

java.lang.Object

java.util.AbstractMap<T,java.lang.Long>

speiger.src.collections.objects.maps.abstracts.AbstractObject2LongMap<T>

Type Parameters:

T - the type of elements maintained by this Collection

All Implemented Interfaces:

java.util.function.ToLongFunction<T>, java.util.Map<T,java.lang.Long>, Object2LongFunction<T>, Object2LongMap<T>

Direct Known Subclasses:

Enum2LongMap, ImmutableObject2LongOpenHashMap, Object2LongArrayMap, Object2LongAVLTreeMap, Object2LongConcurrentOpenHashMap, Object2LongMaps.EmptyMap, Object2LongMaps.SingletonMap, Object2LongMaps.SynchronizedMap, Object2LongMaps.UnmodifyableMap, Object2LongOpenCustomHashMap, Object2LongOpenHashMap, Object2LongRBTreeMap

public abstract class AbstractObject2LongMap<T>
extends java.util.AbstractMap<T,java.lang.Long>
implements Object2LongMap<T>

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	AbstractObject2LongMap.BasicEntry<T> 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.Object2LongMap

Object2LongMap.BuilderCache<T>, Object2LongMap.Entry<T>, Object2LongMap.FastEntrySet<T>, Object2LongMap.MapBuilder

Constructor Summary

Constructors

Constructor and Description
AbstractObject2LongMap()

Method Summary

Modifier and Type	Method and Description
void	addToAll(Object2LongMap<T> m) A Helper method to bulk add primitives together.
long	computeLong(T key, ObjectLongUnaryOperator<T> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
long	computeLongIfAbsent(T key, Object2LongFunction<T> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
long	computeLongIfPresent(T key, ObjectLongUnaryOperator<T> mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	containsKey(java.lang.Object key)
boolean	containsValue(long value) Type Specific method to reduce boxing/unboxing of values
Object2LongMap<T>	copy() A Function that does a shallow clone of the Map itself.
ObjectSet<java.util.Map.Entry<T,java.lang.Long>>	entrySet()
boolean	equals(java.lang.Object o)
void	forEach(ObjectLongConsumer<T> action) Type Specific forEach method to reduce boxing/unboxing
java.lang.Long	get(java.lang.Object key)
long	getDefaultReturnValue() Method to see what the default return value is.
java.lang.Long	getOrDefault(java.lang.Object key, java.lang.Long defaultValue)
int	hashCode()
ObjectSet<T>	keySet()
void	mergeAllLong(Object2LongMap<T> m, LongLongUnaryOperator mappingFunction) A Bulk method for merging Maps.
long	mergeLong(T key, long value, LongLongUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
java.lang.Long	put(T key, java.lang.Long value) Deprecated.
void	putAll(java.util.Map<? extends T,? extends java.lang.Long> m)
void	putAll(Object2LongMap<T> m) Type Specific function for the bull putting of values
void	putAll(T[] keys, long[] 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(T[] keys, java.lang.Long[] 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	putAllIfAbsent(Object2LongMap<T> m) Type-Specific bulk put method put elements into the map if not present.
java.lang.Long	remove(java.lang.Object key)
long	replace(T key, long value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(T key, long oldValue, long newValue) A Type Specific replace method to replace an existing value
void	replaceLongs(Object2LongMap<T> m) Type-Specific bulk replace method.
void	replaceLongs(ObjectLongUnaryOperator<T> mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
AbstractObject2LongMap<T>	setDefaultReturnValue(long v) Method to define the default return value if a requested key isn't present
long	supplyLongIfAbsent(T key, LongSupplier valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
LongCollection	values()

Methods inherited from class java.util.AbstractMap

clear, containsValue, isEmpty, 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.Object2LongMap

addTo, builder, compute, computeIfAbsent, computeIfPresent, containsValue, forEach, getLong, getOrDefault, merge, object2LongEntrySet, put, putAll, putAll, putIfAbsent, putIfAbsent, rem, remOrDefault, remove, remove, replace, replace, replaceAll, subFrom, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Map

clear, isEmpty, size

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

applyAsLong

Constructor Detail

AbstractObject2LongMap

public AbstractObject2LongMap()

Method Detail

getDefaultReturnValue

public long getDefaultReturnValue()

Description copied from interface: Object2LongMap

Method to see what the default return value is.

Specified by:

getDefaultReturnValue in interface Object2LongMap<T>

Returns:

default return value

setDefaultReturnValue

public AbstractObject2LongMap<T> setDefaultReturnValue(long v)

Description copied from interface: Object2LongMap

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

Specified by:

setDefaultReturnValue in interface Object2LongMap<T>

Parameters:

v - value that should be the default return value

Returns:

itself

copy

public Object2LongMap<T> copy()

Description copied from interface: Object2LongMap

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 Object2LongMap<T>

Returns:

a Shallow Copy of the Map

put

@Deprecated
public java.lang.Long put(T key,
                                       java.lang.Long value)

Deprecated.

Specified by:

put in interface java.util.Map<T,java.lang.Long>

Specified by:

put in interface Object2LongMap<T>

Overrides:

put in class java.util.AbstractMap<T,java.lang.Long>

addToAll

public void addToAll(Object2LongMap<T> m)

Description copied from interface: Object2LongMap

A Helper method to bulk add primitives together.

Specified by:

addToAll in interface Object2LongMap<T>

Parameters:

m - the values that should be added/inserted

putAll

public void putAll(Object2LongMap<T> m)

Description copied from interface: Object2LongMap

Type Specific function for the bull putting of values

Specified by:

putAll in interface Object2LongMap<T>

Parameters:

m - the elements that should be inserted

putAll

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

Specified by:

putAll in interface java.util.Map<T,java.lang.Long>

Overrides:

putAll in class java.util.AbstractMap<T,java.lang.Long>

putAll

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

Description copied from interface: Object2LongMap

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

Specified by:

putAll in interface Object2LongMap<T>

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

Description copied from interface: Object2LongMap

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

Specified by:

putAll in interface Object2LongMap<T>

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(Object2LongMap<T> m)

Description copied from interface: Object2LongMap

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

Specified by:

putAllIfAbsent in interface Object2LongMap<T>

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

Overrides:

containsKey in class java.util.AbstractMap<T,java.lang.Long>

containsValue

public boolean containsValue(long value)

Description copied from interface: Object2LongMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsValue in interface Object2LongMap<T>

Parameters:

value - element that is searched for

Returns:

if the value is present

replace

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

Description copied from interface: Object2LongMap

A Type Specific replace method to replace an existing value

Specified by:

replace in interface Object2LongMap<T>

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

Description copied from interface: Object2LongMap

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

Specified by:

replace in interface Object2LongMap<T>

Parameters:

key - the element that should be searched for

value - the value to replace with.

Returns:

the present value or default return value

replaceLongs

public void replaceLongs(Object2LongMap<T> m)

Description copied from interface: Object2LongMap

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

Specified by:

replaceLongs in interface Object2LongMap<T>

Parameters:

m - elements that should be replaced.

replaceLongs

public void replaceLongs(ObjectLongUnaryOperator<T> mappingFunction)

Description copied from interface: Object2LongMap

A Type Specific mass replace method to reduce boxing/unboxing

Specified by:

replaceLongs in interface Object2LongMap<T>

Parameters:

mappingFunction - operation to replace all values

computeLong

public long computeLong(T key,
                        ObjectLongUnaryOperator<T> mappingFunction)

Description copied from interface: Object2LongMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeLong in interface Object2LongMap<T>

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeLongIfAbsent

public long computeLongIfAbsent(T key,
                                Object2LongFunction<T> mappingFunction)

Description copied from interface: Object2LongMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeLongIfAbsent in interface Object2LongMap<T>

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

supplyLongIfAbsent

public long supplyLongIfAbsent(T key,
                               LongSupplier valueProvider)

Description copied from interface: Object2LongMap

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

Specified by:

supplyLongIfAbsent in interface Object2LongMap<T>

Parameters:

key - the key that should be computed

valueProvider - the value if not present

Returns:

the result of the computed value or present value

computeLongIfPresent

public long computeLongIfPresent(T key,
                                 ObjectLongUnaryOperator<T> mappingFunction)

Description copied from interface: Object2LongMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeLongIfPresent in interface Object2LongMap<T>

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

mergeLong

public long mergeLong(T key,
                      long value,
                      LongLongUnaryOperator mappingFunction)

Description copied from interface: Object2LongMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeLong in interface Object2LongMap<T>

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

mergeAllLong

public void mergeAllLong(Object2LongMap<T> m,
                         LongLongUnaryOperator mappingFunction)

Description copied from interface: Object2LongMap

A Bulk method for merging Maps.

Specified by:

mergeAllLong in interface Object2LongMap<T>

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

get

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

Specified by:

get in interface java.util.Map<T,java.lang.Long>

Specified by:

get in interface Object2LongMap<T>

Overrides:

get in class java.util.AbstractMap<T,java.lang.Long>

getOrDefault

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

Specified by:

getOrDefault in interface java.util.Map<T,java.lang.Long>

Specified by:

getOrDefault in interface Object2LongMap<T>

remove

public java.lang.Long remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<T,java.lang.Long>

Specified by:

remove in interface Object2LongMap<T>

Overrides:

remove in class java.util.AbstractMap<T,java.lang.Long>

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(ObjectLongConsumer<T> action)

Description copied from interface: Object2LongMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Object2LongMap<T>

Parameters:

action - processor of the values that are iterator over

keySet

public ObjectSet<T> keySet()

Specified by:

keySet in interface java.util.Map<T,java.lang.Long>

Specified by:

keySet in interface Object2LongMap<T>

Overrides:

keySet in class java.util.AbstractMap<T,java.lang.Long>

values

public LongCollection values()

Specified by:

values in interface java.util.Map<T,java.lang.Long>

Specified by:

values in interface Object2LongMap<T>

Overrides:

values in class java.util.AbstractMap<T,java.lang.Long>

entrySet

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

Specified by:

entrySet in interface java.util.Map<T,java.lang.Long>

Specified by:

entrySet in interface Object2LongMap<T>

Specified by:

entrySet in class java.util.AbstractMap<T,java.lang.Long>

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.Map<T,java.lang.Long>

Overrides:

equals in class java.util.AbstractMap<T,java.lang.Long>

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map<T,java.lang.Long>

Overrides:

hashCode in class java.util.AbstractMap<T,java.lang.Long>