KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > hammurapi > inspectors > TooManyThrowsRule


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 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 Parameterizable {
38     /**
39      * Stores the setting form the configuration if static public final
40      * attributes are allowed in the code.
41      */
42     private Integer JavaDoc maxThrows;
43     
44     /**
45      * Reviews the operations, if they have in their throws clause more
46      * item than the preconfigured allowed maximum.
47      *
48      * @param element the operation to be reviewed.
49      */
50     public void visit(Operation element) {
51         if (element.getThrows().size()>maxThrows.intValue()) {
52             context.reportViolation(element);
53         }
54     }
55     
56     /**
57      * Configures the rule. Reads in the values of the parameters max-parameters and
58      * class-max-complexity.
59      *
60      * @param name the name of the parameter being loaded from Hammurapi configuration
61      * @param parameter the value of the parameter being loaded from Hammurapi configuration
62      * @exception ConfigurationException in case of a not supported parameter
63      */
64     public boolean setParameter(String JavaDoc name, Object JavaDoc parameter) throws ConfigurationException {
65         if ("max-throws".equals(name)) {
66             maxThrows = (Integer JavaDoc) parameter;
67             return true;
68         }
69         
70         throw new ConfigurationException("Parameter '"+name+"' is not supported by "+getClass().getName());
71     }
72
73     /**
74      * Gives back the preconfigured values.
75      */
76     public String JavaDoc getConfigInfo() {
77 // if ()
78 StringBuffer JavaDoc ret=new StringBuffer JavaDoc("Allowed maximum item in the throws clause:\n");
79 //!!! Check for null
80 ret.append("max-throws: " + maxThrows + "\n");
81         return ret.toString();
82     }
83 }
84
Popular Tags