View Javadoc
1   ////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code for adherence to a set of rules.
3   // Copyright (C) 2001-2018 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  
20  package com.puppycrawl.tools.checkstyle.api;
21  
22  import java.util.Collection;
23  
24  /**
25   * A context to be used in subcomponents. The general idea of
26   * Context/Contextualizable was taken from <a target="_top"
27   * href="http://avalon.apache.org/closed.html">Jakarta's Avalon framework</a>.
28   * @see Contextualizable
29   */
30  public interface Context {
31  
32      /**
33       * Searches for the value with the specified attribute key in this context.
34       * @param key the attribute key.
35       * @return the value in this context with the specified attribute key value.
36       */
37      Object get(String key);
38  
39      /**
40       * Returns the names of all attributes of this context.
41       * @return the names of all attributes of this context.
42       */
43      Collection<String> getAttributeNames();
44  
45  }