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