com.aventstack.extentreports.reporter

Class BasicFileReporter

java.lang.Object

com.aventstack.extentreports.reporter.AbstractReporter

com.aventstack.extentreports.reporter.ConfigurableReporter

com.aventstack.extentreports.reporter.BasicFileReporter

All Implemented Interfaces:

IAnalysisStrategyMethod, ExtentReporter, TestListener

Direct Known Subclasses:

ExtentAventReporter, ExtentBDDReporter, ExtentCardsReporter, ExtentEmailReporter, ExtentHtmlReporter, ExtentLoggerReporter, ExtentSparkReporter, ExtentTabularReporter, JsonFormatter

public abstract class BasicFileReporter
extends ConfigurableReporter

A base class for all reporter types that generate an output file

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasicFileReporter(java.io.File f)
protected	BasicFileReporter(java.lang.String path)

Method Summary

Modifier and Type	Method and Description
boolean	containsStatus(Status status)
boolean	containsStatus(java.lang.String status)
protected java.lang.Boolean	enforceOfflineMode()
void	flush(ReportAggregates reportAggregates) Write to or update the target source (file, database)
java.lang.String	getDestinationPath()
java.io.File	getFileFile()
java.lang.String	getFilePath()
protected freemarker.template.Configuration	getFreemarkerConfig()
protected java.lang.String	getSource()
void	onScreenCaptureAdded(Log log, ScreenCapture screenCapture) Invoked each time a screencapture is added to log
void	onScreenCaptureAdded(Test test, ScreenCapture screenCapture) Invoked each time a screencapture is added to test
protected void	processTemplate(freemarker.template.Template template, java.io.File outputFile)
protected void	setFilePath(java.lang.String filePath)
void	start() Starts passing run information to the reporter

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

getConfigurationStore, init, loadConfig, loadConfig, loadConfig, loadInternalReporterConfiguration, loadUserConfig, loadXMLConfig, loadXMLConfig, loadXMLConfig

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

autoCreateRelativePathMedia, getAnalysisStrategy, getAuthorContextInfo, getCategoryContextInfo, getDeviceContextInfo, getEndTime, getExceptionContextInfo, getLongRunDuration, getReportStatusStats, getRunDuration, getStartTime, getStatusCollection, getSystemAttributeContext, getTestList, getTestRunnerLogs, onAuthorAssigned, onCategoryAssigned, onDeviceAssigned, onLogAdded, onNodeStarted, onTestRemoved, onTestStarted, setAnalysisStrategy, setEndTime, setStartTime, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aventstack.extentreports.reporter.ExtentReporter

getReporterName

Constructor Detail

BasicFileReporter

protected BasicFileReporter(java.io.File f)

BasicFileReporter

protected BasicFileReporter(java.lang.String path)

Method Detail

setFilePath

protected void setFilePath(java.lang.String filePath)

getFilePath

public java.lang.String getFilePath()

getFileFile

public java.io.File getFileFile()

getDestinationPath

public java.lang.String getDestinationPath()

start

public void start()

Description copied from interface: ExtentReporter

Starts passing run information to the reporter

flush

public void flush(ReportAggregates reportAggregates)

Description copied from interface: ExtentReporter

Write to or update the target source (file, database)

Specified by:

flush in interface ExtentReporter

Overrides:

flush in class AbstractReporter

Parameters:

reportAggregates - a ReportAggregates object

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

Overrides:

onScreenCaptureAdded in class AbstractReporter

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 screencapture is added to log

Specified by:

onScreenCaptureAdded in interface TestListener

Overrides:

onScreenCaptureAdded in class AbstractReporter

Parameters:

log - Log object

screenCapture - ScreenCapture object

Throws:

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

containsStatus

public boolean containsStatus(java.lang.String status)

containsStatus

public boolean containsStatus(Status status)

processTemplate

protected void processTemplate(freemarker.template.Template template,
                               java.io.File outputFile)
                        throws freemarker.template.TemplateException,
                               java.io.IOException

Throws:

freemarker.template.TemplateException

java.io.IOException

getSource

protected java.lang.String getSource()

getFreemarkerConfig

protected freemarker.template.Configuration getFreemarkerConfig()

enforceOfflineMode

protected java.lang.Boolean enforceOfflineMode()