View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements. See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache license, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License. You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the license for the specific language governing permissions and
15   * limitations under the license.
16   */
17  package org.apache.logging.log4j.core.pattern;
18  
19  import org.apache.logging.log4j.core.LogEvent;
20  import org.apache.logging.log4j.core.config.plugins.Plugin;
21  
22  /**
23   * Converts and formats the event's nanoTime in a StringBuilder.
24   */
25  @Plugin(name = "NanoTimePatternConverter", category = PatternConverter.CATEGORY)
26  @ConverterKeys({ "N", "nano" })
27  public final class NanoTimePatternConverter extends LogEventPatternConverter {
28  
29      /**
30       * Private constructor.
31       *
32       * @param options
33       *            options, may be null.
34       */
35      private NanoTimePatternConverter(final String[] options) {
36          super("Nanotime", "nanotime");
37      }
38  
39      /**
40       * Obtains an instance of pattern converter.
41       *
42       * @param options
43       *            options, may be null.
44       * @return instance of pattern converter.
45       */
46      public static NanoTimePatternConverter newInstance(final String[] options) {
47          return new NanoTimePatternConverter(options);
48      }
49  
50      /**
51       * {@inheritDoc}
52       */
53      @Override
54      public void format(final LogEvent event, final StringBuilder output) {
55          output.append(event.getNanoTime());
56      }
57  }