Coverage Report - org.apache.commons.io.input.TailerListener
 
Classes in this File Line Coverage Branch Coverage Complexity
TailerListener
N/A
N/A
1
 
 1  
 /*
 2  
  * Licensed to the Apache Software Foundation (ASF) under one or more
 3  
  * contributor license agreements.  See the NOTICE file distributed with
 4  
  * this work for additional information regarding copyright ownership.
 5  
  * The ASF licenses this file to You under the Apache License, Version 2.0
 6  
  * (the "License"); you may not use this file except in compliance with
 7  
  * the License.  You may obtain a copy of the License at
 8  
  *
 9  
  *      http://www.apache.org/licenses/LICENSE-2.0
 10  
  *
 11  
  * Unless required by applicable law or agreed to in writing, software
 12  
  * distributed under the License is distributed on an "AS IS" BASIS,
 13  
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 14  
  * See the License for the specific language governing permissions and
 15  
  * limitations under the License.
 16  
  */
 17  
 package org.apache.commons.io.input;
 18  
 
 19  
 /**
 20  
  * Listener for events from a {@link Tailer}.
 21  
  *
 22  
  * @version $Id: TailerListener.java 1304052 2012-03-22 20:55:29Z ggregory $
 23  
  * @since 2.0
 24  
  */
 25  
 public interface TailerListener {
 26  
 
 27  
     /**
 28  
      * The tailer will call this method during construction,
 29  
      * giving the listener a method of stopping the tailer.
 30  
      * @param tailer the tailer.
 31  
      */
 32  
     void init(Tailer tailer);
 33  
 
 34  
     /**
 35  
      * This method is called if the tailed file is not found.
 36  
      * <p>
 37  
      * <b>Note:</b> this is called from the tailer thread.
 38  
      */
 39  
     void fileNotFound();
 40  
 
 41  
     /**
 42  
      * Called if a file rotation is detected.
 43  
      *
 44  
      * This method is called before the file is reopened, and fileNotFound may
 45  
      * be called if the new file has not yet been created.
 46  
      * <p>
 47  
      * <b>Note:</b> this is called from the tailer thread.
 48  
      */
 49  
     void fileRotated();
 50  
 
 51  
     /**
 52  
      * Handles a line from a Tailer.
 53  
      * <p>
 54  
      * <b>Note:</b> this is called from the tailer thread.
 55  
      * @param line the line.
 56  
      */
 57  
     void handle(String line);
 58  
 
 59  
     /**
 60  
      * Handles an Exception .
 61  
      * <p>
 62  
      * <b>Note:</b> this is called from the tailer thread.
 63  
      * @param ex the exception.
 64  
      */
 65  
     void handle(Exception ex);
 66  
 
 67  
 }