Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
Configuration |
|
| 1.0;1 |
1 | //////////////////////////////////////////////////////////////////////////////// | |
2 | // checkstyle: Checks Java source code for adherence to a set of rules. | |
3 | // Copyright (C) 2001-2014 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 com.google.common.collect.ImmutableMap; | |
22 | ||
23 | import java.io.Serializable; | |
24 | ||
25 | ||
26 | /** | |
27 | * A Configuration is used to configure a Configurable component. The general | |
28 | * idea of Configuration/Configurable was taken from <a target="_top" | |
29 | * href="http://jakarta.apache.org/avalon/">Jakarta's Avalon framework</a>. | |
30 | * @author lkuehne | |
31 | */ | |
32 | public interface Configuration extends Serializable | |
33 | { | |
34 | /** | |
35 | * The set of attribute names. | |
36 | * @return The set of attribute names, never null. | |
37 | */ | |
38 | String[] getAttributeNames(); | |
39 | ||
40 | /** | |
41 | * The attribute value for an attribute name. | |
42 | * @param aName the attribute name | |
43 | * @return the value that is associated with aName | |
44 | * @throws CheckstyleException if aName is not a valid attribute name | |
45 | */ | |
46 | String getAttribute(String aName) throws CheckstyleException; | |
47 | ||
48 | /** | |
49 | * The set of child configurations. | |
50 | * @return The set of child configurations, never null. | |
51 | */ | |
52 | Configuration[] getChildren(); | |
53 | ||
54 | /** | |
55 | * The name of this configuration. | |
56 | * @return The name of this configuration. | |
57 | */ | |
58 | String getName(); | |
59 | ||
60 | /** | |
61 | * Returns an unmodifiable map instance containing the custom messages | |
62 | * for this configuration. | |
63 | * @return unmodifiable map containing custom messages | |
64 | */ | |
65 | ImmutableMap<String, String> getMessages(); | |
66 | } |