JAL-3048 jalview.utils.dialogrunner.DialogRunner allows sequences of runnable methods...

[jalview.git] / src / jalview / util / dialogrunner / DialogRunnerI.java

diff --git a/src/jalview/util/dialogrunner/DialogRunnerI.java b/src/jalview/util/dialogrunner/DialogRunnerI.java
new file mode 100644 (file)
index 0000000..9df6d33
--- /dev/null
+++ b/src/jalview/util/dialogrunner/DialogRunnerI.java
@@ -0,0 +1,42 @@
+/*
+ * 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.util.dialogrunner;
+
+/**
+ * functional pattern for blocking dialog response handling
+ * 
+ * @author jprocter
+ *
+ */
+public interface DialogRunnerI<T extends DialogRunnerI>
+{
+
+  /**
+   * define a new response for this dialog. eg. dialog.response(new
+   * RunResponse(OK_PRessed) { run()...}).response(new RunResponse(CANCEL_PRESSED)
+   * { ... });
+   * 
+   * @param action
+   * @return the dialog
+   */
+  T response(RunResponse action);
+
+}