KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > umd > cs > findbugs > props > WarningProperty


1 /*
2  * FindBugs - Find bugs in Java programs
3  * Copyright (C) 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 package edu.umd.cs.findbugs.props;
20
21 /**
22  * Interface that all warning property enumerations are expected
23  * to implement.
24  *
25  * @author David Hovemeyer
26  */
27 public interface WarningProperty {
28     /**
29      * Get the priority adjustment: i.e., the effect that this warning
30      * property is expected to have on the likelihood that the warning
31      * is real, benign, or a false positive.
32      *
33      * @return the priority adjustment
34      */
35     public abstract PriorityAdjustment getPriorityAdjustment();
36
37     /**
38      * Get the fully qualified name of the property.
39      * Should be full class name, ".", followed by the descriptive
40      * name of the property.
41      *
42      * @return fully qualified name of the property
43      */
44     public abstract String JavaDoc getName();
45 }
46
Popular Tags