org.apache.maven.surefire.report
Interface Reporter

All Known Implementing Classes:
AbstractConsoleReporter, AbstractFileReporter, AbstractReporter, AbstractTextReporter, BriefConsoleReporter, BriefFileReporter, ConsoleReporter, DetailedConsoleReporter, FileReporter, ForkingConsoleReporter, XMLReporter

public interface Reporter

Contract between the different implementations of the Surefire reporters

Version:
$Id: Reporter.java 510866 2007-02-23 08:13:49Z brett $

Method Summary
 java.util.Collection getErrorSources()
          Gives the source(s) that causes the error(s).
 java.util.Collection getFailureSources()
          Gives the source(s) that causes the failures(s).
 int getNumErrors()
          Get the number of errors
 int getNumFailures()
          Get the number of failures
 int getNumSkipped()
          Get the number of tests skipped
 int getNumTests()
          Get the number of tests
 void reset()
           
 void runAborted(ReportEntry report)
           
 void runCompleted()
           
 void runStarting(int testCount)
           
 void runStopped()
           
 void testError(ReportEntry report, java.lang.String stdOut, java.lang.String stdErr)
          Event fired when a test ended with an error (non anticipated problem)
 void testFailed(ReportEntry report, java.lang.String stdOut, java.lang.String stdErr)
          Event fired when a test ended with a failure (anticipated problem)
 void testSetAborted(ReportEntry report)
           
 void testSetCompleted(ReportEntry report)
           
 void testSetStarting(ReportEntry report)
           
 void testSkipped(ReportEntry report)
           
 void testStarting(ReportEntry report)
          Event fired when a test is about to start
 void testSucceeded(ReportEntry report)
          Event fired when a test ended successfully
 void writeFooter(java.lang.String footer)
           
 void writeMessage(java.lang.String message)
           
 

Method Detail

writeMessage

void writeMessage(java.lang.String message)

writeFooter

void writeFooter(java.lang.String footer)

runStarting

void runStarting(int testCount)

runCompleted

void runCompleted()

runStopped

void runStopped()

runAborted

void runAborted(ReportEntry report)

testSetStarting

void testSetStarting(ReportEntry report)
                     throws ReporterException
Throws:
ReporterException

testSetCompleted

void testSetCompleted(ReportEntry report)
                      throws ReporterException
Throws:
ReporterException

testSetAborted

void testSetAborted(ReportEntry report)

testStarting

void testStarting(ReportEntry report)
Event fired when a test is about to start

Parameters:
report -

testSucceeded

void testSucceeded(ReportEntry report)
Event fired when a test ended successfully

Parameters:
report -

testError

void testError(ReportEntry report,
               java.lang.String stdOut,
               java.lang.String stdErr)
Event fired when a test ended with an error (non anticipated problem)

Parameters:
report -
stdOut - standard output from the test case
stdErr - error output from the test case

testFailed

void testFailed(ReportEntry report,
                java.lang.String stdOut,
                java.lang.String stdErr)
Event fired when a test ended with a failure (anticipated problem)

Parameters:
report -
stdOut - standard output from the test case
stdErr - error output from the test case

testSkipped

void testSkipped(ReportEntry report)

reset

void reset()

getNumErrors

int getNumErrors()
Get the number of errors

Returns:

getNumFailures

int getNumFailures()
Get the number of failures

Returns:

getNumTests

int getNumTests()
Get the number of tests

Returns:

getNumSkipped

int getNumSkipped()
Get the number of tests skipped

Returns:

getErrorSources

java.util.Collection getErrorSources()
Gives the source(s) that causes the error(s).

Returns:
The source(s).

getFailureSources

java.util.Collection getFailureSources()
Gives the source(s) that causes the failures(s).

Returns:
The source(s).


Copyright © 2004-2008 Apache Software Foundation. All Rights Reserved.