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.Marker; 020import org.apache.logging.log4j.core.LogEvent; 021import org.apache.logging.log4j.core.config.plugins.Plugin; 022import org.apache.logging.log4j.util.PerformanceSensitive; 023 024/** 025 * Appends an event's maker name to a StringBuilder. 026 */ 027@Plugin(name = "MarkerNamePatternConverter", category = PatternConverter.CATEGORY) 028@ConverterKeys({ "markerSimpleName" }) 029@PerformanceSensitive("allocation") 030public final class MarkerSimpleNamePatternConverter extends LogEventPatternConverter { 031 032 /** 033 * Private constructor. 034 * @param options options, may be null. 035 */ 036 private MarkerSimpleNamePatternConverter(final String[] options) { 037 super("MarkerSimpleName", "markerSimpleName"); 038 } 039 040 /** 041 * Obtains an instance of pattern converter. 042 * 043 * @param options options, may be null. 044 * @return instance of pattern converter. 045 */ 046 public static MarkerSimpleNamePatternConverter newInstance(final String[] options) { 047 return new MarkerSimpleNamePatternConverter(options); 048 } 049 050 /** 051 * {@inheritDoc} 052 */ 053 @Override 054 public void format(final LogEvent event, final StringBuilder toAppendTo) { 055 final Marker marker = event.getMarker(); 056 if (marker != null) { 057 toAppendTo.append(marker.getName()); 058 } 059 } 060}