View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2026 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;
21  
22  import java.util.Collection;
23  import java.util.HashMap;
24  import java.util.HashSet;
25  import java.util.Map;
26  
27  import com.puppycrawl.tools.checkstyle.api.Context;
28  
29  /**
30   * A default implementation of the Context interface.
31   */
32  public final class DefaultContext implements Context {
33  
34      /** Stores the context entries. */
35      private final Map<String, Object> entries = new HashMap<>();
36  
37      /**
38       * Creates a new {@code DefaultContext} instance.
39       */
40      public DefaultContext() {
41          // no code by default
42      }
43  
44      @Override
45      public Object get(String key) {
46          return entries.get(key);
47      }
48  
49      @Override
50      public Collection<String> getAttributeNames() {
51          return new HashSet<>(entries.keySet());
52      }
53  
54      /**
55       * Adds a context entry.
56       *
57       * @param key the context key
58       * @param value the value for key
59       */
60      public void add(String key, Object value) {
61          entries.put(key, value);
62      }
63  
64  }