Coverage Report - com.puppycrawl.tools.checkstyle.api.Configuration
 
Classes in this File Line Coverage Branch Coverage Complexity
Configuration
N/A
N/A
1
 
 1  
 ////////////////////////////////////////////////////////////////////////////////
 2  
 // checkstyle: Checks Java source code for adherence to a set of rules.
 3  
 // Copyright (C) 2001-2017 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  
 
 24  
 import com.google.common.collect.ImmutableMap;
 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://avalon.apache.org/closed.html">Jakarta's Avalon framework</a>.
 30  
  * @author lkuehne
 31  
  */
 32  
 public interface Configuration extends Serializable {
 33  
     /**
 34  
      * The set of attribute names.
 35  
      * @return The set of attribute names, never null.
 36  
      */
 37  
     String[] getAttributeNames();
 38  
 
 39  
     /**
 40  
      * The attribute value for an attribute name.
 41  
      * @param name the attribute name
 42  
      * @return the value that is associated with name
 43  
      * @throws CheckstyleException if name is not a valid attribute name
 44  
      */
 45  
     String getAttribute(String name) throws CheckstyleException;
 46  
 
 47  
     /**
 48  
      * The set of child configurations.
 49  
      * @return The set of child configurations, never null.
 50  
      */
 51  
     Configuration[] getChildren();
 52  
 
 53  
     /**
 54  
      * The name of this configuration.
 55  
      * @return The name of this configuration.
 56  
      */
 57  
     String getName();
 58  
 
 59  
     /**
 60  
      * Returns an unmodifiable map instance containing the custom messages
 61  
      * for this configuration.
 62  
      * @return unmodifiable map containing custom messages
 63  
      */
 64  
     ImmutableMap<String, String> getMessages();
 65  
 }