qadevOOo/runner/stats/InternalLogWriter.java

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: InternalLogWriter.java,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 package stats;
  31
  32 import java.io.PrintWriter;
  33 import java.io.StringWriter;
  34
  35 /**
  36  * Write all logs into a java.io.PrintWriter, i.e. a StringBuffer.
  37  * Log is gathered there.
  38  */
  39 public class InternalLogWriter extends PrintWriter
  40                                             implements share.LogWriter {
  41     /** log active **/
  42     boolean active;
  43     /** write all output to a StringBuffer **/
  44     static StringWriter writer = new StringWriter();
  45
  46     /**
  47      * c'*tor
  48      */
  49     public InternalLogWriter() {
  50          super(new PrintWriter(writer));
  51          active = true;
  52     }
  53
  54     /**
  55      * Initialization.
  56      * @param entry The description entry.
  57      * @param active Logging is active.
  58      * @return True, if initialize worked.
  59      */
  60     public boolean initialize(share.DescEntry entry, boolean active) {
  61         this.active = active;
  62         return true;
  63     }
  64
  65     /**
  66      * Method to print a line that is added to the StringBuffer.
  67      * @param msg The message that is printed.
  68      */
  69     public void println(String msg) {
  70         if (active)
  71             super.println(msg);
  72     }
  73
  74     /**
  75      * Method to print to the StringBuffer.
  76      * @param msg The message that is printed.
  77      */
  78     public void print(String msg) {
  79         if (active)
  80             super.print(msg);
  81
  82     }
  83
  84     /**
  85      * Is used to sum up the information.
  86      * The summary is also added to the StringBuffer.
  87      * @param entry The description entry.
  88      * @return True, if a summary could be created.
  89      */
  90     public boolean summary(share.DescEntry entry) {
  91 //        linePrefix = "";
  92         String header = "***** State for "+entry.longName+" ******";
  93         println(header);
  94         if (entry.hasErrorMsg) {
  95             println(entry.ErrorMsg);
  96             println("Whole "+entry.EntryType+": "+entry.State);
  97         } else {
  98             println("Whole "+entry.EntryType+": "+entry.State);
  99         }
 100         for (int i=0;i<header.length();i++) {
 101             print("*");
 102         }
 103         println("");
 104         return true;
 105     }
 106
 107     /**
 108      * Return all the written stuff.
 109      * @return All that was written to the StringBuffer with the
 110      * 'println()', 'print()' and 'summarize()' methods.
 111      * The StringBuffer is emptied afterwards.
 112      **/
 113     public String getLog() {
 114         String message = writer.getBuffer().toString();
 115         writer = new StringWriter();
 116         return message;
 117     }
 118
 119     public Object getWatcher() {
 120         return null;
 121     }
 122
 123     public void setWatcher(Object watcher) {
 124     }
 125
 126 }
 127