01: /*
02: * Hammurapi
03: * Automated Java code review system.
04: * Copyright (C) 2004 Hammurapi Group
05: *
06: * This program is free software; you can redistribute it and/or modify
07: * it under the terms of the GNU General Public License as published by
08: * the Free Software Foundation; either version 2 of the License, or
09: * (at your option) any later version.
10: *
11: * This program is distributed in the hope that it will be useful,
12: * but WITHOUT ANY WARRANTY; without even the implied warranty of
13: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14: * GNU General Public License for more details.
15: *
16: * You should have received a copy of the GNU General Public License
17: * along with this program; if not, write to the Free Software
18: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19: *
20: * URL: http://www.hammurapi.org
21: * e-Mail: support@hammurapi.biz
22: */
23: package org.hammurapi.results;
24:
25: import java.util.List;
26:
27: /**
28: * @author Pavel Vlasov
29: * @version $Revision: 1.4 $
30: */
31: public interface InspectorSummary extends Comparable {
32: /**
33: * Inspector description
34: */
35: public String getDescription();
36:
37: /**
38: * Locations of violations
39: */
40: public List getLocations();
41:
42: /**
43: * Number of violations
44: */
45: int getLocationsCount();
46:
47: /**
48: * @return Returns the name.
49: */
50: public String getName();
51:
52: /**
53: *
54: * @return Inspector version
55: */
56: public String getVersion();
57:
58: /**
59: * @return Returns the severity.
60: */
61: public Number getSeverity();
62:
63: String getConfigInfo();
64:
65: /**
66: *
67: * @return difference in violations number between current report and baseline.
68: */
69: int getBaseLineLocationsCount();
70: }
|