Package de.svws_nrw.core.utils

Klasse AttributMitAuswahl<K,V>

java.lang.Object
de.svws_nrw.core.utils.AttributMitAuswahl<K,V>
Typparameter:
K - der Typ des eindeutigen Schlüsselwertes für ein enthaltenes Objekt
V - der Typ der enthaltenen Objekte
public class AttributMitAuswahl<K,V> extends Object
Eine Klasse für den Zugriff auf Attribute mit eingebauter Auswahl-Funktion, welche u.a. für Filter genutzt werden kann.

  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
    AttributMitAuswahl(@NotNull Collection<V> values, @NotNull Function<V,K> toId, @NotNull Comparator<V> comparator, Runnable eventHandler)
    Erzeugt ein neues Objekt für ein Attribut mit Auswahl-Option

  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    void
    add(V value)
    Fügt einen weiteren zulässigen Wert für das Attribut hinzu.
    void
    addAll(@NotNull List<V> values)
    Fügt weitere zulässige Werte für das Attribut hinzu.
    @NotNull List<V>
    auswahl()
    Gibt die Liste der in der Auswahl ausgewählten Werte für dieses Attribut zurück.
    void
    auswahlAdd(V value)
    Fügt den Wert zu der Auswahl hinzu, wenn er nicht bereits vorhanden ist.
    void
    auswahlAddByKey(K key)
    Fügt den Wert von dem Schlüssel zu der Auswahl hinzu, wenn er nicht bereits vorhanden ist.
    void
    auswahlClear()
    Leert die Auswahl.
    boolean
    auswahlExists()
    Gibt zurück, ob eine Auswahl vorhanden ist und Auswahl-Werte hat.
    boolean
    auswahlHas(V value)
    Prüft, ob der übergebene Wert in der Auswahl vorhanden ist oder nicht.
    boolean
    auswahlHasKey(K key)
    Prüft, ob der übergebene Schlüssel in der Auswahl vorhanden ist oder nicht.
    @NotNull List<K>
    auswahlKeyList()
    Gibt die Liste der in der Auswahl enthaltenen Schlüssel für dieses Attribut zurück.
    void
    auswahlRemove(V value)
    Erntfernt den Wert aus der Auswahl, sofern er vorhanden ist.
    void
    auswahlRemoveByKey(K key)
    Erntfernt den Wert für den Schlüssel aus der Auswahl, sofern er vorhanden ist.
    int
    auswahlSize()
    Gibt die Anzahl der Elemente in der Auswahl zurück.
    @NotNull List<V>
    auswahlSorted()
    Gibt eine sortierte Liste der in der Auswahl ausgewählten Werte für dieses Attribut zurück.
    boolean
    auswahlToggle(V value)
    Fügt einen Wert zu der Auswahl hinzu, wenn er nicht vorhanden ist, und entfernt ihn, wenn er bereits vorhanden ist.
    boolean
    auswahlToggleByKey(K key)
    Fügt einen Wert zu der Auswahl hinzu, wenn der Schlüssel nicht vorhanden ist, und entfernt ihn, wenn der Schlüssel bereits vorhanden ist.
    V
    get(K key)
    Gibt den Wert zu dem angegebenen Schlüssel zurück, sofern es sich um einen zulässigen Schlüssel handelt.
    V
    getOrException(K key)
    Gibt den Wert zu dem angegebenen Schlüssel zurück, sofern es sich um einen zulässigen Schlüssel handelt.
    boolean
    has(K key)
    Gibt zurück, ob der Schlüssel erlaubt ist.
    boolean
    hasValue(V value)
    Gibt zurück, ob der Wert vorhanden ist.
    @NotNull List<V>
    list()
    Gibt die Liste der zulässigen Werte für dieses Attribut zurück.
    void
    remove(V value)
    Entfernt den Wert als zulässigen Wert für das Attribut.
    void
    removeAll(@NotNull List<V> values)
    Entfernt die angegebenen Werte als zulässigen Werte für das Attribut.
    void
    setAuswahl(@NotNull AttributMitAuswahl<K,V> srcAuswahl)
    Diese Methode übernimmt die Auswahl des übergebenen AttributMitAuswahl.
    int
    size()
    Gibt die Anzahl der zulässigen Werte für dieses Attribut zurück.

    Von Klasse geerbte Methoden java.lang.Object

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

  • Konstruktordetails

    • AttributMitAuswahl

      public AttributMitAuswahl(@NotNull @NotNull Collection<V> values, @NotNull @NotNull Function<V,K> toId, @NotNull @NotNull Comparator<V> comparator, Runnable eventHandler)
      Erzeugt ein neues Objekt für ein Attribut mit Auswahl-Option
      Parameter:
      values - die Menge der erlaubten Werte
      toId - eine Funktion zum Ermitteln des Schlüssels eines Objektes
      comparator - eine Vergleichsmethode zum Vergleichen von zwei enthaltenen Objekten
      eventHandler - ein Runnable, welches aufgerufen wird, wenn der Status der Auswahl sich ändert

  • Methodendetails

    • list

      @NotNull public @NotNull List<V> list()
      Gibt die Liste der zulässigen Werte für dieses Attribut zurück.
      Gibt zurück:
      die Liste zulässigen Werte für dieses Attribut zurück.

    • size

      public int size()
      Gibt die Anzahl der zulässigen Werte für dieses Attribut zurück.
      Gibt zurück:
      die Anzahl der zulässigen Werte für dieses Attribut

    • get

      public V get(@NotNull K key)
      Gibt den Wert zu dem angegebenen Schlüssel zurück, sofern es sich um einen zulässigen Schlüssel handelt.
      Parameter:
      key - der Schlüssel
      Gibt zurück:
      der Wert oder null, falls kein Wert enthalten ist.

    • getOrException

      @NotNull public V getOrException(@NotNull K key) throws DeveloperNotificationException
      Gibt den Wert zu dem angegebenen Schlüssel zurück, sofern es sich um einen zulässigen Schlüssel handelt.
      Parameter:
      key - der Schlüssel
      Gibt zurück:
      der Wert
      Löst aus:
      DeveloperNotificationException - falls der Schlüssel nicht zulässig ist

    • has

      public boolean has(@NotNull K key)
      Gibt zurück, ob der Schlüssel erlaubt ist.
      Parameter:
      key - der Schlüssel
      Gibt zurück:
      true, falls der Schlüssel erlaubt ist

    • hasValue

      public boolean hasValue(@NotNull V value)
      Gibt zurück, ob der Wert vorhanden ist.
      Parameter:
      value - der Wert
      Gibt zurück:
      true, falls der Wert vorhanden ist

    • add

      public void add(@NotNull V value)
      Fügt einen weiteren zulässigen Wert für das Attribut hinzu.
      Parameter:
      value - der hinzuzufügende Wert

    • addAll

      public void addAll(@NotNull @NotNull List<V> values)
      Fügt weitere zulässige Werte für das Attribut hinzu.
      Parameter:
      values - die hinzuzufügenden Werte

    • remove

      public void remove(@NotNull V value)
      Entfernt den Wert als zulässigen Wert für das Attribut. Sollte der Wert zusätzlich zu der Auswahl gehören, so wird dieser aus der Auswahl entfernt.
      Parameter:
      value - der zu entferndende Wert

    • removeAll

      public void removeAll(@NotNull @NotNull List<V> values)
      Entfernt die angegebenen Werte als zulässigen Werte für das Attribut. Sollte die Werte zusätzlich zu der Auswahl gehören, so werden diese aus der Auswahl entfernt.
      Parameter:
      values - die zu entferndende Werte

    • auswahl

      @NotNull public @NotNull List<V> auswahl()
      Gibt die Liste der in der Auswahl ausgewählten Werte für dieses Attribut zurück. Ist die Liste leer, so ist keine Auswahl vorhanden.
      Gibt zurück:
      die Liste der in der Auswahl enthaltenen Werte für dieses Attribut.

    • auswahlSorted

      @NotNull public @NotNull List<V> auswahlSorted()
      Gibt eine sortierte Liste der in der Auswahl ausgewählten Werte für dieses Attribut zurück. Ist die Liste leer, so ist keine Auswahl vorhanden.
      Gibt zurück:
      die Liste der in der Auswahl enthaltenen Werte für dieses Attribut.

    • auswahlKeyList

      @NotNull public @NotNull List<K> auswahlKeyList()
      Gibt die Liste der in der Auswahl enthaltenen Schlüssel für dieses Attribut zurück. Ist die Liste leer, so ist kein Auswahl vorhanden.
      Gibt zurück:
      die Liste der in der Auswahl enthaltenen Schlüssel für dieses Attribut zurück.

    • auswahlExists

      public boolean auswahlExists()
      Gibt zurück, ob eine Auswahl vorhanden ist und Auswahl-Werte hat.
      Gibt zurück:
      true, falls eine Auswahl vorhanden ist, und ansonsten false

    • auswahlSize

      public int auswahlSize()
      Gibt die Anzahl der Elemente in der Auswahl zurück.
      Gibt zurück:
      die Anzahl der Elemente in der Auswahl

    • auswahlHas

      public boolean auswahlHas(@NotNull V value)
      Prüft, ob der übergebene Wert in der Auswahl vorhanden ist oder nicht.
      Parameter:
      value - der zu prüfende Wert
      Gibt zurück:
      true, falls der Wert in der Auswahl vorhanden ist, und ansonsten false
      Löst aus:
      DeveloperNotificationException - falls der Wert bei der Auswahl nicht zulässig ist

    • auswahlHasKey

      public boolean auswahlHasKey(@NotNull K key)
      Prüft, ob der übergebene Schlüssel in der Auswahl vorhanden ist oder nicht.
      Parameter:
      key - der zu prüfende Schlüssel
      Gibt zurück:
      true, falls der Schlüssel in der Auswahl vorhanden ist, und ansonsten false
      Löst aus:
      DeveloperNotificationException - falls der Wert bei der Auswahl nicht zulässig ist

    • auswahlClear

      public void auswahlClear()
      Leert die Auswahl.

    • auswahlAdd

      public void auswahlAdd(@NotNull V value)
      Fügt den Wert zu der Auswahl hinzu, wenn er nicht bereits vorhanden ist.
      Parameter:
      value - der Wert für die Auswahl
      Löst aus:
      DeveloperNotificationException - falls der Wert bei der Auswahl nicht zulässig ist

    • auswahlRemove

      public void auswahlRemove(@NotNull V value)
      Erntfernt den Wert aus der Auswahl, sofern er vorhanden ist.
      Parameter:
      value - der Wert der aus der Auswahl entfernt wird

    • auswahlToggle

      public boolean auswahlToggle(@NotNull V value)
      Fügt einen Wert zu der Auswahl hinzu, wenn er nicht vorhanden ist, und entfernt ihn, wenn er bereits vorhanden ist.
      Parameter:
      value - der Wert für die Auswahl
      Gibt zurück:
      true, falls der Wert anschließend in der Auswahl vorhanden ist, und ansonsten false
      Löst aus:
      DeveloperNotificationException - falls der Wert für das Setzen bei der Auswahl nicht zulässig ist

    • auswahlAddByKey

      public void auswahlAddByKey(@NotNull K key)
      Fügt den Wert von dem Schlüssel zu der Auswahl hinzu, wenn er nicht bereits vorhanden ist.
      Parameter:
      key - der Schlüssel für die Auswahl
      Löst aus:
      DeveloperNotificationException - falls der Schlüssel bei der Auswahl nicht zulässig ist

    • auswahlRemoveByKey

      public void auswahlRemoveByKey(@NotNull K key)
      Erntfernt den Wert für den Schlüssel aus der Auswahl, sofern er vorhanden ist.
      Parameter:
      key - der Schlüssel für den Wert der aus der Auswahl entfernt wird

    • auswahlToggleByKey

      public boolean auswahlToggleByKey(@NotNull K key)
      Fügt einen Wert zu der Auswahl hinzu, wenn der Schlüssel nicht vorhanden ist, und entfernt ihn, wenn der Schlüssel bereits vorhanden ist.
      Parameter:
      key - der Schlüssel für den Wert in der Auswahl
      Gibt zurück:
      true, falls der Wert anschließend in der Auswahl gesetzt ist, und ansonsten false
      Löst aus:
      DeveloperNotificationException - falls der Wert für das Setzen bei der Auswahl nicht zulässig ist

    • setAuswahl

      public void setAuswahl(@NotNull @NotNull AttributMitAuswahl<K,V> srcAuswahl)
      Diese Methode übernimmt die Auswahl des übergebenen AttributMitAuswahl.
      Parameter:
      srcAuswahl - Die Auswahl des AttributMitAuswahl, die übernommen wird.