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  import org.apache.logging.log4j.core.util.Constants;
    22
    23  /**
    24   * Formats a line separator.
    25   */
    26  @Plugin(name = "LineSeparatorPatternConverter", category = PatternConverter.CATEGORY)
    27  @ConverterKeys({ "n" })
    28  public final class LineSeparatorPatternConverter extends LogEventPatternConverter {
    29
    30      /**
    31       * Singleton.
    32       */
    33      private static final LineSeparatorPatternConverter INSTANCE = new LineSeparatorPatternConverter();
    34
    35      /**
    36       * Line separator.
    37       */
    38      private final String lineSep;
    39
    40      /**
    41       * Private constructor.
    42       */
    43      private LineSeparatorPatternConverter() {
    44          super("Line Sep", "lineSep");
    45          lineSep = Constants.LINE_SEPARATOR;
    46      }
    47
    48      /**
    49       * Obtains an instance of pattern converter.
    50       *
    51       * @param options
    52       *        options, may be null.
    53       * @return instance of pattern converter.
    54       */
    55      public static LineSeparatorPatternConverter newInstance(final String[] options) {
    56          return INSTANCE;
    57      }
    58
    59      /**
    60       * {@inheritDoc}
    61       */
    62      @Override
    63      public void format(final LogEvent event, final StringBuilder toAppendTo) {
    64          toAppendTo.append(lineSep);
    65      }
    66  }