KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > hammurapi > ParameterizableInspectorBase


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;
24
25 import java.util.ArrayList JavaDoc;
26 import java.util.Collection JavaDoc;
27 import java.util.Iterator JavaDoc;
28
29 import com.pavelvlasov.config.ConfigurationException;
30 import com.pavelvlasov.config.Parameterizable;
31
32 /**
33  * Base class for inspectors which require extensive configuration by different helper classes.
34  * @author Pavel Vlasov
35  * @version $Revision: 1.1 $
36  */

37 public class ParameterizableInspectorBase extends InspectorBase implements Parameterizable {
38     private Collection JavaDoc configurators=new ArrayList JavaDoc();
39
40     /**
41      * Adds a helper class (configurator) to the list of configurators.
42      * @param configurator
43      */

44     protected void addConfigurator(Parameterizable configurator) {
45         configurators.add(configurator);
46     }
47     
48     
49     /**
50      * Iterates through configurators and passes parameter to them unless it is handled.
51      * @param name the name of the parameter being loaded from Hammurapi configuration
52      * @param value the value of the parameter being loaded from Hammurapi configuration
53      * @exception ConfigurationException in case of a not supported parameter
54      */

55     public boolean setParameter(String JavaDoc name, Object JavaDoc value) throws ConfigurationException {
56         Iterator JavaDoc it=configurators.iterator();
57         while (it.hasNext()) {
58             if (((Parameterizable) it.next()).setParameter(name, value)) {
59                 return true;
60             }
61         }
62         return false;
63     }
64 }
65
Popular Tags