1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 package share;
29 
30 public interface LogWriter {
31 
32     /**
33      * Method to print
34      */
35     public void println(String msg);
36 
37     /**
38      * initialization
39      *
40      */
41 
42     public boolean initialize(share.DescEntry entry, boolean active);
43 
44     /**
45      * will mostly be used by outproducers to sum up
46      * the information, maybe write them to a db
47      */
48 
49     public boolean summary(share.DescEntry entry);
50 
51 
52     /**
53      * Returns the <CODE>Watcher</CODE> which is associated with this logger
54      * @see share.Watcher
55      * @return the associated <CODE>Watcher</CODE>
56      */
57     public Object getWatcher();
58 
59     /**
60      * Set a <CODE>Watcher</CODE> to the <CODE>LogWriter</CODE>
61      * This is usefull if a test starts a new office instance by itself. In this cases
62      * the <CODE>LogWritter</CODE> could retrigger the <CODE>Watcher</CODE>
63      * @see share.Watcher
64      * @param watcher the new <CODE>Watcher</CODE>
65      */
66     public void setWatcher(Object watcher);
67 
68 }
69