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