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 name.
25   */
26  @Plugin(name = "ThreadPatternConverter", category = PatternConverter.CATEGORY)
27  @ConverterKeys({ "t", "tn", "thread", "threadName" })
28  @PerformanceSensitive("allocation")
29  public final class ThreadNamePatternConverter extends LogEventPatternConverter {
30      /**
31       * Singleton.
32       */
33      private static final ThreadNamePatternConverter INSTANCE =
34          new ThreadNamePatternConverter();
35  
36      /**
37       * Private constructor.
38       */
39      private ThreadNamePatternConverter() {
40          super("Thread", "thread");
41      }
42  
43      /**
44       * Obtains an instance of ThreadPatternConverter.
45       *
46       * @param options options, currently ignored, may be null.
47       * @return instance of ThreadPatternConverter.
48       */
49      public static ThreadNamePatternConverter newInstance(
50          final String[] options) {
51          return INSTANCE;
52      }
53  
54      /**
55       * {@inheritDoc}
56       */
57      @Override
58      public void format(final LogEvent event, final StringBuilder toAppendTo) {
59          toAppendTo.append(event.getThreadName());
60      }
61  }