net.sourceforge.groboutils.autodoc.v1
Interface AutoDocIT

All Known Implementing Classes:

AutoDocITImpl, AutoDocITSet

public interface AutoDocIT

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.

The alternate forms of the base testsIssue( String, String ) are for convenience only.

Since:

March 16, 2002

Version:

$Date: 2003/02/10 22:52:11 $

Author:

Matt Albrecht groboclown@users.sourceforge.net

Method Summary

void	testsIssue(long issueID) Traces an issue from the owning class to the given ID.
void	testsIssue(java.lang.String issueID) Traces an issue from the owning class to the given ID.
void	testsIssue(java.lang.String methodName, long issueID) Traces an issue from the owning class and declared method, to the given ID.
void	testsIssue(java.lang.String methodName, java.lang.String issueID) Traces an issue from the owning class and declared method, to the given ID.

Method Detail

testsIssue

public void testsIssue(java.lang.String methodName,
                       long issueID)

Traces an issue from the owning class and declared method, to the given ID. This is a long, as some systems may allow for more than 2 billion issues.

Parameters:

methodName - the owning class's method to trace the issue back to.

issueID - the id of the issue being tracked.

testsIssue

public void testsIssue(java.lang.String methodName,
                       java.lang.String issueID)

Traces an issue from the owning class and declared method, to the given ID.

Parameters:

methodName - the owning class's method to trace the issue back to.

issueID - the id of the issue being tracked.

testsIssue

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.

Parameters:

issueID - the id of the issue being tracked.

testsIssue

public void testsIssue(java.lang.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.

Parameters:

issueID - the id of the issue being tracked.