Context


1   ////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code for adherence to a set of rules.
3   // Copyright (C) 2001-2005  Oliver Burn
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  package com.puppycrawl.tools.checkstyle.api;
20  
21  /**
22   * A context to be used in subcomponents. The general idea of
23   * Context/Contextualizable was taken from <a target="_top"
24   * HREF="http://jakarta.apache.org/avalon/">Jakarta's Avalon framework</a>.
25   * @author lkuehne
26   * @see Contextualizable
27   */
28  public interface Context
29  {
30      /**
31       * Searches for the value with the specified attribute key in this context.
32       * @param aKey the attribute key.
33       * @return the value in this context with the specified attribute key value.
34       */
35      Object   get(String   aKey);
36  
37      /**
38       * Returns the names of all atttributes of this context.
39       * @return the names of all atttributes of this context.
40       */
41      String  [] getAttributeNames();
42  }
43
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags