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.core.util.Constants;
022
023/**
024 * Formats a line separator.
025 */
026@Plugin(name = "LineSeparatorPatternConverter", category = PatternConverter.CATEGORY)
027@ConverterKeys({ "n" })
028public final class LineSeparatorPatternConverter extends LogEventPatternConverter {
029
030    /**
031     * Singleton.
032     */
033    private static final LineSeparatorPatternConverter INSTANCE = new LineSeparatorPatternConverter();
034
035    /**
036     * Line separator.
037     */
038    private final String lineSep;
039
040    /**
041     * Private constructor.
042     */
043    private LineSeparatorPatternConverter() {
044        super("Line Sep", "lineSep");
045        lineSep = Constants.LINE_SEPARATOR;
046    }
047
048    /**
049     * Obtains an instance of pattern converter.
050     *
051     * @param options
052     *        options, may be null.
053     * @return instance of pattern converter.
054     */
055    public static LineSeparatorPatternConverter newInstance(final String[] options) {
056        return INSTANCE;
057    }
058
059    /**
060     * {@inheritDoc}
061     */
062    @Override
063    public void format(final LogEvent event, final StringBuilder toAppendTo) {
064        toAppendTo.append(lineSep);
065    }
066}