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.core.pattern;
18  
19  import org.apache.logging.log4j.core.LogEvent;
20  import org.apache.logging.log4j.core.config.plugins.Plugin;
21  import org.apache.logging.log4j.util.PerformanceSensitive;
22  
23  /**
24   * Formats the event thread ID.
25   *
26   * @since 2.6
27   */
28  @Plugin(name = "ThreadIdPatternConverter", category = PatternConverter.CATEGORY)
29  @ConverterKeys({ "T", "tid", "threadId" })
30  @PerformanceSensitive("allocation")
31  public final class ThreadIdPatternConverter extends LogEventPatternConverter {
32      /**
33       * Singleton.
34       */
35      private static final ThreadIdPatternConverter INSTANCE =
36          new ThreadIdPatternConverter();
37  
38      /**
39       * Private constructor.
40       */
41      private ThreadIdPatternConverter() {
42          super("ThreadId", "threadId");
43      }
44  
45      /**
46       * Obtains an instance of ThreadPatternConverter.
47       *
48       * @param options options, currently ignored, may be null.
49       * @return instance of ThreadPatternConverter.
50       */
51      public static ThreadIdPatternConverter newInstance(
52          final String[] options) {
53          return INSTANCE;
54      }
55  
56      /**
57       * {@inheritDoc}
58       */
59      @Override
60      public void format(final LogEvent event, final StringBuilder toAppendTo) {
61          toAppendTo.append(event.getThreadId());
62      }
63  }