1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2024 the original author or authors.
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
20 package com.puppycrawl.tools.checkstyle.api;
21
22 import java.io.Serializable;
23 import java.util.Map;
24
25 /**
26 * A Configuration is used to configure a Configurable component. The general
27 * idea of Configuration/Configurable was taken from <a target="_top"
28 * href="https://avalon.apache.org/closed.html">Jakarta's Avalon framework</a>.
29 */
30 public interface Configuration extends Serializable {
31
32 /**
33 * The set of attribute names.
34 *
35 * @return The set of attribute names, never null.
36 * @deprecated This shall be removed in future releases. Please use
37 * {@code getPropertyNames()} instead.
38 */
39 @Deprecated(since = "8.45")
40 String[] getAttributeNames();
41
42 /**
43 * The attribute value for an attribute name.
44 *
45 * @param name the attribute name
46 * @return the value that is associated with name
47 * @throws CheckstyleException if name is not a valid attribute name
48 * @deprecated This shall be removed in future releases. Please use
49 * {@code getProperty(String name)} instead.
50 */
51 @Deprecated(since = "8.45")
52 String getAttribute(String name) throws CheckstyleException;
53
54 /**
55 * The set of property names.
56 *
57 * @return The set of property names, never null.
58 */
59 String[] getPropertyNames();
60
61 /**
62 * The property value for property name.
63 *
64 * @param name the property name
65 * @return the value that is associated with name
66 * @throws CheckstyleException if name is not a valid property name
67 */
68 String getProperty(String name) throws CheckstyleException;
69
70 /**
71 * The set of child configurations.
72 *
73 * @return The set of child configurations, never null.
74 */
75 Configuration[] getChildren();
76
77 /**
78 * The name of this configuration.
79 *
80 * @return The name of this configuration.
81 */
82 String getName();
83
84 /**
85 * Returns an unmodifiable map instance containing the custom messages
86 * for this configuration.
87 *
88 * @return unmodifiable map containing custom messages
89 */
90 Map<String, String> getMessages();
91
92 }