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 018package org.apache.log4j.pattern; 019 020import org.apache.log4j.spi.LocationInfo; 021import org.apache.log4j.spi.LoggingEvent; 022 023 024/** 025 * Formats the class name of the site of the logging request. 026 * 027 * @author Ceki Gülcü 028 */ 029public final class ClassNamePatternConverter extends NamePatternConverter { 030 /** 031 * Private constructor. 032 * @param options options, may be null. 033 */ 034 private ClassNamePatternConverter( 035 final String[] options) { 036 super("Class Name", "class name", options); 037 } 038 039 /** 040 * Gets an instance of ClassNamePatternConverter. 041 * @param options options, may be null. 042 * @return instance of pattern converter. 043 */ 044 public static ClassNamePatternConverter newInstance( 045 final String[] options) { 046 return new ClassNamePatternConverter(options); 047 } 048 049 /** 050 * Format a logging event. 051 * @param event event to format. 052 * @param toAppendTo string buffer to which class name will be appended. 053 */ 054 public void format(final LoggingEvent event, final StringBuffer toAppendTo) { 055 final int initialLength = toAppendTo.length(); 056 LocationInfo li = event.getLocationInformation(); 057 058 if (li == null) { 059 toAppendTo.append(LocationInfo.NA); 060 } else { 061 toAppendTo.append(li.getClassName()); 062 } 063 064 abbreviate(initialLength, toAppendTo); 065 } 066}