KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > puppycrawl > tools > checkstyle > api > Configuration


1 ////////////////////////////////////////////////////////////////////////////////
2
// checkstyle: Checks Java source code for adherence to a set of rules.
3
// Copyright (C) 2001-2005 Oliver Burn
4
//
5
// This library is free software; you can redistribute it and/or
6
// modify it under the terms of the GNU Lesser General Public
7
// License as published by the Free Software Foundation; either
8
// version 2.1 of the License, or (at your option) any later version.
9
//
10
// This library is distributed in the hope that it will be useful,
11
// but WITHOUT ANY WARRANTY; without even the implied warranty of
12
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13
// Lesser General Public License for more details.
14
//
15
// You should have received a copy of the GNU Lesser General Public
16
// License along with this library; if not, write to the Free Software
17
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
////////////////////////////////////////////////////////////////////////////////
19
package com.puppycrawl.tools.checkstyle.api;
20
21 import java.io.Serializable JavaDoc;
22
23
24 /**
25  * A Configuration is used to configure a Configurable component. The general
26  * idea of Configuration/Configurable was taken from <a target="_top"
27  * HREF="http://jakarta.apache.org/avalon/">Jakarta's Avalon framework</a>.
28  * @author lkuehne
29  */

30 public interface Configuration extends Serializable JavaDoc
31 {
32     /**
33      * The set of attribute names.
34      * @return The set of attribute names, never null.
35      */

36     String JavaDoc[] getAttributeNames();
37
38     /**
39      * The attribute value for an attribute name.
40      * @param aName the attribute name
41      * @return the value that is associated with aName
42      * @throws CheckstyleException if aName is not a valid attribute name
43      */

44     String JavaDoc getAttribute(String JavaDoc aName) throws CheckstyleException;
45
46     /**
47      * The set of child configurations.
48      * @return The set of child configurations, never null.
49      */

50     Configuration[] getChildren();
51
52     /**
53      * The name of this configuration.
54      * @return The name of this configuration.
55      */

56     String JavaDoc getName();
57 }
58
Popular Tags