KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sourceforge > groboutils > codecoverage > v2 > util > ILogFilter


1 /*
2  * @(#)ILogFilter.java
3  *
4  * Copyright (C) 2004 Matt Albrecht
5  * groboclown@users.sourceforge.net
6  * http://groboutils.sourceforge.net
7  *
8  * Permission is hereby granted, free of charge, to any person obtaining a
9  * copy of this software and associated documentation files (the "Software"),
10  * to deal in the Software without restriction, including without limitation
11  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12  * and/or sell copies of the Software, and to permit persons to whom the
13  * Software is furnished to do so, subject to the following conditions:
14  *
15  * The above copyright notice and this permission notice shall be included in
16  * all copies or substantial portions of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24  * DEALINGS IN THE SOFTWARE.
25  */

26
27 package net.sourceforge.groboutils.codecoverage.v2.util;
28
29 import java.io.File JavaDoc;
30 import java.io.IOException JavaDoc;
31
32
33 /**
34  * Describes a method to transform a specialized log format into the
35  * standard format. Implementations must have a no-arg constructor.
36  *
37  * @author Matt Albrecht <a HREF="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
38  * @version $Date: 2004/04/17 08:25:53 $
39  * @since April 16, 2004
40  */

41 public interface ILogFilter
42 {
43     /**
44      * Loads all data from the given log directory, and outputs the
45      * standard format in the same place. This should only fail on
46      * I/O errors, not on format errors.
47      *
48      * @param channelCount the number of channels that the output logging
49      * should use.
50      * @param dir the directory where all the logs should live.
51      * @exception IOException if there is an I/O error reading from <tt>r</tt>.
52      * @exception IllegalArgumentException if the reader is <tt>null</tt>.
53      */

54     public void process( int channelCount, File JavaDoc dir )
55             throws IOException JavaDoc;
56 }
57
58
Popular Tags