net.sourceforge.groboutils.pmti.v1.autodoc.v1
Class AutoDocITImpl

java.lang.Object
  extended bynet.sourceforge.groboutils.autodoc.v1.testserver.TestCorrelate
      extended bynet.sourceforge.groboutils.pmti.v1.autodoc.v1.AutoDocITImpl
All Implemented Interfaces:
AutoDocIT

public class AutoDocITImpl
extends TestCorrelate
implements 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 30, 2002
Version:
$Date: 2003/02/10 22:51:56 $
Author:
Matt Albrecht groboclown@users.sourceforge.net

Constructor Summary
AutoDocITImpl(java.lang.Class owner)
          Default constructor, which requires an owning class.
AutoDocITImpl(java.lang.Class owner, MonitorFinder finder)
          Creates a new implementation of AutoDocIT, with the given owner and monitor finder.
 
Method Summary
protected  void sendTestIssue(TestInfo ti, java.lang.String issueID)
          Send the 'testsIssue' call to the monitor.
 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 net.sourceforge.groboutils.autodoc.v1.testserver.TestCorrelate
createTestInfo, createTestInfoFromStack, findClassMethodFromStack, getFinder, getOwner, getOwnerName, getTestData
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AutoDocITImpl

public AutoDocITImpl(java.lang.Class owner)
Default constructor, which requires an owning class. The monitor finder will be the default ITFMonitorFinder.


AutoDocITImpl

public AutoDocITImpl(java.lang.Class owner,
                     MonitorFinder finder)
Creates a new implementation of AutoDocIT, with the given owner and monitor finder.

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.

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.

sendTestIssue

protected void sendTestIssue(TestInfo ti,
                             java.lang.String issueID)
Send the 'testsIssue' call to the monitor.



Copyright © 2001-2003 by The GroboUtils Project