qadevOOo/runner/share/LogWriter.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: LogWriter.java,v $
  10  * $Revision: 1.4 $
  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
  31 package share;
  32
  33 public interface LogWriter {
  34
  35     /**
  36      * Method to print
  37      */
  38     public void println(String msg);
  39
  40     /**
  41      * initialization
  42      *
  43      */
  44
  45     public boolean initialize(share.DescEntry entry, boolean active);
  46
  47     /**
  48      * will mostly be used by outproducers to sum up
  49      * the information, maybe write them to a db
  50      */
  51
  52     public boolean summary(share.DescEntry entry);
  53
  54
  55     /**
  56      * Returns the <CODE>Watcher</CODE> which is associated with this logger
  57      * @see share.Watcher
  58      * @return the associated <CODE>Watcher</CODE>
  59      */
  60     public Object getWatcher();
  61
  62     /**
  63      * Set a <CODE>Watcher</CODE> to the <CODE>LogWriter</CODE>
  64      * This is usefull if a test starts a new office instance by itself. In this cases
  65      * the <CODE>LogWritter</CODE> could retrigger the <CODE>Watcher</CODE>
  66      * @see share.Watcher
  67      * @param watcher the new <CODE>Watcher</CODE>
  68      */
  69     public void setWatcher(Object watcher);
  70
  71 }