Merge commit '0b438477b16470202bddfecb54e0587036b37202' into alpha/JAL-3066_Jalview_2...

[jalview.git] / src / jalview / api / AlignCalcManagerI.java

diff --git a/src/jalview/api/AlignCalcManagerI.java b/src/jalview/api/AlignCalcManagerI.java
deleted file mode 100644 (file)
index 005ecd7..0000000
--- a/src/jalview/api/AlignCalcManagerI.java
+++ /dev/null
@@ -1,164 +0,0 @@
-/*
- * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
- * Copyright (C) $$Year-Rel$$ The Jalview Authors
- * 
- * This file is part of Jalview.
- * 
- * Jalview 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, or (at your option) any later version.
- *  
- * Jalview 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 Jalview.  If not, see <http://www.gnu.org/licenses/>.
- * The Jalview Authors are detailed in the 'AUTHORS' file.
- */
-package jalview.api;
-
-import jalview.datamodel.AlignmentAnnotation;
-
-import java.util.List;
-
-public interface AlignCalcManagerI
-{
-
-  /**
-   * tell manager that a worker is initialised and has started to run
-   * 
-   * @param worker
-   */
-  void notifyStarted(AlignCalcWorkerI worker);
-
-  /**
-   * tell manager that a thread running worker's run() loop is ready to start
-   * processing data
-   * 
-   * @param worker
-   * @return true if worker should start processing, false if another thread is
-   *         in progress
-   */
-  boolean notifyWorking(AlignCalcWorkerI worker);
-
-  /**
-   * notify manager that the worker has completed, and results may be ready to
-   * collect
-   * 
-   * @param worker
-   */
-  void workerComplete(AlignCalcWorkerI worker);
-
-  /**
-   * indicate that a worker like this cannot run on the platform and shouldn't
-   * be started again
-   * 
-   * @param worker
-   */
-  void disableWorker(AlignCalcWorkerI worker);
-
-  /**
-   * indicate that a worker like this may be run on the platform.
-   * 
-   * @param worker
-   *          of class to be removed from the execution blacklist
-   */
-  void enableWorker(AlignCalcWorkerI worker);
-
-  /**
-   * Answers true if the worker is disabled from running
-   * 
-   * @param worker
-   * @return
-   */
-  boolean isDisabled(AlignCalcWorkerI worker);
-
-  /**
-   * launch a new worker
-   * 
-   * @param worker
-   */
-  void startWorker(AlignCalcWorkerI worker);
-
-  /**
-   * 
-   * @param worker
-   * @return true if the worker is currently running
-   */
-  boolean isWorking(AlignCalcWorkerI worker);
-
-  /**
-   * if any worker thread is operational, return true!
-   * 
-   * @return
-   */
-  boolean isWorking();
-
-  /**
-   * register a restartable worker
-   * 
-   * @param worker
-   */
-  void registerWorker(AlignCalcWorkerI worker);
-
-  /**
-   * restart any registered workers
-   */
-  void restartWorkers();
-
-  /**
-   * 
-   * @param alignmentAnnotation
-   * @return true if a currently registered and working worker indicates its
-   *         involvement with the given alignmentAnnotation
-   */
-  boolean workingInvolvedWith(AlignmentAnnotation alignmentAnnotation);
-
-  /**
-   * kick any known instances of the given worker class to update their
-   * annotation
-   * 
-   * @param workerClass
-   */
-  void updateAnnotationFor(Class<? extends AlignCalcWorkerI> workerClass);
-
-  /**
-   * return any registered workers of the given class
-   * 
-   * @param workerClass
-   * @return null or one or more workers of the given class
-   */
-  List<AlignCalcWorkerI> getRegisteredWorkersOfClass(
-          Class<? extends AlignCalcWorkerI> workerClass);
-
-  /**
-   * work out if there is an instance of a worker that is *waiting* to start
-   * calculating
-   * 
-   * @param workingClass
-   * @return true if workingClass is already waiting to calculate. false if it
-   *         is calculating, or not queued.
-   */
-  boolean isPending(AlignCalcWorkerI workingClass);
-
-  /**
-   * deregister and otherwise remove any registered and working instances of the
-   * given worker type
-   * 
-   * @param typeToRemove
-   */
-  void removeWorkersOfClass(
-          Class<? extends AlignCalcWorkerI> typeToRemove);
-
-  /**
-   * Removes the worker that produces the given annotation, provided it is
-   * marked as 'deletable'. Some workers may need to continue to run as the
-   * results of their calculations are needed, e.g. for colour schemes.
-   * 
-   * @param ann
-   */
-  void removeWorkerForAnnotation(AlignmentAnnotation ann);
-}