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/**
025 * Formats a logger name.
026 */
027@Plugin(name = "LoggerPatternConverter", category = PatternConverter.CATEGORY)
028@ConverterKeys({ "c", "logger" })
029@PerformanceSensitive("allocation")
030public final class LoggerPatternConverter extends NamePatternConverter {
031    /**
032     * Singleton.
033     */
034    private static final LoggerPatternConverter INSTANCE =
035        new LoggerPatternConverter(null);
036
037    /**
038     * Private constructor.
039     *
040     * @param options options, may be null.
041     */
042    private LoggerPatternConverter(final String[] options) {
043        super("Logger", "logger", options);
044    }
045
046    /**
047     * Obtains an instance of pattern converter.
048     *
049     * @param options options, may be null.
050     * @return instance of pattern converter.
051     */
052    public static LoggerPatternConverter newInstance(
053        final String[] options) {
054        if (options == null || options.length == 0) {
055            return INSTANCE;
056        }
057
058        return new LoggerPatternConverter(options);
059    }
060
061    /**
062     * {@inheritDoc}
063     */
064    @Override
065    public void format(final LogEvent event, final StringBuilder toAppendTo) {
066        abbreviate(event.getLoggerName(), toAppendTo);
067    }
068}