org.apache.log4j.pattern.MethodLocationPatternConverter Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.log4j.pattern;
import org.apache.log4j.spi.LocationInfo;
import org.apache.log4j.spi.LoggingEvent;
/**
* Return the event's line location information in a StringBuffer.
*
* @author Ceki Gülcü
*/
public final class MethodLocationPatternConverter
extends LoggingEventPatternConverter {
/**
* Singleton.
*/
private static final MethodLocationPatternConverter INSTANCE =
new MethodLocationPatternConverter();
/**
* Private constructor.
*/
private MethodLocationPatternConverter() {
super("Method", "method");
}
/**
* Obtains an instance of MethodLocationPatternConverter.
* @param options options, may be null.
* @return instance of MethodLocationPatternConverter.
*/
public static MethodLocationPatternConverter newInstance(
final String[] options) {
return INSTANCE;
}
/**
* {@inheritDoc}
*/
public void format(final LoggingEvent event, final StringBuffer toAppendTo) {
LocationInfo locationInfo = event.getLocationInformation();
if (locationInfo != null) {
toAppendTo.append(locationInfo.getMethodName());
}
}
}