1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
/*
* @(#)AutoDocIT.java
*
* Copyright (C) 2002-2003 Matt Albrecht
* groboclown@users.sourceforge.net
* http://groboutils.sourceforge.net
*
* Part of the GroboUtils package at:
* http://groboutils.sourceforge.net
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
package net.sourceforge.groboutils.autodoc.v1;
/**
* Issue Tracker entry point. Allows bugs and requriements to be tracked
* directly to the test that ensures that part of the bug/requirement has been
* fulfilled in the current code base.
* <P>
* The alternate forms of the base {@link #testsIssue( String, String )} are
* for convenience only.
*
* @author Matt Albrecht <a href="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
* @version $Date: 2003/02/10 22:52:11 $
* @since March 16, 2002
*/
public interface AutoDocIT
{
/**
* Traces an issue from the owning class and declared method, to the
* given ID. This is a <tt>long</tt>, as some systems may allow for
* more than 2 billion issues.
*
* @param methodName the owning class's method to trace the issue back to.
* @param issueID the id of the issue being tracked.
*/
public void testsIssue( String methodName, long issueID );
/**
* Traces an issue from the owning class and declared method, to the
* given ID.
*
* @param methodName the owning class's method to trace the issue back to.
* @param issueID the id of the issue being tracked.
*/
public void testsIssue( String methodName, String issueID );
/**
* Traces an issue from the owning class to the given ID.
* The method will still be given to the underlying tracker, but it will
* be discovered through the stack trace. Hence, this is a volitile
* method for tracking; it should only be called from the owning class
* which is actually testing the bug.
*
* @param issueID the id of the issue being tracked.
*/
public void testsIssue( long issueID );
/**
* Traces an issue from the owning class to the given ID.
* The method will still be given to the underlying tracker, but it will
* be discovered through the stack trace. Hence, this is a volitile
* method for tracking; it should only be called from the owning class
* which is actually testing the bug.
*
* @param issueID the id of the issue being tracked.
*/
public void testsIssue( String issueID );
}
|
