001    /* SimpleFormatter.java --
002       A class for formatting log records into short human-readable messages
003       Copyright (C) 2002, 2004 Free Software Foundation, Inc.
004    
005    This file is part of GNU Classpath.
006    
007    GNU Classpath is free software; you can redistribute it and/or modify
008    it under the terms of the GNU General Public License as published by
009    the Free Software Foundation; either version 2, or (at your option)
010    any later version.
011    
012    GNU Classpath is distributed in the hope that it will be useful, but
013    WITHOUT ANY WARRANTY; without even the implied warranty of
014    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
015    General Public License for more details.
016    
017    You should have received a copy of the GNU General Public License
018    along with GNU Classpath; see the file COPYING.  If not, write to the
019    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
020    02110-1301 USA.
021    
022    Linking this library statically or dynamically with other modules is
023    making a combined work based on this library.  Thus, the terms and
024    conditions of the GNU General Public License cover the whole
025    combination.
026    
027    As a special exception, the copyright holders of this library give you
028    permission to link this library with independent modules to produce an
029    executable, regardless of the license terms of these independent
030    modules, and to copy and distribute the resulting executable under
031    terms of your choice, provided that you also meet, for each linked
032    independent module, the terms and conditions of the license of that
033    module.  An independent module is a module which is not derived from
034    or based on this library.  If you modify this library, you may extend
035    this exception to your version of the library, but you are not
036    obligated to do so.  If you do not wish to do so, delete this
037    exception statement from your version. */
038    
039    
040    package java.util.logging;
041    
042    import java.io.PrintWriter;
043    import java.io.StringWriter;
044    import java.text.DateFormat;
045    import java.util.Date;
046    
047    /**
048     * A <code>SimpleFormatter</code> formats log records into
049     * short human-readable messages, typically one or two lines.
050     *
051     * @author Sascha Brawer (brawer@acm.org)
052     */
053    public class SimpleFormatter
054      extends Formatter
055    {
056      /**
057       * Constructs a SimpleFormatter.
058       */
059      public SimpleFormatter()
060      {
061      }
062    
063    
064      /**
065       * An instance of a DateFormatter that is used for formatting
066       * the time of a log record into a human-readable string,
067       * according to the rules of the current locale.  The value
068       * is set after the first invocation of format, since it is
069       * common that a JVM will instantiate a SimpleFormatter without
070       * ever using it.
071       */
072      private DateFormat dateFormat;
073    
074      /**
075       * The character sequence that is used to separate lines in the
076       * generated stream. Somewhat surprisingly, the Sun J2SE 1.4
077       * reference implementation always uses UNIX line endings, even on
078       * platforms that have different line ending conventions (i.e.,
079       * DOS). The GNU implementation does not replicate this bug.
080       *
081       * @see Sun bug parade, bug #4462871,
082       * "java.util.logging.SimpleFormatter uses hard-coded line separator".
083       */
084      static final String lineSep = System.getProperty("line.separator");
085    
086    
087      /**
088       * Formats a log record into a String.
089       *
090       * @param record the log record to be formatted.
091       *
092       * @return a short human-readable message, typically one or two
093       *   lines.  Lines are separated using the default platform line
094       *   separator.
095       *
096       * @throws NullPointerException if <code>record</code>
097       *         is <code>null</code>.
098       */
099      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    }