KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sourceforge > groboutils > autodoc > v1 > spi > AutoDocFactory


1 /*
2  * @(#)AutoDocFactory.java
3  *
4  * Copyright (C) 2002-2003 Matt Albrecht
5  * groboclown@users.sourceforge.net
6  * http://groboutils.sourceforge.net
7  *
8  * Part of the GroboUtils package at:
9  * http://groboutils.sourceforge.net
10  *
11  * Permission is hereby granted, free of charge, to any person obtaining a
12  * copy of this software and associated documentation files (the "Software"),
13  * to deal in the Software without restriction, including without limitation
14  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
15  * and/or sell copies of the Software, and to permit persons to whom the
16  * Software is furnished to do so, subject to the following conditions:
17  *
18  * The above copyright notice and this permission notice shall be included in
19  * all copies or substantial portions of the Software.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
24  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
26  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27  * DEALINGS IN THE SOFTWARE.
28  */
29 package net.sourceforge.groboutils.autodoc.v1.spi;
30
31
32 import net.sourceforge.groboutils.autodoc.v1.AutoDocIT;
33 import net.sourceforge.groboutils.autodoc.v1.AutoDocLog;
34 import net.sourceforge.groboutils.autodoc.v1.AutoDocTP;
35
36  
37
38 /**
39  * An interface which defines the kinds of classes which should be loaded
40  * for the <tt>AutoDoc</tt> entry point.
41  *
42  * @author Matt Albrecht <a HREF="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
43  * @version $Date: 2003/02/10 22:52:12 $
44  * @since March 16, 2002
45  */
46 public interface AutoDocFactory
47 {
48     /**
49      * Creates a new Log for the class owner.
50      *
51      * @param owner the Class owner, as passed to the <tt>AutoDoc</tt> class.
52      * @return a new logger for <tt>owner</tt>.
53      */
54     public AutoDocLog createLog( Class JavaDoc owner );
55     
56     
57     /**
58      * Creates the Issue Tracker entry point.
59      *
60      * @param owner the Class owner, as passed to the <tt>AutoDoc</tt> class.
61      * @return a new issue tracker for <tt>owner</tt>.
62      */
63     public AutoDocIT createIT( Class JavaDoc owner );
64     
65     
66     /**
67      * Creates a Test Procedure entry point.
68      *
69      * @param owner the Class owner, as passed to the <tt>AutoDoc</tt> class.
70      * @return a new test procedure generator for <tt>owner</tt>.
71      */
72     public AutoDocTP createTP( Class JavaDoc owner );
73 }
74
75
Popular Tags