Modul speiger.src.collections

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

Klasse Enum2IntMap<T extends Enum<T>>

java.lang.Object

java.util.AbstractMap<T,Integer>

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

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

Typparameter:

T - the keyType of elements maintained by this Collection

Alle implementierten Schnittstellen:

ToIntFunction<T>, Map<T,Integer>, ToIntFunction<T>, Object2IntMap<T>

Bekannte direkte Unterklassen:

LinkedEnum2IntMap

public class Enum2IntMap<T extends Enum<T>>
extends AbstractObject2IntMap<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.AbstractObject2IntMap

AbstractObject2IntMap.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.Object2IntMap

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

Konstruktorübersicht

Konstruktoren

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

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
int	addTo(T key, int value)	A Helper method to add a primitives together.
void	clear()
int	computeInt(T key, ObjectIntUnaryOperator<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".
int	computeIntIfAbsent(T key, ToIntFunction<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".
int	computeIntIfAbsentNonDefault(T key, ToIntFunction<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".
int	computeIntIfPresent(T key, ObjectIntUnaryOperator<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".
int	computeIntIfPresentNonDefault(T key, ObjectIntUnaryOperator<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".
int	computeIntNonDefault(T key, ObjectIntUnaryOperator<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(int value)	Type Specific method to reduce boxing/unboxing of values
Enum2IntMap<T>	copy()	A Function that does a shallow clone of the Map itself.
void	forEach(ObjectIntConsumer<T> action)	Type Specific forEach method to reduce boxing/unboxing
int	getInt(T key)	A Type Specific get method to reduce boxing/unboxing
int	getOrDefault(T key, int defaultValue)	A Type Specific getOrDefault method to reduce boxing/unboxing
ObjectSet<T>	keySet()
void	mergeAllInt(Object2IntMap<T> m, IntIntUnaryOperator mappingFunction)	A Bulk method for merging Maps.
int	mergeInt(T key, int value, IntIntUnaryOperator 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<Object2IntMap.Entry<T>>	object2IntEntrySet()	Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
int	put(T key, int value)	Type Specific method to reduce boxing/unboxing of values
int	putIfAbsent(T key, int value)	Type Specific method to reduce boxing/unboxing of values
int	rem(T key)	Type Specific remove function to reduce boxing/unboxing
int	remOrDefault(T key, int defaultValue)	Type-Specific Remove function with a default return value if wanted.
Integer	remove(Object key)
boolean	remove(T key, int value)	Type Specific remove function to reduce boxing/unboxing
int	replace(T key, int value)	A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(T key, int oldValue, int newValue)	A Type Specific replace method to replace an existing value
int	size()
int	subFrom(T key, int value)	A Helper method to subtract from primitive from each other.
int	supplyIntIfAbsent(T key, IntSupplier 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".
int	supplyIntIfAbsentNonDefault(T key, IntSupplier 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".
IntCollection	values()

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

addToAll, entrySet, equals, get, getDefaultReturnValue, getOrDefault, hashCode, put, putAll, putAll, putAll, putAll, putAllIfAbsent, replaceInts, replaceInts, 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.Object2IntMap

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

Konstruktordetails

Enum2IntMap

public Enum2IntMap(Class<T> keyType)

Default Constructor

Parameter:

keyType - the type of Enum that should be used

Enum2IntMap

public Enum2IntMap(T[] keys,
 Integer[] 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

Enum2IntMap

public Enum2IntMap(T[] keys,
 int[] 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

Enum2IntMap

public Enum2IntMap(Map<? extends T,? extends Integer> 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

Enum2IntMap

public Enum2IntMap(Object2IntMap<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 int put(T key,
 int value)

Beschreibung aus Schnittstelle kopiert: Object2IntMap

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 int putIfAbsent(T key,
 int value)

Beschreibung aus Schnittstelle kopiert: Object2IntMap

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 int addTo(T key,
 int value)

Beschreibung aus Schnittstelle kopiert: Object2IntMap

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 int subFrom(T key,
 int value)

Beschreibung aus Schnittstelle kopiert: Object2IntMap

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 Object2IntMap.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>,Integer>

Setzt außer Kraft:

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

containsValue

public boolean containsValue(int value)

Beschreibung aus Schnittstelle kopiert: Object2IntMap

Type Specific method to reduce boxing/unboxing of values

Angegeben von:

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

Setzt außer Kraft:

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

Parameter:

value - element that is searched for

Gibt zurück:

if the value is present

remove

public Integer remove(Object key)

Angegeben von:

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

Angegeben von:

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

Setzt außer Kraft:

remove in Klasse AbstractObject2IntMap<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 int rem(T key)

Beschreibung aus Schnittstelle kopiert: Object2IntMap

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 int remOrDefault(T key,
 int defaultValue)

Beschreibung aus Schnittstelle kopiert: Object2IntMap

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,
 int value)

Beschreibung aus Schnittstelle kopiert: Object2IntMap

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)

getInt

public int getInt(T key)

Beschreibung aus Schnittstelle kopiert: Object2IntMap

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 int getOrDefault(T key,
 int defaultValue)

Beschreibung aus Schnittstelle kopiert: Object2IntMap

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 Enum2IntMap<T> copy()

Beschreibung aus Schnittstelle kopiert: Object2IntMap

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 Object2IntMap<T extends Enum<T>>

Setzt außer Kraft:

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

Gibt zurück:

a Shallow Copy of the Map

object2IntEntrySet

public ObjectSet<Object2IntMap.Entry<T>> object2IntEntrySet()

Beschreibung aus Schnittstelle kopiert: Object2IntMap

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>,Integer>

Angegeben von:

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

Setzt außer Kraft:

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

values

public IntCollection values()

Angegeben von:

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

Angegeben von:

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

Setzt außer Kraft:

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

forEach

public void forEach(ObjectIntConsumer<T> action)

Beschreibung aus Schnittstelle kopiert: Object2IntMap

Type Specific forEach method to reduce boxing/unboxing

Angegeben von:

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

Setzt außer Kraft:

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

Parameter:

action - processor of the values that are iterator over

replace

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

Beschreibung aus Schnittstelle kopiert: Object2IntMap

A Type Specific replace method to replace an existing value

Angegeben von:

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

Setzt außer Kraft:

replace in Klasse AbstractObject2IntMap<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 int replace(T key,
 int value)

Beschreibung aus Schnittstelle kopiert: Object2IntMap

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

Angegeben von:

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

Setzt außer Kraft:

replace in Klasse AbstractObject2IntMap<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

computeInt

public int computeInt(T key,
 ObjectIntUnaryOperator<T> mappingFunction)

Beschreibung aus Schnittstelle kopiert: Object2IntMap

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:

computeInt in Schnittstelle Object2IntMap<T extends Enum<T>>

Setzt außer Kraft:

computeInt in Klasse AbstractObject2IntMap<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

computeIntIfAbsent

public int computeIntIfAbsent(T key,
 ToIntFunction<T> mappingFunction)

Beschreibung aus Schnittstelle kopiert: Object2IntMap

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:

computeIntIfAbsent in Schnittstelle Object2IntMap<T extends Enum<T>>

Setzt außer Kraft:

computeIntIfAbsent in Klasse AbstractObject2IntMap<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

supplyIntIfAbsent

public int supplyIntIfAbsent(T key,
 IntSupplier valueProvider)

Beschreibung aus Schnittstelle kopiert: Object2IntMap

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:

supplyIntIfAbsent in Schnittstelle Object2IntMap<T extends Enum<T>>

Setzt außer Kraft:

supplyIntIfAbsent in Klasse AbstractObject2IntMap<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

computeIntIfPresent

public int computeIntIfPresent(T key,
 ObjectIntUnaryOperator<T> mappingFunction)

Beschreibung aus Schnittstelle kopiert: Object2IntMap

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:

computeIntIfPresent in Schnittstelle Object2IntMap<T extends Enum<T>>

Setzt außer Kraft:

computeIntIfPresent in Klasse AbstractObject2IntMap<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

computeIntNonDefault

public int computeIntNonDefault(T key,
 ObjectIntUnaryOperator<T> mappingFunction)

Beschreibung aus Schnittstelle kopiert: Object2IntMap

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:

computeIntNonDefault in Schnittstelle Object2IntMap<T extends Enum<T>>

Setzt außer Kraft:

computeIntNonDefault in Klasse AbstractObject2IntMap<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

computeIntIfAbsentNonDefault

public int computeIntIfAbsentNonDefault(T key,
 ToIntFunction<T> mappingFunction)

Beschreibung aus Schnittstelle kopiert: Object2IntMap

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:

computeIntIfAbsentNonDefault in Schnittstelle Object2IntMap<T extends Enum<T>>

Setzt außer Kraft:

computeIntIfAbsentNonDefault in Klasse AbstractObject2IntMap<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

supplyIntIfAbsentNonDefault

public int supplyIntIfAbsentNonDefault(T key,
 IntSupplier valueProvider)

Beschreibung aus Schnittstelle kopiert: Object2IntMap

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:

supplyIntIfAbsentNonDefault in Schnittstelle Object2IntMap<T extends Enum<T>>

Setzt außer Kraft:

supplyIntIfAbsentNonDefault in Klasse AbstractObject2IntMap<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

computeIntIfPresentNonDefault

public int computeIntIfPresentNonDefault(T key,
 ObjectIntUnaryOperator<T> mappingFunction)

Beschreibung aus Schnittstelle kopiert: Object2IntMap

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:

computeIntIfPresentNonDefault in Schnittstelle Object2IntMap<T extends Enum<T>>

Setzt außer Kraft:

computeIntIfPresentNonDefault in Klasse AbstractObject2IntMap<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

mergeInt

public int mergeInt(T key,
 int value,
 IntIntUnaryOperator mappingFunction)

Beschreibung aus Schnittstelle kopiert: Object2IntMap

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:

mergeInt in Schnittstelle Object2IntMap<T extends Enum<T>>

Setzt außer Kraft:

mergeInt in Klasse AbstractObject2IntMap<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

mergeAllInt

public void mergeAllInt(Object2IntMap<T> m,
 IntIntUnaryOperator mappingFunction)

Beschreibung aus Schnittstelle kopiert: Object2IntMap

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:

mergeAllInt in Schnittstelle Object2IntMap<T extends Enum<T>>

Setzt außer Kraft:

mergeAllInt in Klasse AbstractObject2IntMap<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>,Integer>

Setzt außer Kraft:

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

size

public int size()

Angegeben von:

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

Setzt außer Kraft:

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