KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sourceforge > groboutils > autodoc > v1 > AutoDocIT


1 /*
2  * @(#)AutoDocIT.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;
30
31
32  
33
34 /**
35  * Issue Tracker entry point. Allows bugs and requriements to be tracked
36  * directly to the test that ensures that part of the bug/requirement has been
37  * fulfilled in the current code base.
38  * <P>
39  * The alternate forms of the base {@link #testsIssue( String, String )} are
40  * for convenience only.
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:11 $
44  * @since March 16, 2002
45  */
46 public interface AutoDocIT
47 {
48     /**
49      * Traces an issue from the owning class and declared method, to the
50      * given ID. This is a <tt>long</tt>, as some systems may allow for
51      * more than 2 billion issues.
52      *
53      * @param methodName the owning class's method to trace the issue back to.
54      * @param issueID the id of the issue being tracked.
55      */
56     public void testsIssue( String JavaDoc methodName, long issueID );
57     
58     
59     /**
60      * Traces an issue from the owning class and declared method, to the
61      * given ID.
62      *
63      * @param methodName the owning class's method to trace the issue back to.
64      * @param issueID the id of the issue being tracked.
65      */
66     public void testsIssue( String JavaDoc methodName, String JavaDoc issueID );
67     
68     
69     /**
70      * Traces an issue from the owning class to the given ID.
71      * The method will still be given to the underlying tracker, but it will
72      * be discovered through the stack trace. Hence, this is a volitile
73      * method for tracking; it should only be called from the owning class
74      * which is actually testing the bug.
75      *
76      * @param issueID the id of the issue being tracked.
77      */
78     public void testsIssue( long issueID );
79     
80     
81     /**
82      * Traces an issue from the owning class to the given ID.
83      * The method will still be given to the underlying tracker, but it will
84      * be discovered through the stack trace. Hence, this is a volitile
85      * method for tracking; it should only be called from the owning class
86      * which is actually testing the bug.
87      *
88      * @param issueID the id of the issue being tracked.
89      */
90     public void testsIssue( String JavaDoc issueID );
91 }
92
93
Popular Tags