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
018package org.apache.log4j.pattern;
019
020import org.apache.log4j.Layout;
021import org.apache.log4j.spi.LoggingEvent;
022
023
024/**
025 * Formats a line separator.
026 *
027 * @author Ceki Gülcü
028 */
029public final class LineSeparatorPatternConverter
030  extends LoggingEventPatternConverter {
031  /**
032   * Singleton.
033   */
034  private static final LineSeparatorPatternConverter INSTANCE =
035    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 = Layout.LINE_SEP;
048  }
049
050  /**
051   * Obtains an instance of pattern converter.
052   * @param options options, may be null.
053   * @return instance of pattern converter.
054   */
055  public static LineSeparatorPatternConverter newInstance(
056    final String[] options) {
057    return INSTANCE;
058  }
059
060  /**
061   * {@inheritDoc}
062   */
063  public void format(LoggingEvent event, final StringBuffer toAppendTo) {
064    toAppendTo.append(lineSep);
065  }
066
067  /**
068   * {@inheritDoc}
069   */
070  public void format(final Object obj, final StringBuffer toAppendTo) {
071    toAppendTo.append(lineSep);
072  }
073}