1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 package share;
25 
26 public interface LogWriter {
27 
28     /**
29      * Method to print
30      */
println(String msg)31     public void println(String msg);
32 
33     /**
34      * initialization
35      *
36      */
37 
initialize(share.DescEntry entry, boolean active)38     public boolean initialize(share.DescEntry entry, boolean active);
39 
40     /**
41      * will mostly be used by outproducers to sum up
42      * the information, maybe write them to a db
43      */
44 
summary(share.DescEntry entry)45     public boolean summary(share.DescEntry entry);
46 
47 
48     /**
49      * Returns the <CODE>Watcher</CODE> which is associated with this logger
50      * @see share.Watcher
51      * @return the associated <CODE>Watcher</CODE>
52      */
getWatcher()53     public Object getWatcher();
54 
55     /**
56      * Set a <CODE>Watcher</CODE> to the <CODE>LogWriter</CODE>
57      * This is useful if a test starts a new office instance by itself. In this cases
58      * the <CODE>LogWritter</CODE> could retrigger the <CODE>Watcher</CODE>
59      * @see share.Watcher
60      * @param watcher the new <CODE>Watcher</CODE>
61      */
setWatcher(Object watcher)62     public void setWatcher(Object watcher);
63 
64 }
65