KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > umd > cs > findbugs > FindBugsProgress


1 /*
2  * FindBugs - Find bugs in Java programs
3  * Copyright (C) 2003,2004 University of Maryland
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  */
19
20 package edu.umd.cs.findbugs;
21
22 import edu.umd.cs.findbugs.classfile.IClassPathBuilderProgress;
23
24 /**
25  * A callback that may be installed in a FindBugs instance
26  * to asynchronously keep track of its progress.
27  *
28  * @author David Hovemeyer
29  * @see FindBugs
30  */
31 public interface FindBugsProgress extends IClassPathBuilderProgress {
32     /**
33      * Report the total number of archives (Jar or zip files) that will be analyzed.
34      *
35      * @param numArchives the number of archives
36      */
37     public void reportNumberOfArchives(int numArchives);
38
39     /**
40      * Report that FindBugs has finished scanning an archive in order
41      * to add its classes to the repository.
42      */
43     public void finishArchive();
44
45     /**
46      * Provide an array that predicts the number of classes in each pass
47      * @param classesPerPass
48      */
49     public void predictPassCount(int [] classesPerPass);
50     /**
51      * Report that FindBugs has finished scanning the archives and will
52      * start analysing the classes contained therein.
53      *
54      * @param numClasses number of classes found in all of the archives
55      */
56     public void startAnalysis(int numClasses);
57
58     /**
59      * Report that FindBugs has finished analyzing a class.
60      */
61     public void finishClass();
62
63     /**
64      * Called to indicate that the per-class analysis is finished, and
65      * that the whole program analysis is taking place.
66      */
67     public void finishPerClassAnalysis();
68 }
69
70 // vim:ts=4
71
Popular Tags