01: /*
02: * @(#)AutoDocIT.java
03: *
04: * Copyright (C) 2002-2003 Matt Albrecht
05: * groboclown@users.sourceforge.net
06: * http://groboutils.sourceforge.net
07: *
08: * Part of the GroboUtils package at:
09: * 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: * Issue Tracker entry point. Allows bugs and requriements to be tracked
33: * directly to the test that ensures that part of the bug/requirement has been
34: * fulfilled in the current code base.
35: * <P>
36: * The alternate forms of the base {@link #testsIssue( String, String )} are
37: * for convenience only.
38: *
39: * @author Matt Albrecht <a href="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
40: * @version $Date: 2003/02/10 22:52:11 $
41: * @since March 16, 2002
42: */
43: public interface AutoDocIT {
44: /**
45: * Traces an issue from the owning class and declared method, to the
46: * given ID. This is a <tt>long</tt>, as some systems may allow for
47: * more than 2 billion issues.
48: *
49: * @param methodName the owning class's method to trace the issue back to.
50: * @param issueID the id of the issue being tracked.
51: */
52: public void testsIssue(String methodName, long issueID);
53:
54: /**
55: * Traces an issue from the owning class and declared method, to the
56: * given ID.
57: *
58: * @param methodName the owning class's method to trace the issue back to.
59: * @param issueID the id of the issue being tracked.
60: */
61: public void testsIssue(String methodName, String issueID);
62:
63: /**
64: * Traces an issue from the owning class to the given ID.
65: * The method will still be given to the underlying tracker, but it will
66: * be discovered through the stack trace. Hence, this is a volitile
67: * method for tracking; it should only be called from the owning class
68: * which is actually testing the bug.
69: *
70: * @param issueID the id of the issue being tracked.
71: */
72: public void testsIssue(long issueID);
73:
74: /**
75: * Traces an issue from the owning class to the given ID.
76: * The method will still be given to the underlying tracker, but it will
77: * be discovered through the stack trace. Hence, this is a volitile
78: * method for tracking; it should only be called from the owning class
79: * which is actually testing the bug.
80: *
81: * @param issueID the id of the issue being tracked.
82: */
83: public void testsIssue(String issueID);
84: }
|