Modul speiger.src.collections

Package speiger.src.collections.objects.maps.impl.misc

Klasse Enum2ShortMap<T extends Enum<T>>

java.lang.Object

java.util.AbstractMap<T,Short>

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

speiger.src.collections.objects.maps.impl.misc.Enum2ShortMap<T>

Typparameter:

T - the keyType of elements maintained by this Collection

Alle implementierten Schnittstellen:

Map<T,Short>, ToShortFunction<T>, Object2ShortMap<T>

Bekannte direkte Unterklassen:

LinkedEnum2ShortMap

public class Enum2ShortMap<T extends Enum<T>>
extends AbstractObject2ShortMap<T>

A Type Specific EnumMap implementation that allows for Primitive Values. Unlike javas implementation this one does not jump around between a single long or long array implementation based around the enum size This will cause a bit more memory usage but allows for a simpler implementation.

Verschachtelte Klassen - Übersicht

Von Klasse geerbte verschachtelte Klassen/Schnittstellen speiger.src.collections.objects.maps.abstracts.AbstractObject2ShortMap

AbstractObject2ShortMap.BasicEntry<T>

Von Klasse geerbte verschachtelte Klassen/Schnittstellen java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Von Schnittstelle geerbte verschachtelte Klassen/Schnittstellen java.util.Map

Map.Entry<K,V>

Von Schnittstelle geerbte verschachtelte Klassen/Schnittstellen speiger.src.collections.objects.maps.interfaces.Object2ShortMap

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

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
Enum2ShortMap(Class<T> keyType)	Default Constructor
Enum2ShortMap(Map<? extends T,? extends Short> map)	A Helper constructor that allows to create a EnumMap with exactly the same values as the provided map.
Enum2ShortMap(Object2ShortMap<T> map)	A Type Specific Helper function that allows to create a new EnumMap with exactly the same values as the provided map.
Enum2ShortMap(T[] keys, short[] values)	Helper constructor that allow to create a EnumMap from unboxed values
Enum2ShortMap(T[] keys, Short[] values)	Helper constructor that allow to create a EnumMap from boxed values (it will unbox them)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
short	addTo(T key, short value)	A Helper method to add a primitives together.
void	clear()
short	computeShort(T key, ObjectShortUnaryOperator<T> mappingFunction)	A Type Specific compute method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null".
short	computeShortIfAbsent(T key, ToShortFunction<T> mappingFunction)	A Type Specific computeIfAbsent method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null".
short	computeShortIfAbsentNonDefault(T key, ToShortFunction<T> mappingFunction)	A Type Specific computeIfAbsent method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null".
short	computeShortIfPresent(T key, ObjectShortUnaryOperator<T> mappingFunction)	A Type Specific compute method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null".
short	computeShortIfPresentNonDefault(T key, ObjectShortUnaryOperator<T> mappingFunction)	A Type Specific compute method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null".
short	computeShortNonDefault(T key, ObjectShortUnaryOperator<T> mappingFunction)	A Type Specific compute method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null".
boolean	containsKey(Object key)
boolean	containsValue(short value)	Type Specific method to reduce boxing/unboxing of values
Enum2ShortMap<T>	copy()	A Function that does a shallow clone of the Map itself.
void	forEach(ObjectShortConsumer<T> action)	Type Specific forEach method to reduce boxing/unboxing
short	getOrDefault(T key, short defaultValue)	A Type Specific getOrDefault method to reduce boxing/unboxing
short	getShort(T key)	A Type Specific get method to reduce boxing/unboxing
ObjectSet<T>	keySet()
void	mergeAllShort(Object2ShortMap<T> m, ShortShortUnaryOperator mappingFunction)	A Bulk method for merging Maps.
short	mergeShort(T key, short value, ShortShortUnaryOperator mappingFunction)	A Type Specific merge method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null".
ObjectSet<Object2ShortMap.Entry<T>>	object2ShortEntrySet()	Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
short	put(T key, short value)	Type Specific method to reduce boxing/unboxing of values
short	putIfAbsent(T key, short value)	Type Specific method to reduce boxing/unboxing of values
short	rem(T key)	Type Specific remove function to reduce boxing/unboxing
short	remOrDefault(T key, short defaultValue)	Type-Specific Remove function with a default return value if wanted.
Short	remove(Object key)
boolean	remove(T key, short value)	Type Specific remove function to reduce boxing/unboxing
short	replace(T key, short value)	A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(T key, short oldValue, short newValue)	A Type Specific replace method to replace an existing value
int	size()
short	subFrom(T key, short value)	A Helper method to subtract from primitive from each other.
short	supplyShortIfAbsent(T key, ShortSupplier valueProvider)	A Supplier based computeIfAbsent function to fill the most used usecase of this function If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null".
short	supplyShortIfAbsentNonDefault(T key, ShortSupplier valueProvider)	A Supplier based computeIfAbsent function to fill the most used usecase of this function If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null".
ShortCollection	values()

Von Klasse geerbte Methoden speiger.src.collections.objects.maps.abstracts.AbstractObject2ShortMap

addToAll, entrySet, equals, get, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, replaceShorts, replaceShorts, setDefaultReturnValue

Von Klasse geerbte Methoden java.util.AbstractMap

containsValue, isEmpty, toString

Von Klasse geerbte Methoden java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Von Schnittstelle geerbte Methoden java.util.Map

isEmpty

Von Schnittstelle geerbte Methoden speiger.src.collections.objects.maps.interfaces.Object2ShortMap

applyAsShort, compute, computeIfAbsent, computeIfPresent, containsValue, forEach, merge, put, put, putAll, putAll, putIfAbsent, remove, replace, replace, replaceAll, synchronize, synchronize, unmodifiable

Konstruktordetails

Enum2ShortMap

public Enum2ShortMap(Class<T> keyType)

Default Constructor

Parameter:

keyType - the type of Enum that should be used

Enum2ShortMap

public Enum2ShortMap(T[] keys,
 Short[] values)

Helper constructor that allow to create a EnumMap from boxed values (it will unbox them)

Parameter:

keys - the keys that should be put into the EnumMap

values - the values that should be put into the EnumMap.

Löst aus:

IllegalStateException - if the keys and values do not match in lenght

Enum2ShortMap

public Enum2ShortMap(T[] keys,
 short[] values)

Helper constructor that allow to create a EnumMap from unboxed values

Parameter:

keys - the keys that should be put into the map

values - the values that should be put into the map.

Löst aus:

IllegalStateException - if the keys and values do not match in lenght

Enum2ShortMap

public Enum2ShortMap(Map<? extends T,? extends Short> map)

A Helper constructor that allows to create a EnumMap with exactly the same values as the provided map.

Parameter:

map - the values that should be present in the map

Enum2ShortMap

public Enum2ShortMap(Object2ShortMap<T> map)

A Type Specific Helper function that allows to create a new EnumMap with exactly the same values as the provided map.

Parameter:

map - the values that should be present in the map

Methodendetails

put

public short put(T key,
 short value)

Beschreibung aus Schnittstelle kopiert: Object2ShortMap

Type Specific method to reduce boxing/unboxing of values

Parameter:

key - the key that should be inserted,

value - the value that should be inserted

Gibt zurück:

the last present value or default return value.

Siehe auch:

• Map.put(Object, Object)

putIfAbsent

public short putIfAbsent(T key,
 short value)

Beschreibung aus Schnittstelle kopiert: Object2ShortMap

Type Specific method to reduce boxing/unboxing of values

Parameter:

key - the key that should be inserted,

value - the value that should be inserted

Gibt zurück:

the last present value or default return value.

Siehe auch:

• Map.putIfAbsent(Object, Object)

addTo

public short addTo(T key,
 short value)

Beschreibung aus Schnittstelle kopiert: Object2ShortMap

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

Parameter:

key - the key that should be inserted,

value - the value that should be inserted / added

Gibt zurück:

the last present value or default return value.

subFrom

public short subFrom(T key,
 short value)

Beschreibung aus Schnittstelle kopiert: Object2ShortMap

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 Object2ShortMap.getDefaultReturnValue() If the fence is reached the element will be automaticall removed

Parameter:

key - that should be subtract from

value - that should be subtract

Gibt zurück:

the last present or default return value

containsKey

public boolean containsKey(Object key)

Angegeben von:

containsKey in Schnittstelle Map<T extends Enum<T>,Short>

Setzt außer Kraft:

containsKey in Klasse AbstractObject2ShortMap<T extends Enum<T>>

containsValue

public boolean containsValue(short value)

Beschreibung aus Schnittstelle kopiert: Object2ShortMap

Type Specific method to reduce boxing/unboxing of values

Angegeben von:

containsValue in Schnittstelle Object2ShortMap<T extends Enum<T>>

Setzt außer Kraft:

containsValue in Klasse AbstractObject2ShortMap<T extends Enum<T>>

Parameter:

value - element that is searched for

Gibt zurück:

if the value is present

remove

public Short remove(Object key)

Angegeben von:

remove in Schnittstelle Map<T extends Enum<T>,Short>

Angegeben von:

remove in Schnittstelle Object2ShortMap<T extends Enum<T>>

Setzt außer Kraft:

remove in Klasse AbstractObject2ShortMap<T extends Enum<T>>

Parameter:

key - the element that should be removed

Gibt zurück:

the value that was removed or default return value

Siehe auch:

• Map.remove(Object)

rem

public short rem(T key)

Beschreibung aus Schnittstelle kopiert: Object2ShortMap

Type Specific remove function to reduce boxing/unboxing

Parameter:

key - the element that should be removed

Gibt zurück:

the value that was removed or default return value

remOrDefault

public short remOrDefault(T key,
 short defaultValue)

Beschreibung aus Schnittstelle kopiert: Object2ShortMap

Type-Specific Remove function with a default return value if wanted.

Parameter:

key - the element that should be removed

defaultValue - the value that should be returned if the entry doesn't exist

Gibt zurück:

the value that was removed or default value

Siehe auch:

• Map.remove(Object, Object)

remove

public boolean remove(T key,
 short value)

Beschreibung aus Schnittstelle kopiert: Object2ShortMap

Type Specific remove function to reduce boxing/unboxing

Parameter:

key - the element that should be removed

value - the expected value that should be found

Gibt zurück:

true if the key and value was found and removed

Siehe auch:

• Map.remove(Object, Object)

getShort

public short getShort(T key)

Beschreibung aus Schnittstelle kopiert: Object2ShortMap

A Type Specific get method to reduce boxing/unboxing

Parameter:

key - the key that is searched for

Gibt zurück:

the searched value or default return value

getOrDefault

public short getOrDefault(T key,
 short defaultValue)

Beschreibung aus Schnittstelle kopiert: Object2ShortMap

A Type Specific getOrDefault method to reduce boxing/unboxing

Parameter:

key - the key that is searched for

defaultValue - the value that should be returned if the key is not present

Gibt zurück:

the searched value or defaultValue value

copy

public Enum2ShortMap<T> copy()

Beschreibung aus Schnittstelle kopiert: Object2ShortMap

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

Angegeben von:

copy in Schnittstelle Object2ShortMap<T extends Enum<T>>

Setzt außer Kraft:

copy in Klasse AbstractObject2ShortMap<T extends Enum<T>>

Gibt zurück:

a Shallow Copy of the Map

object2ShortEntrySet

public ObjectSet<Object2ShortMap.Entry<T>> object2ShortEntrySet()

Beschreibung aus Schnittstelle kopiert: Object2ShortMap

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

Gibt zurück:

a EntrySet of the collection

keySet

public ObjectSet<T> keySet()

Angegeben von:

keySet in Schnittstelle Map<T extends Enum<T>,Short>

Angegeben von:

keySet in Schnittstelle Object2ShortMap<T extends Enum<T>>

Setzt außer Kraft:

keySet in Klasse AbstractObject2ShortMap<T extends Enum<T>>

values

public ShortCollection values()

Angegeben von:

values in Schnittstelle Map<T extends Enum<T>,Short>

Angegeben von:

values in Schnittstelle Object2ShortMap<T extends Enum<T>>

Setzt außer Kraft:

values in Klasse AbstractObject2ShortMap<T extends Enum<T>>

forEach

public void forEach(ObjectShortConsumer<T> action)

Beschreibung aus Schnittstelle kopiert: Object2ShortMap

Type Specific forEach method to reduce boxing/unboxing

Angegeben von:

forEach in Schnittstelle Object2ShortMap<T extends Enum<T>>

Setzt außer Kraft:

forEach in Klasse AbstractObject2ShortMap<T extends Enum<T>>

Parameter:

action - processor of the values that are iterator over

replace

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

Beschreibung aus Schnittstelle kopiert: Object2ShortMap

A Type Specific replace method to replace an existing value

Angegeben von:

replace in Schnittstelle Object2ShortMap<T extends Enum<T>>

Setzt außer Kraft:

replace in Klasse AbstractObject2ShortMap<T extends Enum<T>>

Parameter:

key - the element that should be searched for

oldValue - the expected value to be replaced

newValue - the value to replace the oldValue with.

Gibt zurück:

true if the value got replaced

replace

public short replace(T key,
 short value)

Beschreibung aus Schnittstelle kopiert: Object2ShortMap

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

Angegeben von:

replace in Schnittstelle Object2ShortMap<T extends Enum<T>>

Setzt außer Kraft:

replace in Klasse AbstractObject2ShortMap<T extends Enum<T>>

Parameter:

key - the element that should be searched for

value - the value to replace with.

Gibt zurück:

the present value or default return value

computeShort

public short computeShort(T key,
 ObjectShortUnaryOperator<T> mappingFunction)

Beschreibung aus Schnittstelle kopiert: Object2ShortMap

A Type Specific compute method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.

Angegeben von:

computeShort in Schnittstelle Object2ShortMap<T extends Enum<T>>

Setzt außer Kraft:

computeShort in Klasse AbstractObject2ShortMap<T extends Enum<T>>

Parameter:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Gibt zurück:

the result of the computation

computeShortIfAbsent

public short computeShortIfAbsent(T key,
 ToShortFunction<T> mappingFunction)

Beschreibung aus Schnittstelle kopiert: Object2ShortMap

A Type Specific computeIfAbsent method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.

Angegeben von:

computeShortIfAbsent in Schnittstelle Object2ShortMap<T extends Enum<T>>

Setzt außer Kraft:

computeShortIfAbsent in Klasse AbstractObject2ShortMap<T extends Enum<T>>

Parameter:

key - the key that should be computed

mappingFunction - the operator that should generate the value if not present

Gibt zurück:

the result of the computed value or present value

supplyShortIfAbsent

public short supplyShortIfAbsent(T key,
 ShortSupplier valueProvider)

Beschreibung aus Schnittstelle kopiert: Object2ShortMap

A Supplier based computeIfAbsent function to fill the most used usecase of this function If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.

Angegeben von:

supplyShortIfAbsent in Schnittstelle Object2ShortMap<T extends Enum<T>>

Setzt außer Kraft:

supplyShortIfAbsent in Klasse AbstractObject2ShortMap<T extends Enum<T>>

Parameter:

key - the key that should be computed

valueProvider - the value if not present

Gibt zurück:

the result of the computed value or present value

computeShortIfPresent

public short computeShortIfPresent(T key,
 ObjectShortUnaryOperator<T> mappingFunction)

Beschreibung aus Schnittstelle kopiert: Object2ShortMap

A Type Specific compute method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.

Angegeben von:

computeShortIfPresent in Schnittstelle Object2ShortMap<T extends Enum<T>>

Setzt außer Kraft:

computeShortIfPresent in Klasse AbstractObject2ShortMap<T extends Enum<T>>

Parameter:

key - the key that should be computed

mappingFunction - the operator that should generate the value if present

Gibt zurück:

the result of the default return value or present value

computeShortNonDefault

public short computeShortNonDefault(T key,
 ObjectShortUnaryOperator<T> mappingFunction)

Beschreibung aus Schnittstelle kopiert: Object2ShortMap

A Type Specific compute method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.

Angegeben von:

computeShortNonDefault in Schnittstelle Object2ShortMap<T extends Enum<T>>

Setzt außer Kraft:

computeShortNonDefault in Klasse AbstractObject2ShortMap<T extends Enum<T>>

Parameter:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Gibt zurück:

the result of the computation

computeShortIfAbsentNonDefault

public short computeShortIfAbsentNonDefault(T key,
 ToShortFunction<T> mappingFunction)

Beschreibung aus Schnittstelle kopiert: Object2ShortMap

A Type Specific computeIfAbsent method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.

Angegeben von:

computeShortIfAbsentNonDefault in Schnittstelle Object2ShortMap<T extends Enum<T>>

Setzt außer Kraft:

computeShortIfAbsentNonDefault in Klasse AbstractObject2ShortMap<T extends Enum<T>>

Parameter:

key - the key that should be computed

mappingFunction - the operator that should generate the value if not present

Gibt zurück:

the result of the computed value or present value

supplyShortIfAbsentNonDefault

public short supplyShortIfAbsentNonDefault(T key,
 ShortSupplier valueProvider)

Beschreibung aus Schnittstelle kopiert: Object2ShortMap

A Supplier based computeIfAbsent function to fill the most used usecase of this function If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.

Angegeben von:

supplyShortIfAbsentNonDefault in Schnittstelle Object2ShortMap<T extends Enum<T>>

Setzt außer Kraft:

supplyShortIfAbsentNonDefault in Klasse AbstractObject2ShortMap<T extends Enum<T>>

Parameter:

key - the key that should be computed

valueProvider - the value if not present

Gibt zurück:

the result of the computed value or present value

computeShortIfPresentNonDefault

public short computeShortIfPresentNonDefault(T key,
 ObjectShortUnaryOperator<T> mappingFunction)

Beschreibung aus Schnittstelle kopiert: Object2ShortMap

A Type Specific compute method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.

Angegeben von:

computeShortIfPresentNonDefault in Schnittstelle Object2ShortMap<T extends Enum<T>>

Setzt außer Kraft:

computeShortIfPresentNonDefault in Klasse AbstractObject2ShortMap<T extends Enum<T>>

Parameter:

key - the key that should be computed

mappingFunction - the operator that should generate the value if present

Gibt zurück:

the result of the default return value or present value

mergeShort

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

Beschreibung aus Schnittstelle kopiert: Object2ShortMap

A Type Specific merge method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.

Angegeben von:

mergeShort in Schnittstelle Object2ShortMap<T extends Enum<T>>

Setzt außer Kraft:

mergeShort in Klasse AbstractObject2ShortMap<T extends Enum<T>>

Parameter:

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

Gibt zurück:

the result of the merge

mergeAllShort

public void mergeAllShort(Object2ShortMap<T> m,
 ShortShortUnaryOperator mappingFunction)

Beschreibung aus Schnittstelle kopiert: Object2ShortMap

A Bulk method for merging Maps. If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.

Angegeben von:

mergeAllShort in Schnittstelle Object2ShortMap<T extends Enum<T>>

Setzt außer Kraft:

mergeAllShort in Klasse AbstractObject2ShortMap<T extends Enum<T>>

Parameter:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

clear

public void clear()

Angegeben von:

clear in Schnittstelle Map<T extends Enum<T>,Short>

Setzt außer Kraft:

clear in Klasse AbstractMap<T extends Enum<T>,Short>

size

public int size()

Angegeben von:

size in Schnittstelle Map<T extends Enum<T>,Short>

Setzt außer Kraft:

size in Klasse AbstractMap<T extends Enum<T>,Short>