net.sourceforge.groboutils.autodoc.v1.defimpl
Class AutoDocITSet

java.lang.Object
  net.sourceforge.groboutils.autodoc.v1.defimpl.AutoDocITSet

All Implemented Interfaces:

AutoDocIT, IAutoDocSet

public class AutoDocITSet

extends java.lang.Object

implements AutoDocIT, IAutoDocSet

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:

June 28, 2002

Version:

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

Author:

Matt Albrecht groboclown@users.sourceforge.net

Constructor Summary

AutoDocITSet()

Method Summary

void	addIT(AutoDocIT it)
java.util.Enumeration	getSetContents() Returns the elements in the set.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AutoDocITSet

public AutoDocITSet()

Method Detail

addIT

public void addIT(AutoDocIT it)

getSetContents

public java.util.Enumeration getSetContents()

Description copied from interface: IAutoDocSet

Returns the elements in the set.

Specified by:

getSetContents in interface IAutoDocSet

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.

Specified by:

testsIssue in interface AutoDocIT

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.

Specified by:

testsIssue in interface AutoDocIT

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.

Specified by:

testsIssue in interface AutoDocIT

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.

Specified by:

testsIssue in interface AutoDocIT

Parameters:

issueID - the id of the issue being tracked.