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.helper;
19  
20  import java.io.IOException;
21  
22  
23  /***
24   * The Action interface should be implemented by any class that performs
25   * file system actions for RollingFileAppenders after the close of
26   * the active log file.
27   *
28   * @author Curt Arnold
29   */
30  public interface Action extends Runnable {
31    /***
32     * Perform an action.
33     * @return  true if action was successful.  A return value of false will cause
34     * the rollover to be aborted if possible.
35     * @throws IOException if IO error, a thrown exception will cause the rollover
36     * to be aborted if possible.
37     */
38    boolean execute() throws IOException;
39  
40      /***
41       * Cancels the action if not already initialized or waits till completion.
42       */
43    void close();
44  
45    /***
46     * Determines if action has been completed.
47      * @return true if action is complete.
48     */
49    boolean isComplete();
50  }