001/* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache license, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the license for the specific language governing permissions and 015 * limitations under the license. 016 */ 017package org.apache.logging.log4j.core.pattern; 018 019import org.apache.logging.log4j.core.LogEvent; 020import org.apache.logging.log4j.core.config.plugins.Plugin; 021import org.apache.logging.log4j.util.PerformanceSensitive; 022 023/** 024 * Formats the event thread name. 025 */ 026@Plugin(name = "ThreadPatternConverter", category = PatternConverter.CATEGORY) 027@ConverterKeys({ "t", "tn", "thread", "threadName" }) 028@PerformanceSensitive("allocation") 029public final class ThreadNamePatternConverter extends LogEventPatternConverter { 030 /** 031 * Singleton. 032 */ 033 private static final ThreadNamePatternConverter INSTANCE = 034 new ThreadNamePatternConverter(); 035 036 /** 037 * Private constructor. 038 */ 039 private ThreadNamePatternConverter() { 040 super("Thread", "thread"); 041 } 042 043 /** 044 * Obtains an instance of ThreadPatternConverter. 045 * 046 * @param options options, currently ignored, may be null. 047 * @return instance of ThreadPatternConverter. 048 */ 049 public static ThreadNamePatternConverter newInstance( 050 final String[] options) { 051 return INSTANCE; 052 } 053 054 /** 055 * {@inheritDoc} 056 */ 057 @Override 058 public void format(final LogEvent event, final StringBuilder toAppendTo) { 059 toAppendTo.append(event.getThreadName()); 060 } 061}