srcjar/org/apache/log4j/pattern/LineSeparatorPatternConverter.java

   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
  18 package org.apache.log4j.pattern;
  19
  20 import org.apache.log4j.Layout;
  21 import org.apache.log4j.spi.LoggingEvent;
  22
  23
  24 /**
  25  * Formats a line separator.
  26  *
  27  * @author Ceki G&uuml;lc&uuml;
  28  */
  29 public final class LineSeparatorPatternConverter
  30   extends LoggingEventPatternConverter {
  31   /**
  32    * Singleton.
  33    */
  34   private static final LineSeparatorPatternConverter INSTANCE =
  35     new LineSeparatorPatternConverter();
  36
  37   /**
  38    * Line separator.
  39    */
  40   private final String lineSep;
  41
  42   /**
  43    * Private constructor.
  44    */
  45   private LineSeparatorPatternConverter() {
  46     super("Line Sep", "lineSep");
  47     lineSep = Layout.LINE_SEP;
  48   }
  49
  50   /**
  51    * Obtains an instance of pattern converter.
  52    * @param options options, may be null.
  53    * @return instance of pattern converter.
  54    */
  55   public static LineSeparatorPatternConverter newInstance(
  56     final String[] options) {
  57     return INSTANCE;
  58   }
  59
  60   /**
  61    * {@inheritDoc}
  62    */
  63   public void format(LoggingEvent event, final StringBuffer toAppendTo) {
  64     toAppendTo.append(lineSep);
  65   }
  66
  67   /**
  68    * {@inheritDoc}
  69    */
  70   public void format(final Object obj, final StringBuffer toAppendTo) {
  71     toAppendTo.append(lineSep);
  72   }
  73 }