org.apache.maven.surefire.report
Interface Reporter

All Known Implementing Classes:
AbstractConsoleReporter, AbstractFileReporter, AbstractReporter, AbstractTextReporter, BriefConsoleReporter, BriefFileReporter, ClassesParallelRunListener, ConcurrentReporterManager, ConsoleReporter, DetailedConsoleReporter, FileReporter, ForkingConsoleReporter, MethodsParallelRunListener, MulticastingReporter, ReporterManager, XMLReporter

public interface Reporter

Used by providers to report results. Using this interface integrates the providers together into a common reporting infrastructure.

An instance of a reporter is not guaranteed to be thread-safe and concurrent test frameworks must request an instance of a reporter per-thread from the ReporterFactory.


Method Summary
 void reset()
          Deprecated. remove when building with 2.7.2
 void testAssumptionFailure(ReportEntry report)
          Event fired when a test assumption failure was encountered.
 void testError(ReportEntry report)
          Event fired when a test ended with an error (non anticipated problem)
 void testError(ReportEntry report, java.lang.String stdOut, java.lang.String stdErr)
          Deprecated. remove when building with 2.7.2
 void testFailed(ReportEntry report)
          Event fired when a test ended with a failure (anticipated problem)
 void testFailed(ReportEntry report, java.lang.String stdOut, java.lang.String stdErr)
          Deprecated. remove when building with 2.7.2
 void testSetCompleted(ReportEntry report)
          Indicates end of a given test-set
 void testSetStarting(ReportEntry report)
          Indicates the start of a given test-set
 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 writeDetailMessage(java.lang.String message)
          Deprecated. remove when building with 2.7.2
 void writeFooter(java.lang.String footer)
          Deprecated. remove when building with 2.7.2
 void writeMessage(java.lang.String message)
          Deprecated. remove when building with 2.7.2
 

Method Detail

testSetStarting

void testSetStarting(ReportEntry report)
                     throws ReporterException
Indicates the start of a given test-set

Parameters:
report - the report entry describing the testset
Throws:
ReporterException - When reporting fails

testSetCompleted

void testSetCompleted(ReportEntry report)
                      throws ReporterException
Indicates end of a given test-set

Parameters:
report - the report entry describing the testset
Throws:
ReporterException - When reporting fails

testStarting

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

Parameters:
report - The report entry to log for

testSucceeded

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

Parameters:
report - The report entry to log for

testAssumptionFailure

void testAssumptionFailure(ReportEntry report)
Event fired when a test assumption failure was encountered. An assumption failure indicates that the test is not relevant

Parameters:
report - The report entry to log for

testError

void testError(ReportEntry report)
Event fired when a test ended with an error (non anticipated problem)

Parameters:
report - The report entry to log for

testFailed

void testFailed(ReportEntry report)
Event fired when a test ended with a failure (anticipated problem)

Parameters:
report - The report entry to log for

testSkipped

void testSkipped(ReportEntry report)

testError

void testError(ReportEntry report,
               java.lang.String stdOut,
               java.lang.String stdErr)
Deprecated. remove when building with 2.7.2

Event fired when a test ended with an error (non anticipated problem)

Parameters:
report - The report entry to log for
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)
Deprecated. remove when building with 2.7.2

Event fired when a test ended with a failure (anticipated problem)

Parameters:
report - The report entry to log for
stdOut - standard output from the test case
stdErr - error output from the test case

writeMessage

void writeMessage(java.lang.String message)
Deprecated. remove when building with 2.7.2

Writes a message that will be displayed in all free-text format reporters. These messages will be output regardless, as opposed to #writeDetailMessage, which is controlled by reportFormat.

Parameters:
message - The message to write.

writeDetailMessage

void writeDetailMessage(java.lang.String message)
Deprecated. remove when building with 2.7.2

Writes a detailed message that will not necessarily be displayed in all channels. This is controlled by reportFormat attribute on the plugin.

Parameters:
message - The message to write

reset

void reset()
Deprecated. remove when building with 2.7.2

Restores the instance of the reporter, making the instance re-usable for a subsequent run in the same thread.


writeFooter

void writeFooter(java.lang.String footer)
Deprecated. remove when building with 2.7.2



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