JAL-1645 Version-Rel Version 2.9 Year-Rel 2015 Licensing glob

[jalview.git] / src / jalview / gui / IProgressIndicator.java

diff --git a/src/jalview/gui/IProgressIndicator.java b/src/jalview/gui/IProgressIndicator.java
index 0ada6af..5bbf9f6 100644 (file)
--- a/src/jalview/gui/IProgressIndicator.java
+++ b/src/jalview/gui/IProgressIndicator.java
@@ -1,54 +1,58 @@
-/*\r
- * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)\r
- * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle\r
- * \r
- * This file is part of Jalview.\r
- * \r
- * Jalview is free software: you can redistribute it and/or\r
- * modify it under the terms of the GNU General Public License \r
- * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\r
- * \r
- * Jalview is distributed in the hope that it will be useful, but \r
- * WITHOUT ANY WARRANTY; without even the implied warranty \r
- * of MERCHANTABILITY or FITNESS FOR A PARTICULAR \r
- * PURPOSE.  See the GNU General Public License for more details.\r
- * \r
- * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.\r
- */\r
-package jalview.gui;\r
-\r
-/**\r
- * Visual progress indicator interface.\r
- * \r
- * @author JimP\r
- * \r
- */\r
-public interface IProgressIndicator\r
-{\r
-  /**\r
-   * Visual indication of some operation taking place. On first call with a\r
-   * particular ID an indicator with the given message is added. The indicator\r
-   * is removed with a second call with same ID.\r
-   * \r
-   * @param message\r
-   *          - displayed message for operation\r
-   * @param id\r
-   *          - unique handle for this indicator\r
-   */\r
-  public abstract void setProgressBar(String message, long id);\r
-\r
-  /**\r
-   * register a handler for the progress bar identified by id\r
-   * \r
-   * @param id\r
-   * @param handler\r
-   */\r
-  public abstract void registerHandler(long id,\r
-          IProgressIndicatorHandler handler);\r
-  /**\r
-  *\r
-  * @return true if any progress bars are still active\r
-  */\r
-  boolean operationInProgress();\r
-\r
-}\r
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9)
+ * Copyright (C) 2015 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.gui;
+
+/**
+ * Visual progress indicator interface.
+ * 
+ * @author JimP
+ * 
+ */
+public interface IProgressIndicator
+{
+  /**
+   * Visual indication of some operation taking place. On first call with a
+   * particular ID an indicator with the given message is added. The indicator
+   * is removed with a second call with same ID.
+   * 
+   * @param message
+   *          - displayed message for operation
+   * @param id
+   *          - unique handle for this indicator
+   */
+  public abstract void setProgressBar(String message, long id);
+
+  /**
+   * register a handler for the progress bar identified by id
+   * 
+   * @param id
+   * @param handler
+   */
+  public abstract void registerHandler(long id,
+          IProgressIndicatorHandler handler);
+
+  /**
+   * 
+   * @return true if any progress bars are still active
+   */
+  boolean operationInProgress();
+
+}