View Javadoc

1   /*
2    * Copyright 1999,2005 The Apache Software Foundation.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.apache.log4j.rolling;
18  
19  import org.apache.log4j.rolling.helper.Action;
20  
21  
22  /***
23   * Description of actions needed to complete rollover.
24   *
25   * @author Curt Arnold
26   *
27   */
28  public interface RolloverDescription {
29    /***
30     * Active log file name after rollover.
31     * @return active log file name after rollover.
32     */
33    String getActiveFileName();
34  
35    /***
36     * Specifies if active file should be opened for appending.
37     * @return if true, active file should be opened for appending.
38     */
39    boolean getAppend();
40  
41    /***
42     * Action to be completed after close of current active log file
43     * before returning control to caller.
44     *
45     * @return action, may be null.
46     */
47    Action getSynchronous();
48  
49    /***
50     * Action to be completed after close of current active log file
51     * and before next rollover attempt, may be executed asynchronously.
52     *
53     * @return action, may be null.
54     */
55    Action getAsynchronous();
56  }