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 /** 024 * Formats the class name of the site of the logging request. 025 */ 026 @Plugin(name = "ClassNamePatternConverter", type = "Converter") 027 @ConverterKeys({"C", "class" }) 028 public final class ClassNamePatternConverter extends NamePatternConverter { 029 030 private static final String NA = "?"; 031 /** 032 * Private constructor. 033 * 034 * @param options options, may be null. 035 */ 036 private ClassNamePatternConverter( 037 final String[] options) { 038 super("Class Name", "class name", options); 039 } 040 041 /** 042 * Gets an instance of ClassNamePatternConverter. 043 * 044 * @param options options, may be null. 045 * @return instance of pattern converter. 046 */ 047 public static ClassNamePatternConverter newInstance(final String[] options) { 048 return new ClassNamePatternConverter(options); 049 } 050 051 /** 052 * Format a logging event. 053 * 054 * @param event event to format. 055 * @param toAppendTo string buffer to which class name will be appended. 056 */ 057 @Override 058 public void format(final LogEvent event, final StringBuilder toAppendTo) { 059 060 StackTraceElement element = event.getSource(); 061 062 if (element == null) { 063 toAppendTo.append(NA); 064 } else { 065 toAppendTo.append(abbreviate(element.getClassName())); 066 } 067 } 068 }