src/jalview/util/dialogrunner/DialogRunnerI.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.util.dialogrunner;
  22
  23 import java.util.List;
  24
  25 /**
  26  * functional pattern for blocking dialog response handling
  27  *
  28  * @author jprocter
  29  *
  30  */
  31 public interface DialogRunnerI
  32 {
  33
  34   /**
  35    * Adds a new response for this dialog, and returns the dialog (this), to allow chaining, eg.
  36    * <pre>
  37    * dialog.addResponse(newRunResponse(OK_PRessed) { run()...})
  38    *     .addResponse(new RunResponse(CANCEL_PRESSED);
  39    * </pre>
  40    *
  41    * @param action
  42    * @return
  43    */
  44   DialogRunnerI addResponse(RunResponse action);
  45
  46   /**
  47    * Runs any registered handlers for the given response, and answers the list
  48    * of responses run (if any) in order run
  49    *
  50    * @param response
  51    * @return
  52    */
  53   default List<RunResponse> handleResponse(Object response)
  54   {
  55         return null;
  56   }
  57 }