View Javadoc

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  
18  package org.apache.log4j.rolling;
19  
20  import org.apache.log4j.rolling.helper.Action;
21  
22  
23  /***
24   * Description of actions needed to complete rollover.
25   *
26   * @author Curt Arnold
27   *
28   */
29  public interface RolloverDescription {
30    /***
31     * Active log file name after rollover.
32     * @return active log file name after rollover.
33     */
34    String getActiveFileName();
35  
36    /***
37     * Specifies if active file should be opened for appending.
38     * @return if true, active file should be opened for appending.
39     */
40    boolean getAppend();
41  
42    /***
43     * Action to be completed after close of current active log file
44     * before returning control to caller.
45     *
46     * @return action, may be null.
47     */
48    Action getSynchronous();
49  
50    /***
51     * Action to be completed after close of current active log file
52     * and before next rollover attempt, may be executed asynchronously.
53     *
54     * @return action, may be null.
55     */
56    Action getAsynchronous();
57  }