Package org.apache.maven.surefire.api.report

Class SimpleReportEntry

java.lang.Object

org.apache.maven.surefire.api.report.SimpleReportEntry

All Implemented Interfaces:

ReportEntry, TestSetReportEntry

Direct Known Subclasses:

CategorizedReportEntry

public class SimpleReportEntry
extends Object
implements TestSetReportEntry

Basic implementation of TestSetReportEntry (immutable and thread-safe object).

Author:

Kristian Rosenvold

Constructor Summary

Constructors

Constructor	Description
SimpleReportEntry(RunMode runMode, Long testRunId, String source, String sourceText, String name, String nameText)
SimpleReportEntry(RunMode runMode, Long testRunId, String source, String sourceText, String name, String nameText, Integer elapsed)
SimpleReportEntry(RunMode runMode, Long testRunId, String source, String sourceText, String name, String nameText, String message)
SimpleReportEntry(RunMode runMode, Long testRunId, String source, String sourceText, String name, String nameText, Map<String,String> systemProperties)
SimpleReportEntry(RunMode runMode, Long testRunId, String source, String sourceText, String name, String nameText, StackTraceWriter stackTraceWriter, Integer elapsed)
SimpleReportEntry(RunMode runMode, Long testRunId, String source, String sourceText, String name, String nameText, StackTraceWriter stackTraceWriter, Integer elapsed, String message, Map<String,String> systemProperties)
SimpleReportEntry(RunMode runMode, Long testRunId, String source, String sourceText, String name, String nameText, StackTraceWriter stackTraceWriter, Integer elapsed, Map<String,String> systemProperties)

Method Summary

Modifier and Type	Method	Description
static SimpleReportEntry	assumption(RunMode runMode, Long testRunId, String source, String sourceText, String name, String nameText, String message)
boolean	equals(Object o)
Integer	getElapsed()	Gets the runtime for the item.
int	getElapsed(int fallback)	Returns same value as ReportEntry.getElapsed() and fallbacks to fallback for null elapsed timed.
String	getGroup()	The group/category of the testcase
String	getMessage()	A message relating to a non-successful termination.
String	getName()	The name of the test case
String	getNameText()	Human readable test case.
String	getNameWithGroup()	A source name of the test case together with the group or category (if any exists).
String	getReportNameWithGroup()	A source text of the test case together with the group or category (if any exists).
RunMode	getRunMode()	Run mode.
String	getSourceName()	The class name of the test
String	getSourceText()	Human readable test class.
StackTraceWriter	getStackTraceWriter()	The group/category of the testcase
Map<String,String>	getSystemProperties()
Long	getTestRunId()	This represents a reference pointing to a literal representation of test description or literal unique id.
int	hashCode()
static SimpleReportEntry	ignored(RunMode runMode, Long testRunId, String source, String sourceText, String name, String nameText, String message)
String	toString()
static SimpleReportEntry	withException(RunMode runMode, Long testRunId, String source, String sourceText, String name, String nameText, StackTraceWriter stackTraceWriter)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SimpleReportEntry

public SimpleReportEntry(@Nonnull
                         RunMode runMode,
                         Long testRunId,
                         String source,
                         String sourceText,
                         String name,
                         String nameText)

SimpleReportEntry

public SimpleReportEntry(@Nonnull
                         RunMode runMode,
                         Long testRunId,
                         String source,
                         String sourceText,
                         String name,
                         String nameText,
                         Map<String,String> systemProperties)

SimpleReportEntry

public SimpleReportEntry(@Nonnull
                         RunMode runMode,
                         Long testRunId,
                         String source,
                         String sourceText,
                         String name,
                         String nameText,
                         Integer elapsed)

SimpleReportEntry

public SimpleReportEntry(@Nonnull
                         RunMode runMode,
                         Long testRunId,
                         String source,
                         String sourceText,
                         String name,
                         String nameText,
                         String message)

SimpleReportEntry

public SimpleReportEntry(@Nonnull
                         RunMode runMode,
                         Long testRunId,
                         String source,
                         String sourceText,
                         String name,
                         String nameText,
                         StackTraceWriter stackTraceWriter,
                         Integer elapsed,
                         String message,
                         Map<String,String> systemProperties)

SimpleReportEntry

public SimpleReportEntry(@Nonnull
                         RunMode runMode,
                         Long testRunId,
                         String source,
                         String sourceText,
                         String name,
                         String nameText,
                         StackTraceWriter stackTraceWriter,
                         Integer elapsed)

SimpleReportEntry

public SimpleReportEntry(@Nonnull
                         RunMode runMode,
                         Long testRunId,
                         String source,
                         String sourceText,
                         String name,
                         String nameText,
                         StackTraceWriter stackTraceWriter,
                         Integer elapsed,
                         Map<String,String> systemProperties)

Method Detail

assumption

public static SimpleReportEntry assumption(RunMode runMode,
                                           Long testRunId,
                                           String source,
                                           String sourceText,
                                           String name,
                                           String nameText,
                                           String message)

ignored

public static SimpleReportEntry ignored(RunMode runMode,
                                        Long testRunId,
                                        String source,
                                        String sourceText,
                                        String name,
                                        String nameText,
                                        String message)

withException

public static SimpleReportEntry withException(RunMode runMode,
                                              Long testRunId,
                                              String source,
                                              String sourceText,
                                              String name,
                                              String nameText,
                                              StackTraceWriter stackTraceWriter)

getSourceName

public String getSourceName()

Description copied from interface: ReportEntry

The class name of the test

Specified by:

getSourceName in interface ReportEntry

Returns:

A string with the class name

getSourceText

public String getSourceText()

Description copied from interface: ReportEntry

Human readable test class.

Specified by:

getSourceText in interface ReportEntry

Returns:

source text

getName

public String getName()

Description copied from interface: ReportEntry

The name of the test case

Specified by:

getName in interface ReportEntry

Returns:

A string describing the test case

getNameText

public String getNameText()

Description copied from interface: ReportEntry

Human readable test case.

Specified by:

getNameText in interface ReportEntry

Returns:

name text

getGroup

public String getGroup()

Description copied from interface: ReportEntry

The group/category of the testcase

Specified by:

getGroup in interface ReportEntry

Returns:

A string

getStackTraceWriter

public StackTraceWriter getStackTraceWriter()

Description copied from interface: ReportEntry

The group/category of the testcase

Specified by:

getStackTraceWriter in interface ReportEntry

Returns:

stack trace object

getElapsed

public Integer getElapsed()

Description copied from interface: ReportEntry

Gets the runtime for the item. Optional parameter. If the value is not set, it will be determined within the reporting subsystem. Some providers like to calculate this value themselves, and it gets the most accurate value.

Specified by:

getElapsed in interface ReportEntry

Returns:

duration of a test in milli seconds

getElapsed

public int getElapsed(int fallback)

Description copied from interface: ReportEntry

Returns same value as ReportEntry.getElapsed() and fallbacks to fallback for null elapsed timed.

Specified by:

getElapsed in interface ReportEntry

Parameters:

fallback - usually 0

Returns:

elapsed time if ReportEntry.getElapsed() is not null; otherwise returns fallback

toString

public String toString()

Overrides:

toString in class Object

getMessage

public String getMessage()

Description copied from interface: ReportEntry

A message relating to a non-successful termination. May be the "message" from an exception or the reason for a test being ignored

Specified by:

getMessage in interface ReportEntry

Returns:

A string that explains an anomaly

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getNameWithGroup

public String getNameWithGroup()

Description copied from interface: ReportEntry

A source name of the test case together with the group or category (if any exists).

Specified by:

getNameWithGroup in interface ReportEntry

Returns:

A string with the test case name and group/category, or just the name.

getReportNameWithGroup

public String getReportNameWithGroup()

Description copied from interface: ReportEntry

A source text of the test case together with the group or category (if any exists).

Specified by:

getReportNameWithGroup in interface ReportEntry

Returns:

A string with the test case text and group/category, or just the source text. If no source text is provided, then this will return null.

getRunMode

@Nonnull
public final RunMode getRunMode()

Description copied from interface: ReportEntry

Run mode.

Specified by:

getRunMode in interface ReportEntry

Returns:

a normal run, or re-run.

getTestRunId

public final Long getTestRunId()

Description copied from interface: ReportEntry

This represents a reference pointing to a literal representation of test description or literal unique id.

Specified by:

getTestRunId in interface ReportEntry

Returns:

id

getSystemProperties

public Map<String,String> getSystemProperties()

Specified by:

getSystemProperties in interface TestSetReportEntry