001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.io.input;
018
019/**
020 * {@link TailerListener} Adapter.
021 *
022 * @since 2.0
023 */
024public class TailerListenerAdapter implements TailerListener {
025
026    /**
027     * The tailer will call this method during construction,
028     * giving the listener a method of stopping the tailer.
029     * @param tailer the tailer.
030     */
031    @Override
032    public void init(final Tailer tailer) {
033    }
034
035    /**
036     * This method is called if the tailed file is not found.
037     */
038    @Override
039    public void fileNotFound() {
040    }
041
042    /**
043     * Called if a file rotation is detected.
044     *
045     * This method is called before the file is reopened, and fileNotFound may
046     * be called if the new file has not yet been created.
047     */
048    @Override
049    public void fileRotated() {
050    }
051
052    /**
053     * Handles a line from a Tailer.
054     * @param line the line.
055     */
056    @Override
057    public void handle(final String line) {
058    }
059
060    /**
061     * Handles an Exception .
062     * @param ex the exception.
063     */
064    @Override
065    public void handle(final Exception ex) {
066    }
067
068    /**
069     * Called each time the Tailer reaches the end of the file.
070     *
071     * <b>Note:</b> this is called from the tailer thread.
072     *
073     * Note: a future version of commons-io will pull this method up to the TailerListener interface,
074     * for now clients must subclass this class to use this feature.
075     *
076     * @since 2.5
077     */
078    public void endOfFileReached() {
079    }
080}