speiger.src.collections.ints.maps.interfaces

Interface Int2ShortMap

All Superinterfaces:

Int2ShortFunction, java.util.Map<java.lang.Integer,java.lang.Short>

All Known Subinterfaces:

Int2ShortConcurrentMap, Int2ShortNavigableMap, Int2ShortOrderedMap, Int2ShortSortedMap

All Known Implementing Classes:

AbstractInt2ShortMap, ImmutableInt2ShortOpenHashMap, Int2ShortArrayMap, Int2ShortAVLTreeMap, Int2ShortConcurrentOpenHashMap, Int2ShortLinkedOpenCustomHashMap, Int2ShortLinkedOpenHashMap, Int2ShortMaps.EmptyMap, Int2ShortMaps.SingletonMap, Int2ShortMaps.SynchronizedMap, Int2ShortMaps.SynchronizedNavigableMap, Int2ShortMaps.SynchronizedOrderedMap, Int2ShortMaps.SynchronizedSortedMap, Int2ShortMaps.UnmodifyableMap, Int2ShortMaps.UnmodifyableNavigableMap, Int2ShortMaps.UnmodifyableOrderedMap, Int2ShortMaps.UnmodifyableSortedMap, Int2ShortOpenCustomHashMap, Int2ShortOpenHashMap, Int2ShortRBTreeMap

public interface Int2ShortMap
extends java.util.Map<java.lang.Integer,java.lang.Short>, Int2ShortFunction

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 class	Int2ShortMap.BuilderCache Builder Cache for allowing to buildMaps
static interface	Int2ShortMap.Entry Type Specific Map Entry that reduces boxing/unboxing
static interface	Int2ShortMap.FastEntrySet Fast Entry set that allows for a faster Entry Iterator by recycling the Entry Object and just exchanging 1 internal value
static class	Int2ShortMap.MapBuilder Helper class that reduces the method spam of the Map Class.

Method Summary

Modifier and Type	Method and Description
short	addTo(int key, short value) A Helper method to add a primitives together.
void	addToAll(Int2ShortMap m) A Helper method to bulk add primitives together.
static Int2ShortMap.MapBuilder	builder() Helper Class that allows to create Maps without requiring a to type out the entire implementation or know it.
default java.lang.Short	compute(java.lang.Integer key, java.util.function.BiFunction<? super java.lang.Integer,? super java.lang.Short,? extends java.lang.Short> mappingFunction) Deprecated.
default java.lang.Short	computeIfAbsent(java.lang.Integer key, java.util.function.Function<? super java.lang.Integer,? extends java.lang.Short> mappingFunction) Deprecated.
default java.lang.Short	computeIfPresent(java.lang.Integer key, java.util.function.BiFunction<? super java.lang.Integer,? super java.lang.Short,? extends java.lang.Short> mappingFunction) Deprecated.
short	computeShort(int key, IntShortUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
short	computeShortIfAbsent(int key, Int2ShortFunction mappingFunction) A Type Specific compute method to reduce boxing/unboxing
short	computeShortIfPresent(int key, IntShortUnaryOperator mappingFunction) A Type Specific compute method to reduce boxing/unboxing
boolean	containsKey(int key) Type Specific method to reduce boxing/unboxing of values
default boolean	containsKey(java.lang.Object key)
default boolean	containsValue(java.lang.Object value)
boolean	containsValue(short value) Type Specific method to reduce boxing/unboxing of values
Int2ShortMap	copy() A Function that does a shallow clone of the Map itself.
ObjectSet<java.util.Map.Entry<java.lang.Integer,java.lang.Short>>	entrySet() Deprecated.
default void	forEach(java.util.function.BiConsumer<? super java.lang.Integer,? super java.lang.Short> action) Deprecated.
void	forEach(IntShortConsumer action) Type Specific forEach method to reduce boxing/unboxing
short	get(int key) A Type Specific get method to reduce boxing/unboxing
default java.lang.Short	get(java.lang.Object key) Deprecated.
short	getDefaultReturnValue() Method to see what the default return value is.
short	getOrDefault(int key, short defaultValue) A Type Specific getOrDefault method to reduce boxing/unboxing
default java.lang.Short	getOrDefault(java.lang.Object key, java.lang.Short defaultValue) Deprecated.
ObjectSet<Int2ShortMap.Entry>	int2ShortEntrySet() Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
IntSet	keySet()
default java.lang.Short	merge(java.lang.Integer key, java.lang.Short value, java.util.function.BiFunction<? super java.lang.Short,? super java.lang.Short,? extends java.lang.Short> mappingFunction) Deprecated.
void	mergeAllShort(Int2ShortMap m, ShortShortUnaryOperator mappingFunction) A Bulk method for merging Maps.
short	mergeShort(int key, short value, ShortShortUnaryOperator mappingFunction) A Type Specific merge method to reduce boxing/unboxing
default java.lang.Short	put(java.lang.Integer key, java.lang.Short value) Deprecated.
short	put(int key, short value) Type Specific method to reduce boxing/unboxing of values
default void	putAll(int[] keys, short[] values) Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
void	putAll(int[] keys, short[] 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(Int2ShortMap m) Type Specific function for the bull putting of values
default void	putAll(java.lang.Integer[] keys, java.lang.Short[] values) Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances
void	putAll(java.lang.Integer[] keys, java.lang.Short[] 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(Int2ShortMap m) Type-Specific bulk put method put elements into the map if not present.
default java.lang.Short	putIfAbsent(java.lang.Integer key, java.lang.Short value) Deprecated.
short	putIfAbsent(int key, short value) Type Specific method to reduce boxing/unboxing of values
short	remove(int key) Type Specific remove function to reduce boxing/unboxing
boolean	remove(int key, short value) Type Specific remove function to reduce boxing/unboxing
default java.lang.Short	remove(java.lang.Object key)
default boolean	remove(java.lang.Object key, java.lang.Object value)
short	removeOrDefault(int key, short defaultValue) Type-Specific Remove function with a default return value if wanted.
default java.lang.Short	replace(java.lang.Integer key, java.lang.Short value) Deprecated.
default boolean	replace(java.lang.Integer key, java.lang.Short oldValue, java.lang.Short newValue) Deprecated.
short	replace(int key, short value) A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(int key, short oldValue, short newValue) A Type Specific replace method to replace an existing value
default void	replaceAll(java.util.function.BiFunction<? super java.lang.Integer,? super java.lang.Short,? extends java.lang.Short> mappingFunction) Deprecated.
void	replaceShorts(Int2ShortMap m) Type-Specific bulk replace method.
void	replaceShorts(IntShortUnaryOperator mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
Int2ShortMap	setDefaultReturnValue(short v) Method to define the default return value if a requested key isn't present
short	subFrom(int key, short value) A Helper method to subtract from primitive from each other.
short	supplyShortIfAbsent(int key, ShortSupplier valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
default Int2ShortMap	synchronize() Creates a Wrapped Map that is Synchronized
default Int2ShortMap	synchronize(java.lang.Object mutex) Creates a Wrapped Map that is Synchronized
default Int2ShortMap	unmodifiable() Creates a Wrapped Map that is unmodifiable
ShortCollection	values()

Methods inherited from interface java.util.Map

clear, equals, hashCode, isEmpty, putAll, size

Method Detail

builder

static Int2ShortMap.MapBuilder builder()

Helper Class that allows to create Maps without requiring a to type out the entire implementation or know it.

Returns:

a MapBuilder

getDefaultReturnValue

short getDefaultReturnValue()

Method to see what the default return value is.

Returns:

default return value

setDefaultReturnValue

Int2ShortMap setDefaultReturnValue(short 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

copy

Int2ShortMap copy()

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

Returns:

a Shallow Copy of the Map

Note:

Wrappers and view Maps will not support this feature

put

short put(int key,
          short 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(int[] keys,
                    short[] 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(int[] keys,
            short[] 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)

putAll

default void putAll(java.lang.Integer[] keys,
                    java.lang.Short[] values)

Type Specific Object 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(java.lang.Integer[] keys,
            java.lang.Short[] values,
            int offset,
            int size)

Type Specific Object 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

short putIfAbsent(int key,
                  short 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(Int2ShortMap 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

short addTo(int key,
            short 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(Int2ShortMap m)

A Helper method to bulk add primitives together.

Parameters:

m - the values that should be added/inserted

subFrom

short subFrom(int key,
              short value)

A Helper method to subtract from primitive from each other. If the key is not present it will just return the defaultValue How the implementation works is that it will subtract from the current value (if not present it will do nothing) and fence it to the getDefaultReturnValue() If the fence is reached the element will be automaticall removed

Parameters:

key - that should be subtract from

value - that should be subtract

Returns:

the last present or default return value

putAll

void putAll(Int2ShortMap m)

Type Specific function for the bull putting of values

Parameters:

m - the elements that should be inserted

containsKey

boolean containsKey(int 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.Integer,java.lang.Short>

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 Integer but just have to support equals with Integer.

containsValue

boolean containsValue(short 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.Integer,java.lang.Short>

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.

remove

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

Specified by:

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

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 Integer but just have to support equals with Integer.

remove

boolean remove(int key,
               short 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.Integer,java.lang.Short>

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)

removeOrDefault

short removeOrDefault(int key,
                      short 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(int key,
                short oldValue,
                short 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

short replace(int key,
              short 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

replaceShorts

void replaceShorts(Int2ShortMap m)

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

Parameters:

m - elements that should be replaced.

replaceShorts

void replaceShorts(IntShortUnaryOperator mappingFunction)

A Type Specific mass replace method to reduce boxing/unboxing

Parameters:

mappingFunction - operation to replace all values

computeShort

short computeShort(int key,
                   IntShortUnaryOperator 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

computeShortIfAbsent

short computeShortIfAbsent(int key,
                           Int2ShortFunction 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

supplyShortIfAbsent

short supplyShortIfAbsent(int key,
                          ShortSupplier valueProvider)

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

Parameters:

key - the key that should be computed

valueProvider - the value if not present

Returns:

the result of the computed value or present value

computeShortIfPresent

short computeShortIfPresent(int key,
                            IntShortUnaryOperator 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

mergeShort

short mergeShort(int key,
                 short value,
                 ShortShortUnaryOperator 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

mergeAllShort

void mergeAllShort(Int2ShortMap m,
                   ShortShortUnaryOperator 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.Integer key,
                                     java.lang.Short oldValue,
                                     java.lang.Short newValue)

Deprecated.

Specified by:

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

replace

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

Deprecated.

Specified by:

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

get

short get(int key)

A Type Specific get method to reduce boxing/unboxing

Specified by:

get in interface Int2ShortFunction

Parameters:

key - the key that is searched for

Returns:

the searched value or default return value

getOrDefault

short getOrDefault(int key,
                   short 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.Short get(java.lang.Object key)

Deprecated.

Specified by:

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

getOrDefault

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

Deprecated.

Specified by:

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

replaceAll

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

Deprecated.

Specified by:

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

compute

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

Deprecated.

Specified by:

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

computeIfAbsent

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

Deprecated.

Specified by:

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

computeIfPresent

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

Deprecated.

Specified by:

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

merge

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

Deprecated.

Specified by:

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

forEach

void forEach(IntShortConsumer 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.Integer,? super java.lang.Short> action)

Deprecated.

Specified by:

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

keySet

IntSet keySet()

Specified by:

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

values

ShortCollection values()

Specified by:

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

entrySet

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

Deprecated.

Specified by:

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

int2ShortEntrySet

ObjectSet<Int2ShortMap.Entry> int2ShortEntrySet()

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

Returns:

a EntrySet of the collection

synchronize

default Int2ShortMap synchronize()

Creates a Wrapped Map that is Synchronized

Returns:

a new Map that is synchronized

See Also:

Int2ShortMaps.synchronize(speiger.src.collections.ints.maps.interfaces.Int2ShortMap)

synchronize

default Int2ShortMap synchronize(java.lang.Object mutex)

Creates a Wrapped Map that is Synchronized

Parameters:

mutex - is the controller of the synchronization block

Returns:

a new Map Wrapper that is synchronized

See Also:

Int2ShortMaps.synchronize(speiger.src.collections.ints.maps.interfaces.Int2ShortMap)

unmodifiable

default Int2ShortMap unmodifiable()

Creates a Wrapped Map that is unmodifiable

Returns:

a new Map Wrapper that is unmodifiable

See Also:

Int2ShortMaps.unmodifiable(speiger.src.collections.ints.maps.interfaces.Int2ShortMap)

put

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

Deprecated.

Specified by:

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

putIfAbsent

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

Deprecated.

Specified by:

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