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.inspectors;
24:
25: import org.hammurapi.InspectorBase;
26:
27: import com.pavelvlasov.config.ConfigurationException;
28: import com.pavelvlasov.config.Parameterizable;
29: import com.pavelvlasov.jsel.Operation;
30:
31: /**
32: * ER-112
33: * Too many exceptions listed in throws clause
34: * @author Pavel Vlasov
35: * @version $Revision: 1.4 $
36: */
37: public class TooManyThrowsRule extends InspectorBase implements
38: Parameterizable {
39: /**
40: * Stores the setting form the configuration if static public final
41: * attributes are allowed in the code.
42: */
43: private Integer maxThrows;
44:
45: /**
46: * Reviews the operations, if they have in their throws clause more
47: * item than the preconfigured allowed maximum.
48: *
49: * @param element the operation to be reviewed.
50: */
51: public void visit(Operation element) {
52: if (element.getThrows().size() > maxThrows.intValue()) {
53: context.reportViolation(element);
54: }
55: }
56:
57: /**
58: * Configures the rule. Reads in the values of the parameters max-parameters and
59: * class-max-complexity.
60: *
61: * @param name the name of the parameter being loaded from Hammurapi configuration
62: * @param parameter the value of the parameter being loaded from Hammurapi configuration
63: * @exception ConfigurationException in case of a not supported parameter
64: */
65: public boolean setParameter(String name, Object parameter)
66: throws ConfigurationException {
67: if ("max-throws".equals(name)) {
68: maxThrows = (Integer) parameter;
69: return true;
70: }
71:
72: throw new ConfigurationException("Parameter '" + name
73: + "' is not supported by " + getClass().getName());
74: }
75:
76: /**
77: * Gives back the preconfigured values.
78: */
79: public String getConfigInfo() {
80: // if ()
81: StringBuffer ret = new StringBuffer(
82: "Allowed maximum item in the throws clause:\n");
83: //!!! Check for null
84: ret.append("max-throws: " + maxThrows + "\n");
85: return ret.toString();
86: }
87: }
|