View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements. See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache license, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License. You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the license for the specific language governing permissions and
15   * limitations under the license.
16   */
17  package org.apache.logging.log4j.spi;
18  
19  import java.util.Map;
20  
21  /**
22   * Extension service provider interface to allow putting Object values in the
23   * {@link org.apache.logging.log4j.ThreadContext}.
24   *
25   * @see ThreadContextMap
26   * @since 2.8
27   */
28  public interface ObjectThreadContextMap extends CleanableThreadContextMap {
29  
30      /**
31       * Returns the Object value for the specified key, or {@code null} if the specified key does not exist in this
32       * collection.
33       *
34       * @param key the key whose value to return
35       * @return the value for the specified key or {@code null}
36       */
37      <V> V getValue(String key);
38  
39      /**
40       * Puts the specified key-value pair into the collection.
41       *
42       * @param key the key to add or remove. Keys may be {@code null}.
43       * @param value the value to add. Values may be {@code null}.
44       */
45      <V> void putValue(String key, V value);
46  
47      /**
48       * Puts all given key-value pairs into the collection.
49       *
50       * @param values the map of key-value pairs to add
51       */
52      <V> void putAllValues(Map<String, V> values);
53  
54  }