KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > idaremedia > antx > KillMethod


1 /**
2  * $Id: KillMethod.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;
30
31 import com.idaremedia.antx.apis.ProblemHandler;
32
33 /**
34  * Fixture administrator cleanup callback. Kill methods are installed by every
35  * fixture administrator to help execution harnesses reset the runtime environment before
36  * (re)launching a new iteration. This is their only purpose.
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,helper
43  * @see AntXFixture#setKillMethod AntXFixture.setKillMethod(&#8230;)
44  **/
45
46 public interface KillMethod
47 {
48     /**
49      * Do whatever is necessary to "kill" fixture component so that
50      * an execution harness can run a new iteration.
51      * @param from controlling task or test (non-null)
52      * @return <i>true</i> if fixture cleanup was successful
53      **/
54     boolean kill(ProblemHandler from);
55
56
57     /**
58      * Do whatever is necessary to "kill" a particular aspect of
59      * a fixture component so that an execution harness can run
60      * a new iteration.
61      * @param aspect symbolic name of aspect to be killed
62      * @param from controlling task or test (non-null)
63      * @return <i>true</i> if fixture cleanup was successful
64      **/
65     boolean kill(String JavaDoc aspect, ProblemHandler from);
66 }
67
68 /* end-of-KillMethod.java */
69
Popular Tags