KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > idaremedia > antx > flowcontrol > wrap > ExecutionBubble


1 /**
2  * $Id: ExecutionBubble.java 180 2007-03-15 12:56:38Z ssmc $
3  * Copyright 2004 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.flowcontrol.wrap;
30
31 import com.idaremedia.antx.FixtureOverlay;
32 import com.idaremedia.antx.apis.ProjectDependent;
33 import com.idaremedia.antx.apis.Requester;
34
35 /**
36  * Task execution helper that tries to restore a task's surrounding Ant
37  * <span class="src">Project</span> build-iteration context to the state it reflected
38  * just before task executed.
39  *
40  * @since JWare/AntX 0.4
41  * @author ssmc, &copy;2004 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
42  * @version 0.5
43  * @.safety n/a
44  * @.group impl,infra
45  **/
46
47 public interface ExecutionBubble extends ProjectDependent, FixtureOverlay
48 {
49     /**
50      * Captures project state for later restoration. Must be
51      * matched with a call to {@linkplain #leave leave}.
52      * @param block the client to be executed (non-null)
53      **/
54     boolean enter(Requester block);
55
56
57
58     /**
59      * Restores project state as best can to state before task
60      * executed. Will affect project properties and references mostly.
61      * Should be done <em>once</em> for each call to
62      * {@linkplain #enter enter}.
63      * @param block the client that was executed (non-null)
64      **/
65     boolean leave(Requester block);
66 }
67
68 /* end-of-ExecutionBubble.java */
69
Popular Tags