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 ID.
025 *
026 * @since 2.6
027 */
028@Plugin(name = "ThreadIdPatternConverter", category = PatternConverter.CATEGORY)
029@ConverterKeys({ "T", "tid", "threadId" })
030@PerformanceSensitive("allocation")
031public final class ThreadIdPatternConverter extends LogEventPatternConverter {
032    /**
033     * Singleton.
034     */
035    private static final ThreadIdPatternConverter INSTANCE =
036        new ThreadIdPatternConverter();
037
038    /**
039     * Private constructor.
040     */
041    private ThreadIdPatternConverter() {
042        super("ThreadId", "threadId");
043    }
044
045    /**
046     * Obtains an instance of ThreadPatternConverter.
047     *
048     * @param options options, currently ignored, may be null.
049     * @return instance of ThreadPatternConverter.
050     */
051    public static ThreadIdPatternConverter newInstance(
052        final String[] options) {
053        return INSTANCE;
054    }
055
056    /**
057     * {@inheritDoc}
058     */
059    @Override
060    public void format(final LogEvent event, final StringBuilder toAppendTo) {
061        toAppendTo.append(event.getThreadId());
062    }
063}