speiger.src.collections.ints.maps.abstracts

Class AbstractInt2ShortMap

java.lang.Object

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

speiger.src.collections.ints.maps.abstracts.AbstractInt2ShortMap

All Implemented Interfaces:

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

Direct Known Subclasses:

ImmutableInt2ShortOpenHashMap, Int2ShortArrayMap, Int2ShortAVLTreeMap, Int2ShortConcurrentOpenHashMap, Int2ShortMaps.EmptyMap, Int2ShortMaps.SingletonMap, Int2ShortMaps.SynchronizedMap, Int2ShortMaps.UnmodifyableMap, Int2ShortOpenCustomHashMap, Int2ShortOpenHashMap, Int2ShortRBTreeMap

public abstract class AbstractInt2ShortMap
extends java.util.AbstractMap<java.lang.Integer,java.lang.Short>
implements Int2ShortMap

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	AbstractInt2ShortMap.BasicEntry 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.Int2ShortMap

Int2ShortMap.BuilderCache, Int2ShortMap.Entry, Int2ShortMap.FastEntrySet, Int2ShortMap.MapBuilder

Constructor Summary

Constructors

Constructor and Description
AbstractInt2ShortMap()

Method Summary

Modifier and Type	Method and Description
void	addToAll(Int2ShortMap m) A Helper method to bulk add primitives together.
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
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()
boolean	equals(java.lang.Object o)
void	forEach(IntShortConsumer action) Type Specific forEach method to reduce boxing/unboxing
java.lang.Short	get(java.lang.Object key)
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
java.lang.Short	getOrDefault(java.lang.Object key, java.lang.Short defaultValue)
int	hashCode()
IntSet	keySet()
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
java.lang.Short	put(java.lang.Integer key, java.lang.Short value) Deprecated.
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
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	putAll(java.util.Map<? extends java.lang.Integer,? extends java.lang.Short> m)
void	putAllIfAbsent(Int2ShortMap m) Type-Specific bulk put method put elements into the map if not present.
java.lang.Short	remove(java.lang.Object key)
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
void	replaceShorts(Int2ShortMap m) Type-Specific bulk replace method.
void	replaceShorts(IntShortUnaryOperator mappingFunction) A Type Specific mass replace method to reduce boxing/unboxing
AbstractInt2ShortMap	setDefaultReturnValue(short v) Method to define the default return value if a requested key isn't present
short	supplyShortIfAbsent(int key, ShortSupplier valueProvider) A Supplier based computeIfAbsent function to fill the most used usecase of this function
ShortCollection	values()

Methods inherited from class java.util.AbstractMap

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

addTo, builder, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, forEach, get, int2ShortEntrySet, merge, put, putAll, putAll, putIfAbsent, putIfAbsent, remove, remove, remove, removeOrDefault, replace, replace, replaceAll, subFrom, synchronize, synchronize, unmodifiable

Methods inherited from interface java.util.Map

clear, isEmpty, size

Constructor Detail

AbstractInt2ShortMap

public AbstractInt2ShortMap()

Method Detail

getDefaultReturnValue

public short getDefaultReturnValue()

Description copied from interface: Int2ShortMap

Method to see what the default return value is.

Specified by:

getDefaultReturnValue in interface Int2ShortMap

Returns:

default return value

setDefaultReturnValue

public AbstractInt2ShortMap setDefaultReturnValue(short v)

Description copied from interface: Int2ShortMap

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

Specified by:

setDefaultReturnValue in interface Int2ShortMap

Parameters:

v - value that should be the default return value

Returns:

itself

copy

public Int2ShortMap copy()

Description copied from interface: Int2ShortMap

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 Int2ShortMap

Returns:

a Shallow Copy of the Map

put

@Deprecated
public 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>

Specified by:

put in interface Int2ShortMap

Overrides:

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

addToAll

public void addToAll(Int2ShortMap m)

Description copied from interface: Int2ShortMap

A Helper method to bulk add primitives together.

Specified by:

addToAll in interface Int2ShortMap

Parameters:

m - the values that should be added/inserted

putAll

public void putAll(Int2ShortMap m)

Description copied from interface: Int2ShortMap

Type Specific function for the bull putting of values

Specified by:

putAll in interface Int2ShortMap

Parameters:

m - the elements that should be inserted

putAll

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

Specified by:

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

Overrides:

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

putAll

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

Description copied from interface: Int2ShortMap

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

Specified by:

putAll in interface Int2ShortMap

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,
                   java.lang.Short[] values,
                   int offset,
                   int size)

Description copied from interface: Int2ShortMap

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

Specified by:

putAll in interface Int2ShortMap

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(Int2ShortMap m)

Description copied from interface: Int2ShortMap

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

Specified by:

putAllIfAbsent in interface Int2ShortMap

Parameters:

m - elements that should be added if not present.

containsKey

public boolean containsKey(int key)

Description copied from interface: Int2ShortMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsKey in interface Int2ShortMap

Parameters:

key - element that is searched for

Returns:

if the key is present

containsValue

public boolean containsValue(short value)

Description copied from interface: Int2ShortMap

Type Specific method to reduce boxing/unboxing of values

Specified by:

containsValue in interface Int2ShortMap

Parameters:

value - element that is searched for

Returns:

if the value is present

replace

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

Description copied from interface: Int2ShortMap

A Type Specific replace method to replace an existing value

Specified by:

replace in interface Int2ShortMap

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

Description copied from interface: Int2ShortMap

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

Specified by:

replace in interface Int2ShortMap

Parameters:

key - the element that should be searched for

value - the value to replace with.

Returns:

the present value or default return value

replaceShorts

public void replaceShorts(Int2ShortMap m)

Description copied from interface: Int2ShortMap

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

Specified by:

replaceShorts in interface Int2ShortMap

Parameters:

m - elements that should be replaced.

replaceShorts

public void replaceShorts(IntShortUnaryOperator mappingFunction)

Description copied from interface: Int2ShortMap

A Type Specific mass replace method to reduce boxing/unboxing

Specified by:

replaceShorts in interface Int2ShortMap

Parameters:

mappingFunction - operation to replace all values

computeShort

public short computeShort(int key,
                          IntShortUnaryOperator mappingFunction)

Description copied from interface: Int2ShortMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeShort in interface Int2ShortMap

Parameters:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Returns:

the result of the computation

computeShortIfAbsent

public short computeShortIfAbsent(int key,
                                  Int2ShortFunction mappingFunction)

Description copied from interface: Int2ShortMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeShortIfAbsent in interface Int2ShortMap

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

public short supplyShortIfAbsent(int key,
                                 ShortSupplier valueProvider)

Description copied from interface: Int2ShortMap

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

Specified by:

supplyShortIfAbsent in interface Int2ShortMap

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

public short computeShortIfPresent(int key,
                                   IntShortUnaryOperator mappingFunction)

Description copied from interface: Int2ShortMap

A Type Specific compute method to reduce boxing/unboxing

Specified by:

computeShortIfPresent in interface Int2ShortMap

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

mergeShort

public short mergeShort(int key,
                        short value,
                        ShortShortUnaryOperator mappingFunction)

Description copied from interface: Int2ShortMap

A Type Specific merge method to reduce boxing/unboxing

Specified by:

mergeShort in interface Int2ShortMap

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

mergeAllShort

public void mergeAllShort(Int2ShortMap m,
                          ShortShortUnaryOperator mappingFunction)

Description copied from interface: Int2ShortMap

A Bulk method for merging Maps.

Specified by:

mergeAllShort in interface Int2ShortMap

Parameters:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

get

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

Specified by:

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

Specified by:

get in interface Int2ShortMap

Overrides:

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

getOrDefault

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

Specified by:

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

Specified by:

getOrDefault in interface Int2ShortMap

getOrDefault

public short getOrDefault(int key,
                          short defaultValue)

Description copied from interface: Int2ShortMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Specified by:

getOrDefault in interface Int2ShortMap

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

Specified by:

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

Specified by:

remove in interface Int2ShortMap

Overrides:

remove in class java.util.AbstractMap<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)

forEach

public void forEach(IntShortConsumer action)

Description copied from interface: Int2ShortMap

Type Specific forEach method to reduce boxing/unboxing

Specified by:

forEach in interface Int2ShortMap

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

Specified by:

keySet in interface Int2ShortMap

Overrides:

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

values

public ShortCollection values()

Specified by:

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

Specified by:

values in interface Int2ShortMap

Overrides:

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

entrySet

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

Specified by:

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

Specified by:

entrySet in interface Int2ShortMap

Specified by:

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

equals

public boolean equals(java.lang.Object o)

Specified by:

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

Overrides:

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

hashCode

public int hashCode()

Specified by:

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

Overrides:

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