Modul speiger.src.collections

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

Klasse Object2ObjectOpenHashMap<T,V>

java.lang.Object

java.util.AbstractMap<T,V>

speiger.src.collections.objects.maps.abstracts.AbstractObject2ObjectMap<T,V>

speiger.src.collections.objects.maps.impl.hash.Object2ObjectOpenHashMap<T,V>

Typparameter:

T - the keyType of elements maintained by this Collection

V - the keyType of elements maintained by this Collection

Alle implementierten Schnittstellen:

Function<T,V>, Map<T,V>, UnaryOperator<T,V>, Object2ObjectMap<T,V>, ITrimmable

Bekannte direkte Unterklassen:

Object2ObjectLinkedOpenHashMap

public class Object2ObjectOpenHashMap<T,V>
extends AbstractObject2ObjectMap<T,V>
implements ITrimmable

A Type Specific Custom implementation of the HashMap Instead of using Wrapper Object Arrays for storing keys and values there is dedicated arrays for storing keys and values. Extra to that there is a couple quality of life functions provided

Verschachtelte Klassen - Übersicht

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

AbstractObject2ObjectMap.BasicEntry<T,V>

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.Object2ObjectMap

Object2ObjectMap.BuilderCache<T,V>, Object2ObjectMap.Entry<T,V>, Object2ObjectMap.FastEntrySet<T,V>, Object2ObjectMap.MapBuilder

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
Object2ObjectOpenHashMap()	Default Constructor
Object2ObjectOpenHashMap(int minCapacity)	Constructor that defines the minimum capacity
Object2ObjectOpenHashMap(int minCapacity, float loadFactor)	Constructor that defines the minimum capacity and load factor
Object2ObjectOpenHashMap(Map<? extends T,? extends V> map)	A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Object2ObjectOpenHashMap(Map<? extends T,? extends V> map, float loadFactor)	A Helper constructor that allows to create a Map with exactly the same values as the provided map.
Object2ObjectOpenHashMap(Object2ObjectMap<T,V> map)	A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Object2ObjectOpenHashMap(Object2ObjectMap<T,V> map, float loadFactor)	A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
Object2ObjectOpenHashMap(T[] keys, V[] values)	Helper constructor that allow to create a map from unboxed values
Object2ObjectOpenHashMap(T[] keys, V[] values, float loadFactor)	Helper constructor that allow to create a map from unboxed values

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	clear()
void	clearAndTrim(int size)	Trims the collection down to the requested size and clears all elements while doing so
V	compute(T key, ObjectObjectUnaryOperator<T,V> 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".
V	computeIfAbsent(T key, UnaryOperator<T,V> 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".
V	computeIfPresent(T key, ObjectObjectUnaryOperator<T,V> 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(Object value)
Object2ObjectOpenHashMap<T,V>	copy()	A Function that does a shallow clone of the Map itself.
void	forEach(ObjectObjectConsumer<T,V> action)	Type Specific forEach method to reduce boxing/unboxing
V	get(Object key)
V	getObject(T key)	A Type Specific get method to reduce boxing/unboxing
V	getOrDefault(Object key, V defaultValue)
ObjectSet<T>	keySet()
V	merge(T key, V value, ObjectObjectUnaryOperator<V,V> 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".
void	mergeAll(Object2ObjectMap<T,V> m, ObjectObjectUnaryOperator<V,V> mappingFunction)	A Bulk method for merging Maps.
ObjectSet<Object2ObjectMap.Entry<T,V>>	object2ObjectEntrySet()	Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
V	put(T key, V value)	Type Specific method to reduce boxing/unboxing of values
V	putIfAbsent(T key, V value)	Type Specific method to reduce boxing/unboxing of values
V	rem(T key)	Type Specific remove function to reduce boxing/unboxing
V	remOrDefault(T key, V defaultValue)	Type-Specific Remove function with a default return value if wanted.
V	remove(Object key)
boolean	remove(Object key, Object value)
V	replace(T key, V value)	A Type Specific replace method to reduce boxing/unboxing replace an existing value
boolean	replace(T key, V oldValue, V newValue)	A Type Specific replace method to replace an existing value
int	size()
V	supplyIfAbsent(T key, ObjectSupplier<V> 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".
boolean	trim(int size)	Trims the original collection down to the size of the current elements or the requested size depending which is bigger
ObjectCollection<V>	values()

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

entrySet, equals, getDefaultReturnValue, hashCode, putAll, putAll, putAll, putAllIfAbsent, replaceObjects, replaceObjects, setDefaultReturnValue

Von Klasse geerbte Methoden java.util.AbstractMap

isEmpty, toString

Von Klasse geerbte Methoden java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Von Schnittstelle geerbte Methoden java.util.function.Function

andThen, compose

Von Schnittstelle geerbte Methoden speiger.src.collections.utils.ITrimmable

clearAndTrim, trim

Von Schnittstelle geerbte Methoden java.util.Map

isEmpty

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

apply, compute, computeIfAbsent, computeIfPresent, forEach, merge, put, putAll, replaceAll, synchronize, synchronize, unmodifiable

Von Schnittstelle geerbte Methoden speiger.src.collections.objects.functions.function.UnaryOperator

andThen, compose

Konstruktordetails

Object2ObjectOpenHashMap

public Object2ObjectOpenHashMap()

Default Constructor

Object2ObjectOpenHashMap

public Object2ObjectOpenHashMap(int minCapacity)

Constructor that defines the minimum capacity

Parameter:

minCapacity - the minimum capacity the HashMap is allowed to be.

Löst aus:

IllegalStateException - if the minimum capacity is negative

Object2ObjectOpenHashMap

public Object2ObjectOpenHashMap(int minCapacity,
 float loadFactor)

Constructor that defines the minimum capacity and load factor

Parameter:

minCapacity - the minimum capacity the HashMap is allowed to be.

loadFactor - the percentage of how full the backing array can be before they resize

Löst aus:

IllegalStateException - if the minimum capacity is negative

IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

Object2ObjectOpenHashMap

public Object2ObjectOpenHashMap(T[] keys,
 V[] values)

Helper constructor that allow to create a map 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

Object2ObjectOpenHashMap

public Object2ObjectOpenHashMap(T[] keys,
 V[] values,
 float loadFactor)

Helper constructor that allow to create a map from unboxed values

Parameter:

keys - the keys that should be put into the map

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

loadFactor - the percentage of how full the backing array can be before they resize

Löst aus:

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

IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

Object2ObjectOpenHashMap

public Object2ObjectOpenHashMap(Map<? extends T,? extends V> map)

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

Parameter:

map - the values that should be present in the map

Object2ObjectOpenHashMap

public Object2ObjectOpenHashMap(Map<? extends T,? extends V> map,
 float loadFactor)

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

Parameter:

map - the values that should be present in the map

loadFactor - the percentage of how full the backing array can be before they resize

Löst aus:

IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

Object2ObjectOpenHashMap

public Object2ObjectOpenHashMap(Object2ObjectMap<T,V> map)

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

Parameter:

map - the values that should be present in the map

Object2ObjectOpenHashMap

public Object2ObjectOpenHashMap(Object2ObjectMap<T,V> map,
 float loadFactor)

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

Parameter:

map - the values that should be present in the map

loadFactor - the percentage of how full the backing array can be before they resize

Löst aus:

IllegalStateException - if the loadfactor is either below/equal to 0 or above/equal to 1

Methodendetails

put

public V put(T key,
 V value)

Beschreibung aus Schnittstelle kopiert: Object2ObjectMap

Type Specific method to reduce boxing/unboxing of values

Angegeben von:

put in Schnittstelle Map<T,V>

Angegeben von:

put in Schnittstelle Object2ObjectMap<T,V>

Setzt außer Kraft:

put in Klasse AbstractMap<T,V>

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

Beschreibung aus Schnittstelle kopiert: Object2ObjectMap

Type Specific method to reduce boxing/unboxing of values

Angegeben von:

putIfAbsent in Schnittstelle Map<T,V>

Angegeben von:

putIfAbsent in Schnittstelle Object2ObjectMap<T,V>

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)

containsKey

public boolean containsKey(Object key)

Angegeben von:

containsKey in Schnittstelle Map<T,V>

Setzt außer Kraft:

containsKey in Klasse AbstractObject2ObjectMap<T,V>

containsValue

public boolean containsValue(Object value)

Angegeben von:

containsValue in Schnittstelle Map<T,V>

Setzt außer Kraft:

containsValue in Klasse AbstractObject2ObjectMap<T,V>

rem

public V rem(T key)

Beschreibung aus Schnittstelle kopiert: Object2ObjectMap

Type Specific remove function to reduce boxing/unboxing

Angegeben von:

rem in Schnittstelle Object2ObjectMap<T,V>

Parameter:

key - the element that should be removed

Gibt zurück:

the value that was removed or default return value

remOrDefault

public V remOrDefault(T key,
 V defaultValue)

Beschreibung aus Schnittstelle kopiert: Object2ObjectMap

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

Angegeben von:

remOrDefault in Schnittstelle Object2ObjectMap<T,V>

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 V remove(Object key)

Angegeben von:

remove in Schnittstelle Map<T,V>

Angegeben von:

remove in Schnittstelle Object2ObjectMap<T,V>

Setzt außer Kraft:

remove in Klasse AbstractObject2ObjectMap<T,V>

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)

remove

public boolean remove(Object key,
 Object value)

Angegeben von:

remove in Schnittstelle Map<T,V>

getObject

public V getObject(T key)

Beschreibung aus Schnittstelle kopiert: Object2ObjectMap

A Type Specific get method to reduce boxing/unboxing

Angegeben von:

getObject in Schnittstelle Object2ObjectMap<T,V>

Parameter:

key - the key that is searched for

Gibt zurück:

the searched value or default return value

get

public V get(Object key)

Angegeben von:

get in Schnittstelle Map<T,V>

Setzt außer Kraft:

get in Klasse AbstractObject2ObjectMap<T,V>

getOrDefault

public V getOrDefault(Object key,
 V defaultValue)

Angegeben von:

getOrDefault in Schnittstelle Map<T,V>

Setzt außer Kraft:

getOrDefault in Klasse AbstractObject2ObjectMap<T,V>

copy

public Object2ObjectOpenHashMap<T,V> copy()

Beschreibung aus Schnittstelle kopiert: Object2ObjectMap

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 Object2ObjectMap<T,V>

Setzt außer Kraft:

copy in Klasse AbstractObject2ObjectMap<T,V>

Gibt zurück:

a Shallow Copy of the Map

object2ObjectEntrySet

public ObjectSet<Object2ObjectMap.Entry<T,V>> object2ObjectEntrySet()

Beschreibung aus Schnittstelle kopiert: Object2ObjectMap

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

Angegeben von:

object2ObjectEntrySet in Schnittstelle Object2ObjectMap<T,V>

Gibt zurück:

a EntrySet of the collection

keySet

public ObjectSet<T> keySet()

Angegeben von:

keySet in Schnittstelle Map<T,V>

Angegeben von:

keySet in Schnittstelle Object2ObjectMap<T,V>

Setzt außer Kraft:

keySet in Klasse AbstractObject2ObjectMap<T,V>

values

public ObjectCollection<V> values()

Angegeben von:

values in Schnittstelle Map<T,V>

Angegeben von:

values in Schnittstelle Object2ObjectMap<T,V>

Setzt außer Kraft:

values in Klasse AbstractObject2ObjectMap<T,V>

forEach

public void forEach(ObjectObjectConsumer<T,V> action)

Beschreibung aus Schnittstelle kopiert: Object2ObjectMap

Type Specific forEach method to reduce boxing/unboxing

Angegeben von:

forEach in Schnittstelle Object2ObjectMap<T,V>

Setzt außer Kraft:

forEach in Klasse AbstractObject2ObjectMap<T,V>

Parameter:

action - processor of the values that are iterator over

replace

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

Beschreibung aus Schnittstelle kopiert: Object2ObjectMap

A Type Specific replace method to replace an existing value

Angegeben von:

replace in Schnittstelle Map<T,V>

Angegeben von:

replace in Schnittstelle Object2ObjectMap<T,V>

Setzt außer Kraft:

replace in Klasse AbstractObject2ObjectMap<T,V>

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 V replace(T key,
 V value)

Beschreibung aus Schnittstelle kopiert: Object2ObjectMap

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

Angegeben von:

replace in Schnittstelle Map<T,V>

Angegeben von:

replace in Schnittstelle Object2ObjectMap<T,V>

Setzt außer Kraft:

replace in Klasse AbstractObject2ObjectMap<T,V>

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

compute

public V compute(T key,
 ObjectObjectUnaryOperator<T,V> mappingFunction)

Beschreibung aus Schnittstelle kopiert: Object2ObjectMap

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:

compute in Schnittstelle Object2ObjectMap<T,V>

Setzt außer Kraft:

compute in Klasse AbstractObject2ObjectMap<T,V>

Parameter:

key - the key that should be computed

mappingFunction - the operator that should generate the value

Gibt zurück:

the result of the computation

computeIfAbsent

public V computeIfAbsent(T key,
 UnaryOperator<T,V> mappingFunction)

Beschreibung aus Schnittstelle kopiert: Object2ObjectMap

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:

computeIfAbsent in Schnittstelle Object2ObjectMap<T,V>

Setzt außer Kraft:

computeIfAbsent in Klasse AbstractObject2ObjectMap<T,V>

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

supplyIfAbsent

public V supplyIfAbsent(T key,
 ObjectSupplier<V> valueProvider)

Beschreibung aus Schnittstelle kopiert: Object2ObjectMap

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:

supplyIfAbsent in Schnittstelle Object2ObjectMap<T,V>

Setzt außer Kraft:

supplyIfAbsent in Klasse AbstractObject2ObjectMap<T,V>

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

computeIfPresent

public V computeIfPresent(T key,
 ObjectObjectUnaryOperator<T,V> mappingFunction)

Beschreibung aus Schnittstelle kopiert: Object2ObjectMap

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:

computeIfPresent in Schnittstelle Object2ObjectMap<T,V>

Setzt außer Kraft:

computeIfPresent in Klasse AbstractObject2ObjectMap<T,V>

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

merge

public V merge(T key,
 V value,
 ObjectObjectUnaryOperator<V,V> mappingFunction)

Beschreibung aus Schnittstelle kopiert: Object2ObjectMap

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:

merge in Schnittstelle Object2ObjectMap<T,V>

Setzt außer Kraft:

merge in Klasse AbstractObject2ObjectMap<T,V>

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

mergeAll

public void mergeAll(Object2ObjectMap<T,V> m,
 ObjectObjectUnaryOperator<V,V> mappingFunction)

Beschreibung aus Schnittstelle kopiert: Object2ObjectMap

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:

mergeAll in Schnittstelle Object2ObjectMap<T,V>

Setzt außer Kraft:

mergeAll in Klasse AbstractObject2ObjectMap<T,V>

Parameter:

m - the entries that should be bulk added

mappingFunction - the operator that should generate the new Value

size

public int size()

Angegeben von:

size in Schnittstelle Map<T,V>

Setzt außer Kraft:

size in Klasse AbstractMap<T,V>

clear

public void clear()

Angegeben von:

clear in Schnittstelle Map<T,V>

Setzt außer Kraft:

clear in Klasse AbstractMap<T,V>

trim

public boolean trim(int size)

Beschreibung aus Schnittstelle kopiert: ITrimmable

Trims the original collection down to the size of the current elements or the requested size depending which is bigger

Angegeben von:

trim in Schnittstelle ITrimmable

Parameter:

size - the requested trim size.

Gibt zurück:

if the internal array has been trimmed.

clearAndTrim

public void clearAndTrim(int size)

Beschreibung aus Schnittstelle kopiert: ITrimmable

Trims the collection down to the requested size and clears all elements while doing so

Angegeben von:

clearAndTrim in Schnittstelle ITrimmable

Parameter:

size - the amount of elements that should be allowed