    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     * Returns the event's line location information in a StringBuilder.
    025     */
    026    @Plugin(name = "FileLocationPatternConverter", category = PatternConverter.CATEGORY)
    027    @ConverterKeys({ "F", "file" })
    028    public final class FileLocationPatternConverter extends LogEventPatternConverter {
    029        /**
    030         * Singleton.
    031         */
    032        private static final FileLocationPatternConverter INSTANCE =
    033            new FileLocationPatternConverter();
    034
    035        /**
    036         * Private constructor.
    037         */
    038        private FileLocationPatternConverter() {
    039            super("File Location", "file");
    040        }
    041
    042        /**
    043         * Obtains an instance of pattern converter.
    044         *
    045         * @param options options, may be null.
    046         * @return instance of pattern converter.
    047         */
    048        public static FileLocationPatternConverter newInstance(final String[] options) {
    049            return INSTANCE;
    050        }
    051
    052        /**
    053         * {@inheritDoc}
    054         */
    055        @Override
    056        public void format(final LogEvent event, final StringBuilder output) {
    057            final StackTraceElement element = event.getSource();
    058
    059            if (element != null) {
    060                output.append(element.getFileName());
    061            }
    062        }
    063    }