1 //////////////////////////////////////////////////////////////////////////////// 2 // checkstyle: Checks Java source code for adherence to a set of rules. 3 // Copyright (C) 2001-2019 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="http://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 * @return The set of attribute names, never null. 35 */ 36 String[] getAttributeNames(); 37 38 /** 39 * The attribute value for an attribute name. 40 * @param name the attribute name 41 * @return the value that is associated with name 42 * @throws CheckstyleException if name is not a valid attribute name 43 */ 44 String getAttribute(String name) 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 getName(); 57 58 /** 59 * Returns an unmodifiable map instance containing the custom messages 60 * for this configuration. 61 * @return unmodifiable map containing custom messages 62 */ 63 Map<String, String> getMessages(); 64 65 }