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.logging.log4j.core.appender.rolling;
018
019import org.apache.logging.log4j.core.appender.rolling.action.Action;
020
021/**
022 * Description of actions needed to complete rollover.
023 */
024public interface RolloverDescription {
025    /**
026     * Active log file name after rollover.
027     *
028     * @return active log file name after rollover.
029     */
030    String getActiveFileName();
031
032    /**
033     * Specifies if active file should be opened for appending.
034     *
035     * @return if true, active file should be opened for appending.
036     */
037    boolean getAppend();
038
039    /**
040     * Action to be completed after close of current active log file
041     * before returning control to caller.
042     *
043     * @return action, may be null.
044     */
045    Action getSynchronous();
046
047    /**
048     * Action to be completed after close of current active log file
049     * and before next rollover attempt, may be executed asynchronously.
050     *
051     * @return action, may be null.
052     */
053    Action getAsynchronous();
054}