01: ////////////////////////////////////////////////////////////////////////////////
02: // checkstyle: Checks Java source code for adherence to a set of rules.
03: // Copyright (C) 2001-2007 Oliver Burn
04: //
05: // This library is free software; you can redistribute it and/or
06: // modify it under the terms of the GNU Lesser General Public
07: // License as published by the Free Software Foundation; either
08: // version 2.1 of the License, or (at your option) any later version.
09: //
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 needs context information from it's container to work.
23: * The container will create a Context object and pass it to this
24: * Contextualizable. Contextualization will occur before configuration. The
25: * general idea of Context/Contextualizable was taken from <a target="_top"
26: * href="http://jakarta.apache.org/avalon/">Jakarta's Avalon framework</a>.
27: * @author lkuehne
28: */
29: public interface Contextualizable {
30: /**
31: * Sets the context for this Component.
32: * @param aContext the context.
33: * @throws CheckstyleException if there is a contextualization error.
34: */
35: void contextualize(Context aContext) throws CheckstyleException;
36: }
|