Waiver.java


Package: org.hammurapi

Results
Date2007/07/27
Codebase190
Reviews320
DPMO62
Sigma5.336

Metrics
NameNumberMinAvgMaxTotal
Code length60.000.000.000.00
File length168.0068.0068.0068.00
Operation complexity60.000.000.000.00
Work order196.7296.7296.7296.72

Violations
#LineColumnNameSeverityDescription
1241ER-0233Packages should begin with []
2369ER-0983No need to provide (public, abstract, ) modifiers for interface methods

JavaDoc
Waiver

1/*
2 * Hammurapi
3 * Automated Java code review system.
4 * Copyright (C) 2004 Hammurapi Group
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (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
24package org.hammurapi;
25
26import java.util.Collection;
27import java.util.Date;
28
29/**
30 * Waiver is a way to suppress a particular violation.
31 * @author Pavel Vlasov
32 * @version $Revision: 1.4 $
33 */

34public interface Waiver {
35
36 static final String DATE_FORMAT = "yyyy/MM/dd";
37
38 /**
39 *
40 * @return Inspector name to which this waiver applies
41 */

42 String getInspectorName();
43
44 /**
45 * @param violation Violation to waive
46 * @param peek If true waiver doesn't change it state.
47 * @return true if Violation shall be waived
48 */

49 boolean waive(Violation violation, boolean peek);
50
51 Date getExpirationDate();
52
53 /**
54 * @return Description why waiver was given.
55 */

56 String getReason();
57
58 /**
59 * @return true if waiver can waive violations
60 */

61 boolean isActive();
62
63 /**
64 * @return Collection of signatures waived by this inspector. Can be null.
65 */

66 Collection getSignatures();
67}
68
69

Hammurapi 3 Copyright © 2004 Hammurapi Group. All Rights Reserved.