Javadoc

Author: garydgregory

src/main/java/org/apache/commons/io/input/TailerListener.java

@@ -14,17 +14,18 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.apache.commons.io.input;
 
 /**
- * Listener for events from a {@link Tailer}.
+ * Listens to events from a {@link Tailer}.
  *
  * @since 2.0
  */
 public interface TailerListener {
 
     /**
-     * This method is called if the tailed file is not found.
+     * Called if the tailed file is not found.
      * <p>
      * <strong>Note:</strong> this is called from the tailer thread.
      * </p>
@@ -34,37 +35,37 @@ public interface TailerListener {
     /**
      * Called if a file rotation is detected.
      *
-     * This method is called before the file is reopened, and fileNotFound may
-     * be called if the new file has not yet been created.
+     * This method is called before the file is reopened, and fileNotFound may be called if the new file has not yet been created.
      * <p>
-     * <strong>Note:</strong> this is called from the tailer thread.
+     * <strong>Note:</strong> Called from the tailer thread.
      * </p>
      */
     void fileRotated();
 
     /**
-     * Handles an Exception.
+     * Called when an Exception is thrown.
      * <p>
-     * <strong>Note:</strong> this is called from the tailer thread.
+     * <strong>Note:</strong> Called from the tailer thread.
      * </p>
-     * @param ex the exception.
+     *
+     * @param e the exception.
      */
-    void handle(Exception ex);
+    void handle(Exception e);
 
     /**
-     * Handles a line from a Tailer.
+     * Called when a line is read.
      * <p>
-     * <strong>Note:</strong> this is called from the tailer thread.
+     * <strong>Note:</strong> Called from the tailer thread.
      * </p>
+     *
      * @param line the line.
      */
     void handle(String line);
 
     /**
-     * The tailer will call this method during construction,
-     * giving the listener a method of stopping the tailer.
+     * Called during construction, giving the listener a method of stopping the tailer.
+     *
      * @param tailer the tailer.
      */
     void init(Tailer tailer);
-
 }