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