KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > umd > cs > findbugs > classfile > IErrorLogger


1 /*
2  * FindBugs - Find Bugs in Java programs
3  * Copyright (C) 2006, 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.classfile;
21
22 /**
23  * Interface for objects that log various kinds of analysis errors.
24  *
25  * @author David Hovemeyer
26  */
27 public interface IErrorLogger {
28     /**
29      * Called to report a class lookup failure.
30      *
31      * @param ex a ClassNotFoundException resulting from the class lookup failure
32      */
33     public void reportMissingClass(ClassNotFoundException JavaDoc ex);
34     
35     /**
36      * Called to report a class lookup failure.
37      *
38      * @param classDescriptor ClassDescriptor of a missing class
39      */
40     public void reportMissingClass(ClassDescriptor classDescriptor);
41
42     /**
43      * Log an error that occurs while performing analysis.
44      *
45      * @param message the error message
46      */
47     public void logError(String JavaDoc message);
48     
49     /**
50      * Log an error that occurs while performing analysis.
51      *
52      * @param message the error message
53      * @param e the exception which is the underlying cause of the error
54      */
55     public void logError(String JavaDoc message, Throwable JavaDoc e);
56     
57     /**
58      * Report that we skipped some analysis of a method
59      *
60      * @param method the method we skipped
61      */
62     public void reportSkippedAnalysis(MethodDescriptor method);
63 }
64
Popular Tags