com.aventstack.extentreports.reporter

Class ExtentHtmlReporter

java.lang.Object

com.aventstack.extentreports.reporter.AbstractReporter

com.aventstack.extentreports.reporter.BasicFileReporter

com.aventstack.extentreports.reporter.ExtentHtmlReporter

All Implemented Interfaces:

ExtentReporter, ReportAggregatesListener, ReportAppendable, TestDisplayOrderSetting, TestListener

public class ExtentHtmlReporter
extends BasicFileReporter
implements ReportAppendable

The ExtentHtmlReporter creates a rich standalone HTML file. It allows several configuration options via the config() method.

Constructor Summary

Constructors

Constructor and Description
ExtentHtmlReporter(java.io.File file)
ExtentHtmlReporter(java.lang.String filePath)

Method Summary

Modifier and Type	Method and Description
ExtentHtmlReporterConfiguration	config()
boolean	containsStatus(Status status)
void	flush()
ConfigMap	getConfigContext()
java.util.List<Test>	getTestList()
void	onScreenCaptureAdded(Log log, ScreenCapture screenCapture) Invoked each time a screenshot is added to log
void	onScreenCaptureAdded(Test test, ScreenCapture screenCapture) Invoked each time a screencapture is added to test
void	setAppendExisting(java.lang.Boolean b)
void	setTestList(java.util.List<Test> reportTestList) Allows sharing the complete list of tests with the reporter
void	start() Starts passing run information to the reporter

Methods inherited from class com.aventstack.extentreports.reporter.BasicFileReporter

onAuthorAssigned, onCategoryAssigned, onLogAdded, onNodeStarted, onScreencastAdded, onTestStarted, stop

Methods inherited from class com.aventstack.extentreports.reporter.AbstractReporter

getCategoryContextInfo, getEndTime, getExceptionContextInfo, getRunDuration, getStartTime, getStatusCount, getSystemAttributeContext, getTestDisplayOrder, getTestRunnerLogs, loadConfig, loadConfig, loadConfig, loadXMLConfig, loadXMLConfig, setCategoryContextInfo, setEndTime, setExceptionContextInfo, setStartTime, setStatusCount, setSystemAttributeContext, setTestDisplayOrder, setTestRunnerLogs

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtentHtmlReporter

public ExtentHtmlReporter(java.lang.String filePath)

ExtentHtmlReporter

public ExtentHtmlReporter(java.io.File file)

Method Detail

config

public ExtentHtmlReporterConfiguration config()

start

public void start()

Description copied from interface: ExtentReporter

Starts passing run information to the reporter

Specified by:

start in interface ExtentReporter

flush

public void flush()

Specified by:

flush in interface ExtentReporter

onScreenCaptureAdded

public void onScreenCaptureAdded(Test test,
                                 ScreenCapture screenCapture)
                          throws java.io.IOException

Description copied from interface: TestListener

Invoked each time a screencapture is added to test

Specified by:

onScreenCaptureAdded in interface TestListener

Parameters:

test - Test object

screenCapture - ScreenCapture object

Throws:

java.io.IOException - Exception thrown if the media object is not found

onScreenCaptureAdded

public void onScreenCaptureAdded(Log log,
                                 ScreenCapture screenCapture)
                          throws java.io.IOException

Description copied from interface: TestListener

Invoked each time a screenshot is added to log

Specified by:

onScreenCaptureAdded in interface TestListener

Parameters:

log - Log object

screenCapture - ScreenCapture object

Throws:

java.io.IOException - Exception thrown if the media object is not found

setTestList

public void setTestList(java.util.List<Test> reportTestList)

Description copied from interface: ReportAggregatesListener

Allows sharing the complete list of tests with the reporter

Specified by:

setTestList in interface ReportAggregatesListener

Parameters:

reportTestList - list of all tests created by ExtentReports

getTestList

public java.util.List<Test> getTestList()

containsStatus

public boolean containsStatus(Status status)

getConfigContext

public ConfigMap getConfigContext()

setAppendExisting

public void setAppendExisting(java.lang.Boolean b)

Specified by:

setAppendExisting in interface ReportAppendable