/*
    * Licensed to the Apache Software Foundation (ASF) under one or more
    * contributor license agreements. See the NOTICE file distributed with
    * this work for additional information regarding copyright ownership.
    * The ASF licenses this file to You under the Apache license, Version 2.0
    * (the "License"); you may not use this file except in compliance with
    * the License. You may obtain a copy of the License at
    *
    *      http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the license for the specific language governing permissions and
   * limitations under the license.
   */
  package org.apache.logging.log4j.core.pattern;
  
  import org.apache.logging.log4j.core.LogEvent;
  import org.apache.logging.log4j.core.config.plugins.Plugin;
  import org.apache.logging.log4j.core.impl.LocationAware;
  
  /**
   * Returns the event's line location information in a StringBuilder.
   */
  @Plugin(name = "LineLocationPatternConverter", category = PatternConverter.CATEGORY)
  @ConverterKeys({ "L", "line" })
  public final class LineLocationPatternConverter extends LogEventPatternConverter implements LocationAware {
      /**
       * Singleton.
       */
      private static final LineLocationPatternConverter INSTANCE =
          new LineLocationPatternConverter();
  
      /**
       * Private constructor.
       */
      private LineLocationPatternConverter() {
          super("Line", "line");
      }
  
      /**
       * Obtains an instance of pattern converter.
       *
       * @param options options, may be null.
       * @return instance of pattern converter.
       */
      public static LineLocationPatternConverter newInstance(
          final String[] options) {
          return INSTANCE;
      }
  
      /**
       * {@inheritDoc}
       */
      @Override
      public void format(final LogEvent event, final StringBuilder output) {
          final StackTraceElement element = event.getSource();
  
          if (element != null) {
              output.append(element.getLineNumber());
          }
      }
  
      @Override
      public boolean requiresLocation() {
          return true;
      }
  }