KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > idaremedia > antx > capture > LogsRecorder


1 /**
2  * $Id: LogsRecorder.java 180 2007-03-15 12:56:38Z ssmc $
3  * Copyright 2002-2003,2005 iDare Media, Inc. All rights reserved.
4  *
5  * Originally written by iDare Media, Inc. for release into the public domain. This
6  * library, source form and binary form, is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public License as published by the
8  * Free Software Foundation; either version 2.1 of the License, or (at your option) any
9  * later version.<p>
10  *
11  * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
12  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13  * See the GNU LGPL (GNU Lesser General Public License) for more details.<p>
14  *
15  * You should have received a copy of the GNU Lesser General Public License along with this
16  * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite
17  * 330, Boston, MA 02111-1307 USA. The LGPL can be found online at
18  * http://www.fsf.org/copyleft/lesser.html<p>
19  *
20  * This product has been influenced by several projects within the open-source community.
21  * The JWare developers wish to acknowledge the open-source community's support. For more
22  * information regarding the open-source products used within JWare, please visit the
23  * JWare website.
24  *----------------------------------------------------------------------------------------*
25  * WEBSITE- http://www.jware.info EMAIL- inquiries@jware.info
26  *----------------------------------------------------------------------------------------*
27  **/
28
29 package com.idaremedia.antx.capture;
30
31 import com.idaremedia.antx.NoiseLevel;
32
33 /**
34  * Any iteration-based helper that captures Ant logged messages or System stream
35  * messages.
36  *
37  * @since JWare/AntX 0.2
38  * @author ssmc, &copy;2002-2003,2005 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
39  * @version 0.5
40  * @.safety n/a
41  * @.group impl,helper
42  **/
43
44 public interface LogsRecorder
45 {
46     /**
47      * Returns <i>true</i> if this recorder would consider the given
48      * noise level important.
49      * @param nl noise level (non-null)
50      **/
51     boolean isImportant(NoiseLevel nl);
52
53
54     /**
55      * Returns a <em>copy</em> of this recorder's current important
56      * logs. The returned messages are determined by what this
57      * recorder considers important.
58      * @see #isImportant
59      **/
60     String JavaDoc copyOfImportantLogs();
61
62
63     /**
64      * Returns a <em>copy</em> of all logs captured by this recorder
65      * so far. The returned string contains all levels of messages
66      * from debug to fatal since recorder was started or last reset.
67      * @see #copyOfImportantLogs
68      **/
69     String JavaDoc copyOfAllLogs();
70
71
72     /**
73      * Clears this recorder's logs as if no log event ever
74      * recorded.
75      **/
76     void clearLogs();
77 }
78
79 /* end-of-LogsRecorder.java */
80
Popular Tags