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     */
017    package org.apache.logging.log4j.core.pattern;
018    
019    import org.apache.logging.log4j.core.LogEvent;
020    import org.apache.logging.log4j.core.config.plugins.Plugin;
021    
022    /**
023     * Formats the event thread name.
024     */
025    @Plugin(name = "ThreadPatternConverter", category = PatternConverter.CATEGORY)
026    @ConverterKeys({ "t", "thread" })
027    public final class ThreadPatternConverter extends LogEventPatternConverter {
028        /**
029         * Singleton.
030         */
031        private static final ThreadPatternConverter INSTANCE =
032            new ThreadPatternConverter();
033    
034        /**
035         * Private constructor.
036         */
037        private ThreadPatternConverter() {
038            super("Thread", "thread");
039        }
040    
041        /**
042         * Obtains an instance of ThreadPatternConverter.
043         *
044         * @param options options, currently ignored, may be null.
045         * @return instance of ThreadPatternConverter.
046         */
047        public static ThreadPatternConverter newInstance(
048            final String[] options) {
049            return INSTANCE;
050        }
051    
052        /**
053         * {@inheritDoc}
054         */
055        @Override
056        public void format(final LogEvent event, final StringBuilder toAppendTo) {
057            toAppendTo.append(event.getThreadName());
058        }
059    }