001/**
002 * Logback: the reliable, generic, fast and flexible logging framework.
003 * Copyright (C) 1999-2015, QOS.ch. All rights reserved.
004 *
005 * This program and the accompanying materials are dual-licensed under
006 * either the terms of the Eclipse Public License v1.0 as published by
007 * the Eclipse Foundation
008 *
009 *   or (per the licensee's choosing)
010 *
011 * under the terms of the GNU Lesser General Public License version 2.1
012 * as published by the Free Software Foundation.
013 */
014package ch.qos.logback.core.rolling;
015
016import java.io.File;
017
018import ch.qos.logback.core.spi.LifeCycle;
019
020/**
021 * A <code>TriggeringPolicy</code> controls the conditions under which roll-over
022 * occurs. Such conditions include time of day, file size, an 
023 * external event, the log request or a combination thereof.
024 *
025 * @author Ceki G&uuml;lc&uuml;
026 * */
027
028public interface TriggeringPolicy<E> extends LifeCycle {
029
030    /**
031     * Should roll-over be triggered at this time?
032     * 
033     * @param activeFile A reference to the currently active log file. 
034     * @param event A reference to the currently event. 
035     * @return true if a roll-over should occur.
036     */
037    boolean isTriggeringEvent(final File activeFile, final E event);
038}