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 * Return the event's line location information in a StringBuffer.
026 *
027 * @author Ceki Gülcü
028 */
029public final class FileLocationPatternConverter
030  extends LoggingEventPatternConverter {
031  /**
032   * Singleton.
033   */
034  private static final FileLocationPatternConverter INSTANCE =
035    new FileLocationPatternConverter();
036
037  /**
038   * Private constructor.
039   */
040  private FileLocationPatternConverter() {
041    super("File Location", "file");
042  }
043
044  /**
045   * Obtains an instance of pattern converter.
046   * @param options options, may be null.
047   * @return instance of pattern converter.
048   */
049  public static FileLocationPatternConverter newInstance(
050    final String[] options) {
051    return INSTANCE;
052  }
053
054  /**
055   * {@inheritDoc}
056   */
057  public void format(final LoggingEvent event, final StringBuffer output) {
058    LocationInfo locationInfo = event.getLocationInformation();
059
060    if (locationInfo != null) {
061      output.append(locationInfo.getFileName());
062    }
063  }
064}