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