Package de.svws_nrw.core.adt.map

Klasse HashMap3D<K1,K2,K3,V>

java.lang.Object

de.svws_nrw.core.adt.map.HashMap3D<K1,K2,K3,V>

Typparameter:

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

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

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

V - Der Typ des zugeordneten Wertes.

public class HashMap3D<K1,K2,K3,V>
extends Object

Eine 3D-Map ist ein Mapping von drei Schlüsseln auf einen Wert.

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
HashMap3D()	Konstruktor.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	clear()	Löscht alle Zuordnungen der Map.
boolean	contains(K1 key1, K2 key2, K3 key3)	Liefert TRUE, falls für das Tripel (key1, key2, key3) ein Mapping existiert.
boolean	containsKey1(K1 key1)	Liefert TRUE, falls es den Teilpfad gibt.
boolean	containsKey1AndKey2(K1 key1, K2 key2)	Liefert TRUE, falls es den Teilpfad gibt.
@NotNull Set<Map.Entry<K1,Map<K2,Map<K3,V>>>>	getEntrySet()	Liefert das EntrySet des 1.
@NotNull Set<K1>	getKeySet()	Liefert das KeySet des 1.
Map<K2,Map<K3,V>>	getMap2OrNull(K1 key1)	Liefert die Map zum Mapping (key1) oder NULL.
Map<K3,V>	getMap3OrNull(K1 key1, K2 key2)	Liefert die Map zum Mapping (key1, key2) oder NULL.
V	getNonNullOrException(K1 key1, K2 key2, K3 key3)	Liefert den Nicht-Null-Wert zum Mapping (key1, key2, key3). Wirft eine Exception, falls der Pfad (key1, key2, key3) 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)
V	getOrException(K1 key1, K2 key2, K3 key3)	Liefert den Wert zum Mapping (key1, key2, key3).
V	getOrNull(K1 key1, K2 key2, K3 key3)	Liefert den Wert zum Mapping (key1, key2, key3) oder NULL.
void	put(K1 key1, K2 key2, K3 key3, V value)	Fügt die Zuordnung der Map hinzu.
void	remove(K1 key1, K2 key2, K3 key3)	Entfernt das Mapping (key1, key2, key3) falls es existiert .
void	removeOrException(K1 key1, K2 key2, K3 key3)	Entfernt das Mapping (key1, key2, key3) falls es existiert .

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

HashMap3D

public HashMap3D()

Konstruktor.

Methodendetails

put

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

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

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

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

getOrException

@NotNull
public V getOrException(@NotNull
 K1 key1,
 @NotNull
 K2 key2,
 @NotNull
 K3 key3)
                 throws DeveloperNotificationException

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

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:

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

Löst aus:

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

getOrNull

public V getOrNull(@NotNull
 K1 key1,
 @NotNull
 K2 key2,
 @NotNull
 K3 key3)

Liefert den Wert 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:

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

getMap2OrNull

public Map<K2,Map<K3,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,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.

getNonNullOrException

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

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

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:

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.

containsKey1

public boolean containsKey1(@NotNull
 K1 key1)

Liefert TRUE, falls es den Teilpfad gibt.

Parameter:

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

Gibt zurück:

TRUE, falls es den Teilpfad gibt.

containsKey1AndKey2

public boolean containsKey1AndKey2(@NotNull
 K1 key1,
 @NotNull
 K2 key2)

Liefert TRUE, falls es den Teilpfad gibt.

Parameter:

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

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

Gibt zurück:

TRUE, falls es den Teilpfad gibt.

contains

public boolean contains(@NotNull
 K1 key1,
 @NotNull
 K2 key2,
 @NotNull
 K3 key3)

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

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:

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

clear

public void clear()

Löscht alle Zuordnungen der Map.

removeOrException

public void removeOrException(@NotNull
 K1 key1,
 @NotNull
 K2 key2,
 @NotNull
 K3 key3)

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

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

remove

public void remove(@NotNull
 K1 key1,
 @NotNull
 K2 key2,
 @NotNull
 K3 key3)

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

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

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.

getEntrySet

@NotNull
public @NotNull Set<Map.Entry<K1,Map<K2,Map<K3,V>>>> getEntrySet()

Liefert das EntrySet des 1. Schlüssels.

Gibt zurück:

das EntrySet 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.