1 ////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code for adherence to a set of rules.
3 // Copyright (C) 2001-2015 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 package com.puppycrawl.tools.checkstyle.api;
20
21
22 /**
23 * A Component that needs context information from it's container to work.
24 * The container will create a Context object and pass it to this
25 * Contextualizable. Contextualization will occur before configuration. The
26 * general idea of Context/Contextualizable was taken from <a target="_top"
27 * href="http://jakarta.apache.org/avalon/">Jakarta's Avalon framework</a>.
28 * @author lkuehne
29 */
30 public interface Contextualizable
31 {
32 /**
33 * Sets the context for this Component.
34 * @param context the context.
35 * @throws CheckstyleException if there is a contextualization error.
36 */
37 void contextualize(Context context) throws CheckstyleException;
38 }