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