/*
    * Copyright 2013-2023 Medical Information Systems Research Group (https://medical.zcu.cz),
    * Department of Computer Science and Engineering, University of West Bohemia.
    * Address: Univerzitni 8, 306 14 Plzen, Czech Republic.
    *
    * This file is part of Sparkle project.
    *
    * Sparkle is free software: you can redistribute it and/or modify
    * it under the terms of the GNU General Public License as published by
   * the Free Software Foundation, either version 3 of the License.
   *
   * Sparkle is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
   * GNU General Public License for more details.
   *
   * You should have received a copy of the GNU General Public License
   * along with Sparkle. If not, see <http://www.gnu.org/licenses/>.
   */
  package cz.zcu.mre.sparkle.gui.tools;
  
  import cz.zcu.mre.sparkle.data.AbstractTermsStorage.StorageChangeListener;
  import cz.zcu.mre.sparkle.data.AbstractTermsStorage.WeakStorageChangeListener;
  import javafx.beans.InvalidationListener;
  import javafx.beans.WeakInvalidationListener;
  import javafx.beans.value.ChangeListener;
  import javafx.beans.value.WeakChangeListener;
  import javafx.collections.*;
  import javafx.event.Event;
  import javafx.event.EventHandler;
  import javafx.event.WeakEventHandler;
  import java.io.Serializable;
  import java.util.LinkedList;
  
  /**
   * Třída definující objekt uchovávající reference na objekty posluchačů tak
   * dlouho, dokud existuje reference na něj samotný. Snaží se zabránit paměťovým
   * únikům vzniklým situací, kdy objekt zodpovědný za vytvoření posluchače
   * zapomene posluchače odebrat.
   *
   * @author Jan Smucr
   * @author Klara Hlavacova
   * @author Petr Vcelak (vcelak@kiv.zcu.cz)
   */
  public final class ReferenceKeeper {
  
      private final LinkedList<Object> objects = new LinkedList<>();
  
      private <X> X add(final X o) {
          objects.add(o);
          return o;
      }
  
      public final <X> WeakChangeListener<X> toWeak(final ChangeListener<X> listener) {
          return new WeakChangeListener<>(add(listener));
      }
  
      public final WeakInvalidationListener toWeak(final InvalidationListener listener) {
          return new WeakInvalidationListener(add(listener));
      }
  
      public final <X> WeakListChangeListener<X> toWeak(final ListChangeListener<X> listener) {
          return new WeakListChangeListener<>(add(listener));
      }
  
      public final <K, V> WeakMapChangeListener<K, V> toWeak(final MapChangeListener<K, V> listener) {
          return new WeakMapChangeListener<>(add(listener));
      }
  
      public final <X> WeakSetChangeListener<X> toWeak(final SetChangeListener<X> listener) {
          return new WeakSetChangeListener<>(add(listener));
      }
  
      public final <X extends Event> WeakEventHandler<X> toWeak(final EventHandler<X> handler) {
          return new WeakEventHandler<>(add(handler));
      }
  
      public final <X extends Serializable> WeakStorageChangeListener<X> toWeak(final StorageChangeListener<X> listener) {
          return new WeakStorageChangeListener<>(add(listener));
      }
  
  }