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 022import java.util.Collection; 023 024/** 025 * A context to be used in subcomponents. The general idea of 026 * Context/Contextualizable was taken from <a target="_top" 027 * href="https://avalon.apache.org/closed.html">Jakarta's Avalon framework</a>. 028 * 029 * @see Contextualizable 030 */ 031public interface Context { 032 033 /** 034 * Searches for the value with the specified attribute key in this context. 035 * 036 * @param key the attribute key. 037 * @return the value in this context with the specified attribute key value. 038 */ 039 Object get(String key); 040 041 /** 042 * Returns the names of all attributes of this context. 043 * 044 * @return the names of all attributes of this context. 045 */ 046 Collection<String> getAttributeNames(); 047 048}