org.apache.maven.surefire.report

Class AbstractTextReporter

java.lang.Object

org.apache.maven.surefire.report.AbstractReporter

org.apache.maven.surefire.report.AbstractTextReporter

All Implemented Interfaces:

Reporter, ReportWriter

Direct Known Subclasses:

AbstractConsoleReporter, AbstractFileReporter

public abstract class AbstractTextReporter
extends AbstractReporter

Text based reporter.

Author:

Brett Porter

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	BRIEF
protected static java.lang.String	PLAIN
protected static java.lang.String	SUMMARY
protected java.io.PrintWriter	writer

Fields inherited from class org.apache.maven.surefire.report.AbstractReporter

completedCount, errors, failures, NL, skipped, testSetStartTime

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTextReporter(java.io.PrintWriter writer, java.lang.String format, ReporterConfiguration reporterConfiguration)
protected	AbstractTextReporter(ReporterConfiguration reporterConfiguration, java.lang.String format)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getElapsedTimeSummary(ReportEntry report)
protected java.lang.String	getOutput(ReportEntry report, java.lang.String msg)
protected java.lang.String	getTestSetSummary(ReportEntry report)
static boolean	isTestSetCompletedMessage(java.lang.String message) Check if the String passed as argument is a "test set completed" message.
void	reset() Restores the instance of the reporter, making the instance re-usable for a subsequent run in the same thread.
void	setWriter(java.io.PrintWriter writer)
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	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	testSucceeded(ReportEntry report) Event fired when a test ended successfully
void	writeDetailMessage(java.lang.String message) Writes a detailed message that will not necessarily be displayed in all channels.
void	writeMessage(java.lang.String message) Writes a message that will be displayed in all free-text format reporters.

Methods inherited from class org.apache.maven.surefire.report.AbstractReporter

deleteIfExisting, elapsedTimeAsString, getActualRunTime, getNumErrors, getNumFailures, getNumSkipped, getNumTests, getStackTrace, isTimedOut, runCompleted, runStarting, testAssumptionFailure, testError, testFailed, testStarting, writeFooter

Methods inherited from class java.lang.Object

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

Field Detail

BRIEF

protected static final java.lang.String BRIEF

See Also:

Constant Field Values

PLAIN

protected static final java.lang.String PLAIN

See Also:

Constant Field Values

SUMMARY

protected static final java.lang.String SUMMARY

See Also:

Constant Field Values

writer

protected java.io.PrintWriter writer

Constructor Detail

AbstractTextReporter

protected AbstractTextReporter(ReporterConfiguration reporterConfiguration,
                               java.lang.String format)

AbstractTextReporter

protected AbstractTextReporter(java.io.PrintWriter writer,
                               java.lang.String format,
                               ReporterConfiguration reporterConfiguration)

Method Detail

setWriter

public void setWriter(java.io.PrintWriter writer)

writeMessage

public void writeMessage(java.lang.String message)

Description copied from interface: Reporter

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

public void writeDetailMessage(java.lang.String message)

Description copied from interface: Reporter

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

testSucceeded

public void testSucceeded(ReportEntry report)

Description copied from interface: Reporter

Event fired when a test ended successfully

Specified by:

testSucceeded in interface Reporter

Specified by:

testSucceeded in interface ReportWriter

Overrides:

testSucceeded in class AbstractReporter

Parameters:

report - The report entry to log for

testSkipped

public void testSkipped(ReportEntry report)

Specified by:

testSkipped in interface Reporter

Specified by:

testSkipped in interface ReportWriter

Overrides:

testSkipped in class AbstractReporter

testError

public void testError(ReportEntry report,
                      java.lang.String stdOut,
                      java.lang.String stdErr)

Description copied from interface: Reporter

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

Specified by:

testError in interface Reporter

Specified by:

testError in interface ReportWriter

Overrides:

testError in class AbstractReporter

Parameters:

report - The report entry to log for

stdOut - standard output from the test case

stdErr - error output from the test case

testFailed

public void testFailed(ReportEntry report,
                       java.lang.String stdOut,
                       java.lang.String stdErr)

Description copied from interface: Reporter

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

Specified by:

testFailed in interface Reporter

Specified by:

testFailed in interface ReportWriter

Overrides:

testFailed in class AbstractReporter

Parameters:

report - The report entry to log for

stdOut - standard output from the test case

stdErr - error output from the test case

testSetStarting

public void testSetStarting(ReportEntry report)
                     throws ReporterException

Description copied from interface: Reporter

Indicates the start of a given test-set

Specified by:

testSetStarting in interface Reporter

Specified by:

testSetStarting in interface ReportWriter

Overrides:

testSetStarting in class AbstractReporter

Parameters:

report - the report entry describing the testset

Throws:

ReporterException - When reporting fails

testSetCompleted

public void testSetCompleted(ReportEntry report)
                      throws ReporterException

Description copied from interface: Reporter

Indicates end of a given test-set

Specified by:

testSetCompleted in interface Reporter

Specified by:

testSetCompleted in interface ReportWriter

Overrides:

testSetCompleted in class AbstractReporter

Parameters:

report - the report entry describing the testset

Throws:

ReporterException - When reporting fails

getTestSetSummary

protected java.lang.String getTestSetSummary(ReportEntry report)

getElapsedTimeSummary

protected java.lang.String getElapsedTimeSummary(ReportEntry report)

getOutput

protected java.lang.String getOutput(ReportEntry report,
                                     java.lang.String msg)

isTestSetCompletedMessage

public static boolean isTestSetCompletedMessage(java.lang.String message)

Check if the String passed as argument is a "test set completed" message.

Parameters:

message - the message to check

Returns:

true if it is a "test set completed" message

reset

public void reset()

Description copied from interface: Reporter

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

Specified by:

reset in interface Reporter

Specified by:

reset in interface ReportWriter

Overrides:

reset in class AbstractReporter