KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > idaremedia > antx > apis > Reconfigurable


1 /**
2  * $Id: Reconfigurable.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.apis;
30
31 import org.apache.tools.ant.BuildException;
32
33 /**
34  * Marker interface for any Ant component that can be reset (and re-run). For instance,
35  * inline calls to the same tasks with different environment overlays require a task
36  * to support being reconfigured (with new overlay).
37  *
38  * @since JWare/AntX 0.4
39  * @author ssmc, &copy;2004 <a HREF="http://www.jware.info">iDare&nbsp;Media,&nbsp;Inc.</a>
40  * @version 0.5
41  * @.safety n/a
42  * @.group impl,infra
43  **/
44
45 public interface Reconfigurable
46 {
47     /**
48      * Tells this component to do whatever is necessary as
49      * a preparation to be (re)configured.
50      *
51      * @throws BuildException if unable to reset self.
52      * @since JWare/AntX 0.5
53      **/
54     void unconfigure()
55         throws BuildException;
56 }
57
58 /* end-of-OverlayEnabled.java */
Popular Tags