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