01: /*
02: * @(#)ICxFactory.java
03: *
04: * Copyright (C) 2002-2003 Matt Albrecht
05: * groboclown@users.sourceforge.net
06: * http://groboutils.sourceforge.net
07: *
08: * Permission is hereby granted, free of charge, to any person obtaining a
09: * copy of this software and associated documentation files (the "Software"),
10: * to deal in the Software without restriction, including without limitation
11: * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12: * and/or sell copies of the Software, and to permit persons to whom the
13: * Software is furnished to do so, subject to the following conditions:
14: *
15: * The above copyright notice and this permission notice shall be included in
16: * all copies or substantial portions of the Software.
17: *
18: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19: * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20: * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21: * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22: * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23: * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24: * DEALINGS IN THE SOFTWARE.
25: */
26:
27: package net.sourceforge.groboutils.junit.v1.iftc;
28:
29: /**
30: * An ICxFactory is an extension of ImplFactory that has provisions for
31: * cleaning up generated objects on test tear down. Generated objects could
32: * either have a finalize() method (not recommended, especially for tests),
33: * or the factory could implement this interface to allow proper, timely
34: * clean-up.
35: * <P>
36: * The clean-up is performed by <tt>InterfaceTestCase</tt> in the
37: * <tt>tearDown()</tt> method. If the hierarchy tests do not use this,
38: * but instead use a variation of <tt>junit.framework.Test</tt>, then
39: * they will need to implement their own tearDown() functionality.
40: * <P>
41: * A valid alternative is to use Mock-Objects
42: * (<a href="http://www.mockobjects.org">www.mockobjects.org</a>), which would
43: * not need to be cleaned up like "live" objects do.
44: *
45: * @author Matt Albrecht <a href="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
46: * @version $Date: 2003/02/10 22:52:20 $
47: * @since October 30, 2002
48: */
49: public interface ICxFactory extends ImplFactory {
50: /**
51: * Allows the implementation to clean-up the instantiated object.
52: * <tt>implObject</tt> is guaranteed to have been generated by this exact
53: * factory. Each object generated by this specific factory will be passed
54: * to this method on the test's <tt>tearDown()</tt> method, in the
55: * reverse order that they were created.
56: *
57: * @param implObject one of the objects created by this factory.
58: * @exception Exception can be thrown when the deconstruction fails.
59: * This will not disrupt the remaining objects' tear down
60: * call.
61: */
62: public void tearDown(Object implObject) throws Exception;
63: }
|