KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * FindBugs - Find bugs in Java programs
3  * Copyright (C) 2003-2005, 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 java.io.Serializable JavaDoc;
23
24 /**
25  * An object providing context information about a particular BugInstance.
26  *
27  * @author David Hovemeyer
28  * @see BugInstance
29  */
30 public interface BugAnnotation
31         extends Comparable JavaDoc<BugAnnotation>, XMLWriteableWithMessages, Serializable JavaDoc, Cloneable JavaDoc {
32     /**
33      * XML tag for a formatted text message describing the annotation.
34      */
35     public static final String JavaDoc MESSAGE_TAG = "Message";
36     
37     public Object JavaDoc clone();
38
39     /**
40      * Accept a BugAnnotationVisitor.
41      *
42      * @param visitor the visitor to accept
43      */
44     public void accept(BugAnnotationVisitor visitor);
45
46     /**
47      * Format the annotation as a String.
48      * The given key specifies additional information about how the annotation should
49      * be formatted. If the key is empty, then the "default" format will be used.
50      *
51      * @param key how the annotation should be formatted
52      * @param primaryClass TODO
53      */
54     public String JavaDoc format(String JavaDoc key, ClassAnnotation primaryClass);
55
56     /**
57      * Get a description of this bug annotation.
58      * The description is a key for the FindBugsAnnotationDescriptions resource bundle.
59      */
60     public String JavaDoc getDescription();
61
62     /**
63      * Set a description of this bug annotation.
64      * The description is a key for the FindBugsAnnotationDescriptions resource bundle.
65      */
66     public void setDescription(String JavaDoc description);
67     
68     /**
69      * Is this annotation used to compute instance hashes or match bug instances across versions
70      * @return true if significant
71      */
72     public boolean isSignificant();
73 }
74
75 // vim:ts=4
76
Popular Tags