JAL-3048 response() renamed addResponse(); checkstyle warning fixes
[jalview.git] / 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   public Response ourTrigger;
36
37   /**
38    * set by run() on exit
39    */
40   public Response returned = null;
41
42   /**
43    * set by dialog runner
44    */
45   public boolean wasRun = false;
46
47   public RunResponse(int trigger)
48   {
49     ourTrigger = new Response(trigger);
50   }
51
52   public RunResponse(Object trigger)
53   {
54     ourTrigger = new Response(trigger);
55   }
56
57   public RunResponse(String trigger)
58   {
59     ourTrigger = new Response(trigger);
60   }
61
62   public void reset()
63   {
64     wasRun = false;
65     returned = null;
66
67   }
68
69   @Override
70   public String toString()
71   {
72     return "Runner for " + ourTrigger;
73   }
74 }