Package de.svws_nrw.core.adt.map

Klasse HashMap2D<K1,K2,V>

java.lang.Object

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

Typparameter:

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

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

V - Der Typ des zugeordneten Wertes.

public class HashMap2D<K1,K2,V>
extends Object

Eine 2D-Map ist ein Mapping von zwei Schlüsseln auf einen Wert.

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
HashMap2D()	Konstruktor.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	clear()	Löscht alle Zuordnungen der Map.
boolean	contains(K1 key1, K2 key2)	Liefert TRUE, falls für den Schlüssel (key1, key2) ein Mapping existiert.
boolean	containsKey1(K1 key1)	Liefert TRUE, falls es den Teilpfad gibt.
@NotNull Set<Map.Entry<K1,Map<K2,V>>>	getEntrySet()	Liefert das EntrySet des 1.
@NotNull Set<K1>	getKeySet()	Liefert das KeySet des 1.
@NotNull Set<K2>	getKeySetOf(K1 key1)	Liefert das KeySet der SubMap des 1.
@NotNull List<V>	getNonNullValuesAsList()	Liefert eine Liste aller Values in dieser Map.
@NotNull List<V>	getNonNullValuesOfKey1AsList(K1 key1)	Liefert eine Liste aller Values des 1.
List<V>	getNonNullValuesOfKey1AsListOrNull(K1 key1)	Liefert eine Liste aller Values des 1.
V	getOrException(K1 key1, K2 key2)	Liefert den Wert zum Mapping (key1, key2).
V	getOrNull(K1 key1, K2 key2)	Liefert den Wert zum Mapping (key1, key2) oder NULL.
@NotNull Map<K2,V>	getSubMapOrException(K1 key1)	Liefert für den Schlüssel (key1) die Map (key2 --> V) oder eine Exception.
Map<K2,V>	getSubMapOrNull(K1 key1)	Liefert für den Schlüssel (key1) die Map (key2 --> V) oder NULL.
int	getSubMapSizeOrZero(K1 key1)	Liefert die Anzahl an Mappings, der des Pfades (key1) oder 0, falls der Pfad nicht existiert.
void	put(K1 key1, K2 key2, V value)	Fügt die Zuordnung der Map hinzu.
V	removeOrException(K1 key1, K2 key2)	Entfernt das Mapping (key1, key2) falls es existiert, andernfalls wird eine DeveloperNotificationException geworfen.
Map<K2,V>	removeSubMap(K1 key1)	Entfernt für den Schlüssel (key1) die Submap, falls key1 existiert, andernfalls passiert nichts.
@NotNull Map<K2,V>	removeSubMapOrException(K1 key1)	Entfernt für den Schlüssel (key1) die Submap, falls key1 existiert, andernfalls wird eine DeveloperNotificationException geworfen.
int	size()	Liefert die Anzahl an gespeicherten Mappings.

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

HashMap2D

public HashMap2D()

Konstruktor.

Methodendetails

put

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

Fügt die Zuordnung der Map hinzu. Falls es den Pfad (key1) oder (key1, key2) nicht gibt, wird er erzeugt.

Parameter:

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

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

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

getOrNull

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

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

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

getOrException

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

Liefert den Wert zum Mapping (key1, key2).
Falls es den Pfad (key1) oder (key1, key2) nicht gibt, wird eine Exception geworfen.

Parameter:

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

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

Gibt zurück:

Den Wert zum Mapping (key1, key2).

Löst aus:

DeveloperNotificationException - Falls ein Teilpfad (key1, key2) nicht existiert!

getSubMapOrException

@NotNull
public @NotNull Map<K2,V> getSubMapOrException(@NotNull
 K1 key1)

Liefert für den Schlüssel (key1) die Map (key2 --> V) oder eine Exception.

Parameter:

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

Gibt zurück:

Für den Schlüssel (key1) die Map (key2 --> V) oder eine Exception.

getSubMapOrNull

public Map<K2,V> getSubMapOrNull(@NotNull
 K1 key1)

Liefert für den Schlüssel (key1) die Map (key2 --> V) oder NULL.

Parameter:

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

Gibt zurück:

Für den Schlüssel (key1) die Map (key2 --> V) oder NULL.

contains

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

Liefert TRUE, falls für den Schlüssel (key1, key2) ein Mapping existiert.

Parameter:

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

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

Gibt zurück:

TRUE, falls für den Schlüssel (key1, key2) ein Mapping existiert.

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.

clear

public void clear()

Löscht alle Zuordnungen der Map.

removeOrException

@NotNull
public V removeOrException(@NotNull
 K1 key1,
 @NotNull
 K2 key2)

Entfernt das Mapping (key1, key2) falls es existiert, andernfalls wird eine DeveloperNotificationException geworfen.

Parameter:

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

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

Gibt zurück:

Den Wert zum Mapping (key1, key2) vor dem Löschen.

removeSubMap

public Map<K2,V> removeSubMap(@NotNull
 K1 key1)

Entfernt für den Schlüssel (key1) die Submap, falls key1 existiert, andernfalls passiert nichts.

Parameter:

key1 - Der 1. Schlüssel.

Gibt zurück:

Für den Schlüssel (key1) die Map (key2 --> V) oder null.

removeSubMapOrException

@NotNull
public @NotNull Map<K2,V> removeSubMapOrException(@NotNull
 K1 key1)

Entfernt für den Schlüssel (key1) die Submap, falls key1 existiert, andernfalls wird eine DeveloperNotificationException geworfen.

Parameter:

key1 - Der 1. Schlüssel.

Gibt zurück:

Für den Schlüssel (key1) die Map (key2 --> V) oder eine Exception.

getNonNullValuesOfKey1AsList

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

Liefert eine Liste aller Values des 1. Keys in dieser Map.

Parameter:

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

Gibt zurück:

eine Liste aller Values des 1. Keys in dieser Map.

getNonNullValuesOfKey1AsListOrNull

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

Liefert eine Liste aller Values des 1. Keys in dieser Map.

Parameter:

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

Gibt zurück:

eine Liste aller Values des 1. Keys in dieser Map.

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.

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,V>>> getEntrySet()

Liefert das EntrySet des 1. Schlüssels.

Gibt zurück:

das EntrySet der SubMap des 1. Schlüssels.

getKeySetOf

@NotNull
public @NotNull Set<K2> getKeySetOf(@NotNull
 K1 key1)

Liefert das KeySet der SubMap des 1. Schlüssels.

Parameter:

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

Gibt zurück:

das KeySet der SubMap des 1. Schlüssels.

getSubMapSizeOrZero

public int getSubMapSizeOrZero(@NotNull
 K1 key1)

Liefert die Anzahl an Mappings, der des Pfades (key1) oder 0, falls der Pfad nicht existiert.

Parameter:

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

Gibt zurück:

die Anzahl an Mappings, der des Pfades (key1) oder 0, falls der Pfad nicht existiert.

size

public int size()

Liefert die Anzahl an gespeicherten Mappings.

Gibt zurück:

die Anzahl an gespeicherten Mappings.