Package de.svws_nrw.core.adt.map

Klasse HashMap5D<K1,K2,K3,K4,K5,V>

java.lang.Object

de.svws_nrw.core.adt.map.HashMap5D<K1,K2,K3,K4,K5,V>

Typparameter:

K1 - Der Typ des 1. Schlüsselwertes des Quintupels(key1, key2, key3, key4, key5).

K2 - Der Typ des 2. Schlüsselwertes des Quintupels(key1, key2, key3, key4, key5).

K3 - Der Typ des 3. Schlüsselwertes des Quintupels(key1, key2, key3, key4, key5).

K4 - Der Typ des 4. Schlüsselwertes des Quintupels(key1, key2, key3, key4, key5).

K5 - Der Typ des 4. Schlüsselwertes des Quintupels(key1, key2, key3, key4, key5).

V - Der Typ des zugeordneten Wertes.

public class HashMap5D<K1,K2,K3,K4,K5,V>
extends Object

Eine 5D-Map ist ein Mapping von vier Schlüsseln auf einen Wert.

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
HashMap5D()	Konstruktor.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	clear()	Löscht alle Zuordnungen der Map.
boolean	contains(K1 key1, K2 key2, K3 key3, K4 key4, K5 key5)	Liefert TRUE, falls für das Quadrupel (key1, key2, key3, key4) ein Mapping existiert.
@NotNull Set<K1>	getKeySet()	Liefert das KeySet des 1.
HashMap4D<K2,K3,K4,K5,V>	getMap2OrNull(K1 key1)	Liefert die Map zum Mapping (key1) oder NULL.
Map<K3,Map<K4,Map<K5,V>>>	getMap3OrNull(K1 key1, K2 key2)	Liefert die Map zum Mapping (key1, key2) oder NULL.
Map<K4,Map<K5,V>>	getMap4OrNull(K1 key1, K2 key2, K3 key3)	Liefert die Map zum Mapping (key1, key2, key3) oder NULL.
Map<K5,V>	getMap5OrNull(K1 key1, K2 key2, K3 key3, K4 key4)	Liefert die Map zum Mapping (key1, key2, key3) oder NULL.
V	getNonNullOrException(K1 key1, K2 key2, K3 key3, K4 key4, K5 key5)	Liefert den Nicht-Null-Wert zum Mapping (key1, key2, key3, key4). Wirft eine Exception, falls der Pfad (key1, key2, key3, key4) nicht existiert, oder NULL zugeordnet ist.
@NotNull List<V>	getNonNullValuesAsList()	Liefert eine Liste aller Values in dieser Map.
@NotNull List<V>	getNonNullValuesOfMap2AsList(K1 key1)	Liefert eine Liste aller Values zum Mapping (key1)
@NotNull List<V>	getNonNullValuesOfMap3AsList(K1 key1, K2 key2)	Liefert eine Liste aller Values zum Mapping (key1, key2)
@NotNull List<V>	getNonNullValuesOfMap4AsList(K1 key1, K2 key2, K3 key3)	Liefert eine Liste aller Values zum Mapping (key1, key2, key3)
@NotNull List<V>	getNonNullValuesOfMap5AsList(K1 key1, K2 key2, K3 key3, K4 key4)	Liefert eine Liste aller Values zum Mapping (key1, key2, key3)
V	getOrException(K1 key1, K2 key2, K3 key3, K4 key4, K5 key5)	Liefert den Wert zum Mapping (key1, key2, key3, key4).
V	getOrNull(K1 key1, K2 key2, K3 key3, K4 key4, K5 key5)	Liefert den Wert zum Mapping (key1, key2, key3, key4) oder NULL.
void	put(K1 key1, K2 key2, K3 key3, K4 key4, K5 key5, V value)	Fügt die Zuordnung der Map hinzu.
void	remove(K1 key1, K2 key2, K3 key3, K4 key4, K5 key5)	Entfernt das Mapping (key1, key2, key3, key4) falls es existiert .
void	removeMap1(K1 key1)	Entfernt das Mapping (key1) falls es existiert
void	removeMap2(K1 key1, K2 key2)	Entfernt das Mapping (key1, key2) falls es existiert
V	removeOrException(K1 key1, K2 key2, K3 key3, K4 key4, K5 key5)	Entfernt das Mapping (key1, key2, key3, key4) falls es existiert .

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Konstruktordetails

HashMap5D

public HashMap5D()

Konstruktor.

Methodendetails

put

public void put(@NotNull
 K1 key1,
 @NotNull
 K2 key2,
 @NotNull
 K3 key3,
 @NotNull
 K4 key4,
 @NotNull
 K5 key5,
 @NotNull
 V value)

Fügt die Zuordnung der Map hinzu. Falls es einen Teil-Pfad von (key1, key2, key3, key4, key5) nicht gibt, wird er erzeugt.

Parameter:

key1 - Der 1. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key2 - Der 2. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key3 - Der 3. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key4 - Der 4. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key5 - Der 4. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

value - Der zugeordnete Wert. Der Wert null ist erlaubt.

getOrException

public V getOrException(@NotNull
 K1 key1,
 @NotNull
 K2 key2,
 @NotNull
 K3 key3,
 @NotNull
 K4 key4,
 @NotNull
 K5 key5)
                 throws NullPointerException

Liefert den Wert zum Mapping (key1, key2, key3, key4).
Wirft eine Exception, falls es den Pfad (key1, key2, key3, key4) nicht gibt.

Parameter:

key1 - Der 1. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key2 - Der 2. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key3 - Der 3. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key4 - Der 4. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key5 - Der 5. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

Gibt zurück:

Den Wert zum Mapping (key1, key2, key3, key4).

Löst aus:

NullPointerException - falls es den Pfad (key1, key2, key3, key4) nicht gibt.

getOrNull

public V getOrNull(@NotNull
 K1 key1,
 @NotNull
 K2 key2,
 @NotNull
 K3 key3,
 @NotNull
 K4 key4,
 @NotNull
 K5 key5)

Liefert den Wert zum Mapping (key1, key2, key3, key4) oder NULL.

Parameter:

key1 - Der 1. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key2 - Der 2. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key3 - Der 3. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key4 - Der 4. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key5 - Der 5. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

Gibt zurück:

den Wert zum Mapping (key1, key2, key3, key4) oder NULL.

getMap2OrNull

public HashMap4D<K2,K3,K4,K5,V> getMap2OrNull(@NotNull
 K1 key1)

Liefert die Map zum Mapping (key1) oder NULL.

Parameter:

key1 - Der 1. Schlüssel.

Gibt zurück:

die Map zum Mapping key1 oder NULL.

getMap3OrNull

public Map<K3,Map<K4,Map<K5,V>>> getMap3OrNull(@NotNull
 K1 key1,
 @NotNull
 K2 key2)

Liefert die Map zum Mapping (key1, key2) oder NULL.

Parameter:

key1 - Der 1. Schlüssel des Paares(key1, key2).

key2 - Der 2. Schlüssel des Paares(key1, key2).

Gibt zurück:

die Map zum Mapping (key1, key2) oder NULL.

getMap4OrNull

public Map<K4,Map<K5,V>> getMap4OrNull(@NotNull
 K1 key1,
 @NotNull
 K2 key2,
 @NotNull
 K3 key3)

Liefert die Map zum Mapping (key1, key2, key3) oder NULL.

Parameter:

key1 - Der 1. Schlüssel des Tripels(key1, key2, key3).

key2 - Der 2. Schlüssel des Tripels(key1, key2, key3).

key3 - Der 3. Schlüssel des Tripels(key1, key2, key3).

Gibt zurück:

die Map zum Mapping (key1, key2) oder NULL.

getMap5OrNull

public Map<K5,V> getMap5OrNull(@NotNull
 K1 key1,
 @NotNull
 K2 key2,
 @NotNull
 K3 key3,
 @NotNull
 K4 key4)

Liefert die Map zum Mapping (key1, key2, key3) oder NULL.

Parameter:

key1 - Der 1. Schlüssel des Tripels(key1, key2, key3).

key2 - Der 2. Schlüssel des Tripels(key1, key2, key3).

key3 - Der 3. Schlüssel des Tripels(key1, key2, key3).

key4 - Der 4. Schlüssel des Tripels(key1, key2, key3).

Gibt zurück:

die Map zum Mapping (key1, key2) oder NULL.

getNonNullOrException

@NotNull
public V getNonNullOrException(@NotNull
 K1 key1,
 @NotNull
 K2 key2,
 @NotNull
 K3 key3,
 @NotNull
 K4 key4,
 @NotNull
 K5 key5)
                        throws NullPointerException

Liefert den Nicht-Null-Wert zum Mapping (key1, key2, key3, key4).
Wirft eine Exception, falls der Pfad (key1, key2, key3, key4) nicht existiert, oder NULL zugeordnet ist.

Parameter:

key1 - Der 1. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key2 - Der 2. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key3 - Der 3. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key4 - Der 4. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key5 - Der 5. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

Gibt zurück:

den Nicht-Null-Wert zum Mapping (key1, key2, key3).

Löst aus:

NullPointerException - falls der Pfad (key1, key2, key3) nicht existiert, oder NULL zugeordnet ist.

contains

public boolean contains(@NotNull
 K1 key1,
 @NotNull
 K2 key2,
 @NotNull
 K3 key3,
 @NotNull
 K4 key4,
 @NotNull
 K5 key5)

Liefert TRUE, falls für das Quadrupel (key1, key2, key3, key4) ein Mapping existiert.

Parameter:

key1 - Der 1. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key2 - Der 2. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key3 - Der 3. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key4 - Der 4. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key5 - Der 5. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

Gibt zurück:

TRUE, falls für das Quadrupel (key1, key2, key3, key4) ein Mapping existiert.

clear

public void clear()

Löscht alle Zuordnungen der Map.

removeOrException

@NotNull
public V removeOrException(@NotNull
 K1 key1,
 @NotNull
 K2 key2,
 @NotNull
 K3 key3,
 @NotNull
 K4 key4,
 @NotNull
 K5 key5)

Entfernt das Mapping (key1, key2, key3, key4) falls es existiert
. Wirft eine DeveloperNotificationException, falls das Mapping nicht existiert.

Parameter:

key1 - Der 1. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key2 - Der 2. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key3 - Der 3. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key4 - Der 4. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key5 - Der 5. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

Gibt zurück:

der dem Mapping vor dem Entfernen zugeordnete Wert, falls vorhanden.

remove

public void remove(@NotNull
 K1 key1,
 @NotNull
 K2 key2,
 @NotNull
 K3 key3,
 @NotNull
 K4 key4,
 @NotNull
 K5 key5)

Entfernt das Mapping (key1, key2, key3, key4) falls es existiert
.

Parameter:

key1 - Der 1. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key2 - Der 2. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key3 - Der 3. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key4 - Der 4. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

key5 - Der 5. Schlüssel des Quintupels(key1, key2, key3, key4, key5).

removeMap1

public void removeMap1(@NotNull
 K1 key1)

Entfernt das Mapping (key1) falls es existiert

Parameter:

key1 - Der 1. Schlüssel.

removeMap2

public void removeMap2(@NotNull
 K1 key1,
 @NotNull
 K2 key2)

Entfernt das Mapping (key1, key2) falls es existiert

Parameter:

key1 - Der 1. Schlüssel.

key2 - Der 2. Schlüssel.

getKeySet

@NotNull
public @NotNull Set<K1> getKeySet()

Liefert das KeySet des 1. Schlüssels.

Gibt zurück:

das KeySet der SubMap des 1. Schlüssels.

getNonNullValuesAsList

@NotNull
public @NotNull List<V> getNonNullValuesAsList()

Liefert eine Liste aller Values in dieser Map.

Gibt zurück:

eine Liste aller Values in dieser Map.

getNonNullValuesOfMap2AsList

@NotNull
public @NotNull List<V> getNonNullValuesOfMap2AsList(@NotNull
 K1 key1)

Liefert eine Liste aller Values zum Mapping (key1)

Parameter:

key1 - Schlüssel

Gibt zurück:

eine Liste aller Values in dieser Map.

getNonNullValuesOfMap3AsList

@NotNull
public @NotNull List<V> getNonNullValuesOfMap3AsList(@NotNull
 K1 key1,
 @NotNull
 K2 key2)

Liefert eine Liste aller Values zum Mapping (key1, key2)

Parameter:

key1 - Der 1. Schlüssel des Paares(key1, key2).

key2 - Der 2. Schlüssel des Paares(key1, key2).

Gibt zurück:

eine Liste aller Values in dieser Map.

getNonNullValuesOfMap4AsList

@NotNull
public @NotNull List<V> getNonNullValuesOfMap4AsList(@NotNull
 K1 key1,
 @NotNull
 K2 key2,
 @NotNull
 K3 key3)

Liefert eine Liste aller Values zum Mapping (key1, key2, key3)

Parameter:

key1 - Der 1. Schlüssel des Tripels(key1, key2, key3).

key2 - Der 2. Schlüssel des Tripels(key1, key2, key3).

key3 - Der 3. Schlüssel des Tripels(key1, key2, key3).

Gibt zurück:

eine Liste aller Values in dieser Map.

getNonNullValuesOfMap5AsList

@NotNull
public @NotNull List<V> getNonNullValuesOfMap5AsList(@NotNull
 K1 key1,
 @NotNull
 K2 key2,
 @NotNull
 K3 key3,
 @NotNull
 K4 key4)

Liefert eine Liste aller Values zum Mapping (key1, key2, key3)

Parameter:

key1 - Der 1. Schlüssel des Tripels(key1, key2, key3).

key2 - Der 2. Schlüssel des Tripels(key1, key2, key3).

key3 - Der 3. Schlüssel des Tripels(key1, key2, key3).

key4 - Der 4. Schlüssel des Tripels(key1, key2, key3).

Gibt zurück:

eine Liste aller Values in dieser Map.