svn commit: r397256 - /maven/surefire/branches/surefire-testng/surefire-api/src/main/java/org/apache/maven/surefire/report/Reporter.java

[carlos]

Author: carlos
Date: Wed Apr 26 10:58:59 2006
New Revision: 397256

URL: http://svn.apache.org/viewcvs?rev=397256&view=rev
Log:
Add javadocs

Modified:
    
maven/surefire/branches/surefire-testng/surefire-api/src/main/java/org/apache/maven/surefire/report/Reporter.java

Modified: 
maven/surefire/branches/surefire-testng/surefire-api/src/main/java/org/apache/maven/surefire/report/Reporter.java
URL: 
http://svn.apache.org/viewcvs/maven/surefire/branches/surefire-testng/surefire-api/src/main/java/org/apache/maven/surefire/report/Reporter.java?rev=397256&r1=397255&r2=397256&view=diff
==============================================================================
--- 
maven/surefire/branches/surefire-testng/surefire-api/src/main/java/org/apache/maven/surefire/report/Reporter.java
 (original)
+++ 
maven/surefire/branches/surefire-testng/surefire-api/src/main/java/org/apache/maven/surefire/report/Reporter.java
 Wed Apr 26 10:58:59 2006
@@ -16,6 +16,11 @@
  * limitations under the License.
  */
 
+/**
+ * Contract between the different implementations of the Surefire reporters
+ *  
+ * @version $Id$
+ */
 public interface Reporter
 {
     void writeMessage( String message );
@@ -40,12 +45,37 @@
     void testSetAborted( ReportEntry report );
 
     // Tests
+
+    /**
+     * Event fired when a test is about to start 
+     * 
+     * @param report
+     */
     void testStarting( ReportEntry report );
 
+    /**
+     * Event fired when a test ended successfully
+     * 
+     * @param report
+     */
     void testSucceeded( ReportEntry report );
 
+    /**
+     * Event fired when a test ended with an error (non anticipated problem)
+     * 
+     * @param report
+     * @param stdOut standard output from the test case 
+     * @param stdErr error output from the test case
+     */
     void testError( ReportEntry report, String stdOut, String stdErr );
 
+    /**
+     * Event fired when a test ended with a failure (anticipated problem)
+     * 
+     * @param report
+     * @param stdOut standard output from the test case 
+     * @param stdErr error output from the test case
+     */
     void testFailed( ReportEntry report, String stdOut, String stdErr );
 
     void testSkipped( ReportEntry report );
@@ -53,11 +83,31 @@
     // Counters
     void reset();
 
+    /**
+     * Get the number of errors
+     * 
+     * @return
+     */
     int getNumErrors();
 
+    /**
+     * Get the number of failures
+     * 
+     * @return
+     */
     int getNumFailures();
 
+    /**
+     * Get the number of tests
+     * 
+     * @return
+     */
     int getNumTests();
 
+    /**
+     * Get the number of tests skipped
+     * 
+     * @return
+     */
     int getNumSkipped();
 }