speiger.src.collections.longs.maps.interfaces

Interface Long2IntMap

All Superinterfaces:

Long2IntFunction, java.util.function.LongToIntFunction, java.util.Map<java.lang.Long,java.lang.Integer>

All Known Subinterfaces:

Long2IntNavigableMap, Long2IntSortedMap

All Known Implementing Classes:

AbstractLong2IntMap, Long2IntArrayMap, Long2IntAVLTreeMap, Long2IntLinkedOpenCustomHashMap, Long2IntLinkedOpenHashMap, Long2IntMaps.EmptyMap, Long2IntMaps.SingletonMap, Long2IntMaps.SynchronizedMap, Long2IntMaps.SynchronizedNavigableMap, Long2IntMaps.SynchronizedSortedMap, Long2IntMaps.UnmodifyableMap, Long2IntMaps.UnmodifyableNavigableMap, Long2IntMaps.UnmodifyableSortedMap, Long2IntOpenCustomHashMap, Long2IntOpenHashMap, Long2IntRBTreeMap

public interface Long2IntMap
extends java.util.Map<java.lang.Long,java.lang.Integer>, Long2IntFunction

A Type Specific Map that reduces memory overhead due to boxing/unboxing of Primitives and some extra helper functions.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Long2IntMap.Entry Type Specific Map Entry that reduces boxing/unboxing
static interface	Long2IntMap.FastEntrySet Fast Entry set that allows for a faster Entry Iterator by recycling the Entry Object and just exchanging 1 internal value

Method Summary

Modifier and Type	Method and Description
int	addTo(long key, int value) A Helper method to add a primitives together.
void	addToAll(Long2IntMap m) A Helper method to bulk add primitives together.
default java.lang.Integer	compute(java.lang.Long key, java.util.function.BiFunction<? super java.lang.Long,? super java.lang.Integer,? extends java.lang.Integer> mappingFunction) Deprecated.
default java.lang.Integer	computeIfAbsent(java.lang.Long key, java.util.function.Function<? super java.lang.Long,? extends java.lang.Integer> mappingFunction) Deprecated.
default java.lang.Integer	computeIfPresent(java.lang.Long key, java.util.function.BiFunction<? super java.lang.Long,? super java.lang.Integer,? extends java.lang.Integer> mappingFunction) Deprecated.
int	computeInt(long key, LongIntUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
int	computeIntIfAbsent(long key, Long2IntFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
int	computeIntIfPresent(long key, LongIntUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	containsKey(long key) Type Specific method to reduce boxing/unboxing of values
default boolean	containsKey(java.lang.Object key)
boolean	containsValue(int value) Type Specific method to reduce boxing/unboxing of values
default boolean	containsValue(java.lang.Object value)
ObjectSet<java.util.Map.Entry<java.lang.Long,java.lang.Integer>>	entrySet() Deprecated.
default void	forEach(java.util.function.BiConsumer<? super java.lang.Long,? super java.lang.Integer> action) Deprecated.
void	forEach(LongIntConsumer action) Type Specific forEach method to reduce boxing/unboxing
default java.lang.Integer	get(java.lang.Object key) Deprecated.
int	getDefaultReturnValue() Method to see what the default return value is.
int	getInt(long key) A Type Specific get method to reduce boxing/unboxing
int	getOrDefault(long key, int defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
default java.lang.Integer	getOrDefault(java.lang.Object key, java.lang.Integer defaultValue) Deprecated.
LongSet	keySet()
ObjectSet<Long2IntMap.Entry>	long2IntEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
default java.lang.Integer	merge(java.lang.Long key, java.lang.Integer value, java.util.function.BiFunction<? super java.lang.Integer,? super java.lang.Integer,? extends java.lang.Integer> mappingFunction) Deprecated.
void	mergeAllInt(Long2IntMap m, IntIntUnaryOperator mappingFunction) A Bulk method for merging Maps.
int	mergeInt(long key, int value, IntIntUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
int	put(long key, int value) Type Specific method to reduce boxing/unboxing of values
default java.lang.Integer	put(java.lang.Long key, java.lang.Integer value) Deprecated.
default void	putAll(long[] keys, int[] values) Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
void	putAll(long[] keys, int[] 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(Long2IntMap m) Type Specific function for the bull putting of values
void	putAllIfAbsent(Long2IntMap m) Type-Specific bulk put method put elements into the map if not present.
int	putIfAbsent(long key, int value) Type Specific method to reduce boxing/unboxing of values
default java.lang.Integer	putIfAbsent(java.lang.Long key, java.lang.Integer value) Deprecated.
int	remLong(long key) Type Specific remove function to reduce boxing/unboxing
int	remLongOrDefault(long key, int defaultValue) Type-Specific Remove function with a default return value if wanted.
boolean	remove(long key, int value) Type Specific remove function to reduce boxing/unboxing
default java.lang.Integer	remove(java.lang.Object key)
default boolean	remove(java.lang.Object key, java.lang.Object value)
int	replace(long key, int value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
default java.lang.Integer	replace(java.lang.Long key, java.lang.Integer value) Deprecated.
default boolean	replace(java.lang.Long key, java.lang.Integer oldValue, java.lang.Integer newValue) Deprecated.
boolean	replace(long key, int oldValue, int newValue) A Type Specific replace method to replace an existing value
default void	replaceAll(java.util.function.BiFunction<? super java.lang.Long,? super java.lang.Integer,? extends java.lang.Integer> mappingFunction) Deprecated.
void	replaceInts(Long2IntMap m) Type-Specific bulk replace method.
void	replaceInts(LongIntUnaryOperator mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
Long2IntMap	setDefaultReturnValue(int v) Method to define the default return value if a requested key isn't present
IntCollection	values()

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Methods inherited from interface speiger.src.collections.longs.functions.function.Long2IntFunction

applyAsInt

Method Detail

getDefaultReturnValue

int getDefaultReturnValue()

Method to see what the default return value is.

Returns:

default return value

setDefaultReturnValue

Long2IntMap setDefaultReturnValue(int v)

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

Parameters:

v - value that should be the default return value

Returns:

itself

put

int put(long key,
        int value)

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.put(Object, Object)

putAll

default void putAll(long[] keys,
                    int[] values)

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

Parameters:

keys - the keys that should be added

values - the values that should be added

Throws:

java.lang.IllegalStateException - if the arrays are not the same size

See Also:

Map.putAll(Map)

putAll

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

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

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

Throws:

java.lang.IllegalStateException - if the arrays are not within the range

See Also:

Map.putAll(Map)

putIfAbsent

int putIfAbsent(long key,
                int value)

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)

putAllIfAbsent

void putAllIfAbsent(Long2IntMap m)

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

Parameters:

m - elements that should be added if not present.

addTo

int addTo(long key,
          int value)

A Helper method to add a primitives together. If key is not present then this functions as a put.

Parameters:

key - the key that should be inserted,

value - the value that should be inserted / added

Returns:

the last present value or default return value.

addToAll

void addToAll(Long2IntMap m)

A Helper method to bulk add primitives together.

Parameters:

m - the values that should be added/inserted

putAll

void putAll(Long2IntMap m)

Type Specific function for the bull putting of values

Parameters:

m - the elements that should be inserted

containsKey

boolean containsKey(long key)

Type Specific method to reduce boxing/unboxing of values

Parameters:

key - element that is searched for

Returns:

if the key is present

containsKey

default boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<java.lang.Long,java.lang.Integer>

Parameters:

key - that is searched for.

Returns:

true if found

See Also:

Map.containsKey(Object)

Note:

in some implementations key does not have to be Long but just have to support equals with Long.

containsValue

boolean containsValue(int value)

Type Specific method to reduce boxing/unboxing of values

Parameters:

value - element that is searched for

Returns:

if the value is present

containsValue

default boolean containsValue(java.lang.Object value)

Specified by:

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

Parameters:

value - that is searched for.

Returns:

true if found

See Also:

Map.containsValue(Object)

Note:

in some implementations key does not have to be CLASS_VALUE but just have to support equals with CLASS_VALUE.

remLong

int remLong(long key)

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

remove

default java.lang.Integer remove(java.lang.Object key)

Specified by:

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

Parameters:

key - the element that should be removed

Returns:

the value that was removed or default return value

See Also:

Map.remove(Object)

Note:

in some implementations key does not have to be Long but just have to support equals with Long.

remove

boolean remove(long key,
               int value)

Type Specific remove function to reduce boxing/unboxing

Parameters:

key - the element that should be removed

value - the expected value that should be found

Returns:

true if the key and value was found and removed

See Also:

Map.remove(Object, Object)

remove

default boolean remove(java.lang.Object key,
                       java.lang.Object value)

Specified by:

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

Parameters:

key - the element that should be removed

value - the expected value that should be found

Returns:

true if the key and value was found and removed

See Also:

Map.remove(Object, Object)

remLongOrDefault

int remLongOrDefault(long key,
                     int defaultValue)

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)

replace

boolean replace(long key,
                int oldValue,
                int newValue)

A Type Specific replace method to replace an existing value

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

Note:

this fails if the value is not present even if it matches the oldValue

replace

int replace(long key,
            int value)

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

Parameters:

key - the element that should be searched for

value - the value to replace with.

Returns:

the present value or default return value

Note:

this fails if the value is not present

replaceInts

void replaceInts(Long2IntMap m)

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

Parameters:

m - elements that should be replaced.

replaceInts

void replaceInts(LongIntUnaryOperator mappingFunction)

A Type Specific mass replace method to reduce boxing/unboxing

Parameters:

mappingFunction - operation to replace all values

computeInt

int computeInt(long key,
               LongIntUnaryOperator mappingFunction)

A Type Specific compute method to reduce boxing/unboxing

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeIntIfAbsent

int computeIntIfAbsent(long key,
                       Long2IntFunction mappingFunction)

A Type Specific compute method to reduce boxing/unboxing

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

computeIntIfPresent

int computeIntIfPresent(long key,
                        LongIntUnaryOperator mappingFunction)

A Type Specific compute method to reduce boxing/unboxing

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

Note:

if not present then compute is not executed

mergeInt

int mergeInt(long key,
             int value,
             IntIntUnaryOperator mappingFunction)

A Type Specific merge method to reduce boxing/unboxing

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

Note:

if the result matches the default return value then the key is removed from the map

mergeAllInt

void mergeAllInt(Long2IntMap m,
                 IntIntUnaryOperator mappingFunction)

A Bulk method for merging Maps.

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

Note:

if the result matches the default return value then the key is removed from the map

replace

@Deprecated
default boolean replace(java.lang.Long key,
                                     java.lang.Integer oldValue,
                                     java.lang.Integer newValue)

Deprecated.

Specified by:

replace in interface java.util.Map<java.lang.Long,java.lang.Integer>

replace

@Deprecated
default java.lang.Integer replace(java.lang.Long key,
                                               java.lang.Integer value)

Deprecated.

Specified by:

replace in interface java.util.Map<java.lang.Long,java.lang.Integer>

getInt

int getInt(long key)

A Type Specific get method to reduce boxing/unboxing

Specified by:

getInt in interface Long2IntFunction

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

getOrDefault

int getOrDefault(long key,
                 int defaultValue)

A Type Specific getOrDefault method to reduce boxing/unboxing

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

get

@Deprecated
default java.lang.Integer get(java.lang.Object key)

Deprecated.

Specified by:

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

getOrDefault

@Deprecated
default java.lang.Integer getOrDefault(java.lang.Object key,
                                                    java.lang.Integer defaultValue)

Deprecated.

Specified by:

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

replaceAll

@Deprecated
default void replaceAll(java.util.function.BiFunction<? super java.lang.Long,? super java.lang.Integer,? extends java.lang.Integer> mappingFunction)

Deprecated.

Specified by:

replaceAll in interface java.util.Map<java.lang.Long,java.lang.Integer>

compute

@Deprecated
default java.lang.Integer compute(java.lang.Long key,
                                               java.util.function.BiFunction<? super java.lang.Long,? super java.lang.Integer,? extends java.lang.Integer> mappingFunction)

Deprecated.

Specified by:

compute in interface java.util.Map<java.lang.Long,java.lang.Integer>

computeIfAbsent

@Deprecated
default java.lang.Integer computeIfAbsent(java.lang.Long key,
                                                       java.util.function.Function<? super java.lang.Long,? extends java.lang.Integer> mappingFunction)

Deprecated.

Specified by:

computeIfAbsent in interface java.util.Map<java.lang.Long,java.lang.Integer>

computeIfPresent

@Deprecated
default java.lang.Integer computeIfPresent(java.lang.Long key,
                                                        java.util.function.BiFunction<? super java.lang.Long,? super java.lang.Integer,? extends java.lang.Integer> mappingFunction)

Deprecated.

Specified by:

computeIfPresent in interface java.util.Map<java.lang.Long,java.lang.Integer>

merge

@Deprecated
default java.lang.Integer merge(java.lang.Long key,
                                             java.lang.Integer value,
                                             java.util.function.BiFunction<? super java.lang.Integer,? super java.lang.Integer,? extends java.lang.Integer> mappingFunction)

Deprecated.

Specified by:

merge in interface java.util.Map<java.lang.Long,java.lang.Integer>

forEach

void forEach(LongIntConsumer action)

Type Specific forEach method to reduce boxing/unboxing

Parameters:

action - processor of the values that are iterator over

forEach

@Deprecated
default void forEach(java.util.function.BiConsumer<? super java.lang.Long,? super java.lang.Integer> action)

Deprecated.

Specified by:

forEach in interface java.util.Map<java.lang.Long,java.lang.Integer>

keySet

LongSet keySet()

Specified by:

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

values

IntCollection values()

Specified by:

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

entrySet

@Deprecated
ObjectSet<java.util.Map.Entry<java.lang.Long,java.lang.Integer>> entrySet()

Deprecated.

Specified by:

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

long2IntEntrySet

ObjectSet<Long2IntMap.Entry> long2IntEntrySet()

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

Returns:

a EntrySet of the collection

put

@Deprecated
default java.lang.Integer put(java.lang.Long key,
                                           java.lang.Integer value)

Deprecated.

Specified by:

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

putIfAbsent

@Deprecated
default java.lang.Integer putIfAbsent(java.lang.Long key,
                                                   java.lang.Integer value)

Deprecated.

Specified by:

putIfAbsent in interface java.util.Map<java.lang.Long,java.lang.Integer>