KickJava   Java API By Example, From Geeks To Geeks.

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


1 /**
2  * $Id: ClearLoggedTask.java 180 2007-03-15 12:56:38Z ssmc $
3  * Copyright 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 (LGPL) as published
8  * by the Free Software Foundation; either version 2.1 of the License, or (at your option)
9  * any 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 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 GNU 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.AntX;
32
33 /**
34  * Helper task the clears the nearest {@linkplain LogsRecorder}. This task
35  * is most often used to reset a top-level
36  * &lt;{@linkplain CaptureStreamsTask captureoutput}&gt;
37  * so that the next &lt;copylogged&gt; captures a scoped subset of all generated output.
38  * <p>
39  * <b>Example Usage:</b><pre>
40  * &lt;captureoutput&gt;
41  * &lt;...<i>Some Tasks Here</i>&gt;
42  * &lt;copylogged from="stdio" important="no" tofile="..."/&gt;
43  * &lt;...<i>More Tasks Here</i>&gt;
44  * &lt;<b>clearlogged</b>/&gt;
45  * &lt;...<i>More Tasks Here</i>&gt;
46  * &lt;copylogged from="stdio" toproperty="..."/&gt;
47  * &lt;/captureoutput&gt;
48  * </pre>
49  *
50  * @since JWare/AntX 0.3
51  * @author ssmc, &copy;2003-2005 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
52  * @version 0.5
53  * @.safety guarded
54  * @.group api,helper
55  * @see CaptureLogsTask
56  * @see CaptureStreamsTask
57  **/

58
59 public final class ClearLoggedTask extends LogsUsingTask
60 {
61     /**
62      * Initializes a new ClearLoggedTask instance.
63      **/

64     public ClearLoggedTask()
65     {
66         this(AntX.capture+"ClearLoggedTask:");
67     }
68
69
70     /**
71      * Initializes a CV-labeled ClearLoggedTask instance.
72      * @param iam CV-label (non-null)
73      **/

74     public ClearLoggedTask(String JavaDoc iam)
75     {
76         super(iam);
77         setReset(true);
78         setImportant(false);
79     }
80
81
82     /**
83      * Clears the current thread's nearest logs recorder (if one
84      * is installed). Does nothing if there is no recorder.
85      **/

86     public void execute()
87     {
88         LogsRecorder r = getRecorder(true);
89         if (r!=null) {
90             r.clearLogs();
91         }
92     }
93 }
94
95 /* end-of-ClearLoggedTask.java */
96
Popular Tags