KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > log > output > io > rotate > RotateStrategy


1 /*
2  * Copyright 1999-2004 The Apache Software Foundation
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
12  * implied.
13  *
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 package org.apache.log.output.io.rotate;
18
19 import java.io.File JavaDoc;
20
21 /**
22  * Strategy that checks condition under which file rotation is needed.
23  *
24  * @author <a HREF="mailto:leo.sutic@inspireinfrastructure.com">Leo Sutic</a>
25  * @author <a HREF="mailto:bh22351@i-one.at">Bernhard Huber</a>
26  */
27 public interface RotateStrategy
28 {
29     /**
30      * Reset cumulative rotation history data.
31      * Called after rotation.
32      */
33     void reset();
34
35     /**
36      * Check if a log rotation is neccessary at this time.
37      *
38      * @param data the serialized version of the message about to be written
39      * to the log system
40      * @param file the File that we are writing to
41      * @return boolean return true if log rotation is neccessary, else false
42      */
43     boolean isRotationNeeded( String JavaDoc data, File JavaDoc file );
44 }
45
46
Popular Tags