| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| Configurable |
|
| 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 | /** | |
| 22 | * A component that can be configured. The general idea of | |
| 23 | * Configuration/Configurable was taken from <a target="_top" | |
| 24 | * href="http://jakarta.apache.org/avalon/">Jakarta's Avalon framework</a>. | |
| 25 | * @author lkuehne | |
| 26 | */ | |
| 27 | public interface Configurable | |
| 28 | { | |
| 29 | /** | |
| 30 | * Configures this component. | |
| 31 | * @param aConfiguration the configuration to use. | |
| 32 | * @throws CheckstyleException if there is a configuration error. | |
| 33 | */ | |
| 34 | void configure(Configuration aConfiguration) throws CheckstyleException; | |
| 35 | } |