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