JAL-3048 response() renamed addResponse(); checkstyle warning fixes

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

diff --git a/src/jalview/util/dialogrunner/DialogRunnerI.java b/src/jalview/util/dialogrunner/DialogRunnerI.java
index aaeb304..758d421 100644 (file)
--- a/src/jalview/util/dialogrunner/DialogRunnerI.java
+++ b/src/jalview/util/dialogrunner/DialogRunnerI.java
@@ -30,12 +30,14 @@ 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)
-   * { ... });
+   * Adds a new response for this dialog, and returns the dialog (this), to allow chaining, eg.
+   * <pre>
+   * dialog.addResponse(newRunResponse(OK_PRessed) { run()...})
+   *     .addResponse(new RunResponse(CANCEL_PRESSED);
+   * </pre>
    * 
    * @param action
    * @return the dialog
    */
-  T response(RunResponse action);
+  T addResponse(RunResponse action);
 }