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     */
017    package org.apache.logging.log4j.core.appender.rolling;
018    
019    import org.apache.logging.log4j.core.LogEvent;
020    
021    /**
022     * A <code>TriggeringPolicy</code> controls the conditions under which rollover
023     * occurs. Such conditions include time of day, file size, an
024     * external event, the log request or a combination thereof.
025     */
026    public interface TriggeringPolicy {
027    
028        /**
029         * Initialize the Policy.
030         * @param manager The RollingFileManager.
031         */
032    
033        void initialize(final RollingFileManager manager);
034    
035        /**
036         * Determines if a rollover may be appropriate at this time.  If
037         * true is returned, RolloverPolicy.rollover will be called but it
038         * can determine that a rollover is not warranted.
039         *
040         * @param event   A reference to the currently event.
041         * @return true if a rollover should occur.
042         */
043        boolean isTriggeringEvent(final LogEvent event);
044    }