src/jalview/util/dialogrunner/RunResponse.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 /**
  24  * A Runnable that is kind of like a future, that allows a sequence of Runabbles
  25  * to be conditionally executed by DialogRunner
  26  *
  27  * @author jprocter
  28  *
  29  */
  30 public abstract class RunResponse implements Runnable
  31 {
  32   /**
  33    * Response that triggers the Run method
  34    */
  35   private Object trigger;
  36
  37   /**
  38    * set by run() on exit
  39    */
  40   private Object returnValue = null;
  41
  42   /**
  43    * set by dialog runner
  44    */
  45   private boolean wasRun = false;
  46
  47   public RunResponse(Object onTrigger)
  48   {
  49     trigger = onTrigger;
  50   }
  51
  52   public Object getTrigger()
  53   {
  54    return trigger;
  55   }
  56
  57   public void reset()
  58   {
  59     wasRun = false;
  60     returnValue = null;
  61   }
  62
  63   @Override
  64   public String toString()
  65   {
  66     return "Runner for " + trigger;
  67   }
  68
  69   public Object getReturnValue()
  70   {
  71         return returnValue;
  72   }
  73
  74   public void setReturnValue(Object o)
  75   {
  76         returnValue = o;
  77   }
  78
  79   public boolean hasBeenRun()
  80   {
  81         return wasRun;
  82   }
  83
  84   public void setRun()
  85   {
  86     wasRun = true;
  87   }
  88 }