001//////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code for adherence to a set of rules. 003// Copyright (C) 2001-2014 Oliver Burn 004// 005// This library is free software; you can redistribute it and/or 006// modify it under the terms of the GNU Lesser General Public 007// License as published by the Free Software Foundation; either 008// version 2.1 of the License, or (at your option) any later version. 009// 010// This library is distributed in the hope that it will be useful, 011// but WITHOUT ANY WARRANTY; without even the implied warranty of 012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 013// Lesser General Public License for more details. 014// 015// You should have received a copy of the GNU Lesser General Public 016// License along with this library; if not, write to the Free Software 017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 018//////////////////////////////////////////////////////////////////////////////// 019package com.puppycrawl.tools.checkstyle.api; 020 021 022/** 023 * A Component that needs context information from it's container to work. 024 * The container will create a Context object and pass it to this 025 * Contextualizable. Contextualization will occur before configuration. The 026 * general idea of Context/Contextualizable was taken from <a target="_top" 027 * href="http://jakarta.apache.org/avalon/">Jakarta's Avalon framework</a>. 028 * @author lkuehne 029 */ 030public interface Contextualizable 031{ 032 /** 033 * Sets the context for this Component. 034 * @param context the context. 035 * @throws CheckstyleException if there is a contextualization error. 036 */ 037 void contextualize(Context context) throws CheckstyleException; 038}