001/////////////////////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code and other text files for adherence to a set of rules. 003// Copyright (C) 2001-2024 the original author or authors. 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/////////////////////////////////////////////////////////////////////////////////////////////// 019 020package com.puppycrawl.tools.checkstyle.api; 021 022/** 023 * A Component that needs context information from its container(parent object) to work. 024 * The container will create a Context object and pass it to this 025 * Contextualizable. Contextualization will occur before configuration. 026 * Note: Configuring of object mean copy user defined properties to object. 027 * Contextualizing is inheriting some properties from parent that are provided by user 028 * to parent object or created by parent object. 029 * The general idea of Context/Contextualizable was taken from <a target="_top" 030 * href="https://avalon.apache.org/closed.html">Jakarta's Avalon framework</a>. 031 */ 032@FunctionalInterface 033public interface Contextualizable { 034 035 /** 036 * Sets the context for this Component. 037 * 038 * @param context the context. 039 * @throws CheckstyleException if there is a contextualization error. 040 */ 041 void contextualize(Context context) throws CheckstyleException; 042 043}