Coverage Report - com.puppycrawl.tools.checkstyle.api.Configurable
 
Classes in this File Line Coverage Branch Coverage Complexity
Configurable
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  
 /**
 23  
  * A component that can be configured.
 24  
  * Note: Configuring of object mean copy user defined properties to object.
 25  
  * Contextualizing is inheriting some properties from parent that are provided by user
 26  
  * to parent object or created by parent object.
 27  
  * The general idea of
 28  
  * 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  
 @FunctionalInterface
 33  
 public interface Configurable {
 34  
     /**
 35  
      * Configures this component.
 36  
      * @param configuration the configuration to use.
 37  
      * @throws CheckstyleException if there is a configuration error.
 38  
      */
 39  
     void configure(Configuration configuration) throws CheckstyleException;
 40  
 }