libjava/classpath/java/util/logging/SimpleFormatter.java

   1 /* SimpleFormatter.java --
   2    A class for formatting log records into short human-readable messages
   3    Copyright (C) 2002, 2004 Free Software Foundation, Inc.
   4
   5 This file is part of GNU Classpath.
   6
   7 GNU Classpath is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2, or (at your option)
  10 any later version.
  11
  12 GNU Classpath is distributed in the hope that it will be useful, but
  13 WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GNU Classpath; see the file COPYING.  If not, write to the
  19 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  20 02110-1301 USA.
  21
  22 Linking this library statically or dynamically with other modules is
  23 making a combined work based on this library.  Thus, the terms and
  24 conditions of the GNU General Public License cover the whole
  25 combination.
  26
  27 As a special exception, the copyright holders of this library give you
  28 permission to link this library with independent modules to produce an
  29 executable, regardless of the license terms of these independent
  30 modules, and to copy and distribute the resulting executable under
  31 terms of your choice, provided that you also meet, for each linked
  32 independent module, the terms and conditions of the license of that
  33 module.  An independent module is a module which is not derived from
  34 or based on this library.  If you modify this library, you may extend
  35 this exception to your version of the library, but you are not
  36 obligated to do so.  If you do not wish to do so, delete this
  37 exception statement from your version. */
  38
  39
  40 package java.util.logging;
  41
  42 import java.io.PrintWriter;
  43 import java.io.StringWriter;
  44 import java.text.DateFormat;
  45 import java.util.Date;
  46
  47 /**
  48  * A <code>SimpleFormatter</code> formats log records into
  49  * short human-readable messages, typically one or two lines.
  50  *
  51  * @author Sascha Brawer (brawer@acm.org)
  52  */
  53 public class SimpleFormatter
  54   extends Formatter
  55 {
  56   /**
  57    * Constructs a SimpleFormatter.
  58    */
  59   public SimpleFormatter()
  60   {
  61   }
  62
  63
  64   /**
  65    * An instance of a DateFormatter that is used for formatting
  66    * the time of a log record into a human-readable string,
  67    * according to the rules of the current locale.  The value
  68    * is set after the first invocation of format, since it is
  69    * common that a JVM will instantiate a SimpleFormatter without
  70    * ever using it.
  71    */
  72   private DateFormat dateFormat;
  73
  74   /**
  75    * The character sequence that is used to separate lines in the
  76    * generated stream. Somewhat surprisingly, the Sun J2SE 1.4
  77    * reference implementation always uses UNIX line endings, even on
  78    * platforms that have different line ending conventions (i.e.,
  79    * DOS). The GNU implementation does not replicate this bug.
  80    *
  81    * @see Sun bug parade, bug #4462871,
  82    * "java.util.logging.SimpleFormatter uses hard-coded line separator".
  83    */
  84   static final String lineSep = System.getProperty("line.separator");
  85
  86
  87   /**
  88    * Formats a log record into a String.
  89    *
  90    * @param record the log record to be formatted.
  91    *
  92    * @return a short human-readable message, typically one or two
  93    *   lines.  Lines are separated using the default platform line
  94    *   separator.
  95    *
  96    * @throws NullPointerException if <code>record</code>
  97    *         is <code>null</code>.
  98    */
  99   public String format(LogRecord record)
 100   {
 101     StringBuffer buf = new StringBuffer(180);
 102
 103     if (dateFormat == null)
 104       dateFormat = DateFormat.getDateTimeInstance();
 105
 106     buf.append(dateFormat.format(new Date(record.getMillis())));
 107     buf.append(' ');
 108     buf.append(record.getSourceClassName());
 109     buf.append(' ');
 110     buf.append(record.getSourceMethodName());
 111     buf.append(lineSep);
 112
 113     buf.append(record.getLevel());
 114     buf.append(": ");
 115     buf.append(formatMessage(record));
 116
 117     buf.append(lineSep);
 118
 119     Throwable throwable = record.getThrown();
 120     if (throwable != null)
 121       {
 122         StringWriter sink = new StringWriter();
 123         throwable.printStackTrace(new PrintWriter(sink, true));
 124         buf.append(sink.toString());
 125       }
 126
 127     return buf.toString();
 128   }
 129 }