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 /** 24 * Formats a logger name. 25 */ 26 @Plugin(name = "LoggerPatternConverter", category = PatternConverter.CATEGORY) 27 @ConverterKeys({ "c", "logger" }) 28 public final class LoggerPatternConverter extends NamePatternConverter { 29 /** 30 * Singleton. 31 */ 32 private static final LoggerPatternConverter INSTANCE = 33 new LoggerPatternConverter(null); 34 35 /** 36 * Private constructor. 37 * 38 * @param options options, may be null. 39 */ 40 private LoggerPatternConverter(final String[] options) { 41 super("Logger", "logger", options); 42 } 43 44 /** 45 * Obtains an instance of pattern converter. 46 * 47 * @param options options, may be null. 48 * @return instance of pattern converter. 49 */ 50 public static LoggerPatternConverter newInstance( 51 final String[] options) { 52 if (options == null || options.length == 0) { 53 return INSTANCE; 54 } 55 56 return new LoggerPatternConverter(options); 57 } 58 59 /** 60 * {@inheritDoc} 61 */ 62 @Override 63 public void format(final LogEvent event, final StringBuilder toAppendTo) { 64 toAppendTo.append(abbreviate(event.getLoggerName())); 65 } 66 }