com.aventstack.extentreports.reporter

Class AbstractReporter

java.lang.Object

com.aventstack.extentreports.reporter.AbstractReporter

All Implemented Interfaces:

IAnalysisStrategyMethod, ExtentReporter, TestListener

Direct Known Subclasses:

ConfigurableReporter, ConsoleLogger

public abstract class AbstractReporter
extends java.lang.Object
implements ExtentReporter

Constructor Summary

Constructors

Constructor and Description
AbstractReporter()

Method Summary

Modifier and Type	Method and Description
protected void	autoCreateRelativePathMedia(ScreenCapture screenCapture, java.lang.Boolean autoCreateRelativePath, java.lang.String destination)
void	flush(ReportAggregates reportAggregates) Write to or update the target source (file, database)
AnalysisStrategy	getAnalysisStrategy()
TestAttributeTestContextStore<Author>	getAuthorContextInfo()
TestAttributeTestContextStore<Category>	getCategoryContextInfo()
TestAttributeTestContextStore<Device>	getDeviceContextInfo()
java.util.Date	getEndTime()
ExceptionTestContextStore	getExceptionContextInfo()
java.lang.String	getLongRunDuration()
ReportStatusStats	getReportStatusStats()
long	getRunDuration()
java.util.Date	getStartTime()
java.util.Collection<Status>	getStatusCollection()
SystemAttributeContext	getSystemAttributeContext()
java.util.List<Test>	getTestList()
java.util.List<java.lang.String>	getTestRunnerLogs()
void	onAuthorAssigned(Test test, Author author) Invoked each time an author is assigned to any test/node
void	onCategoryAssigned(Test test, Category category) Invoked each time a category is assigned to any test/node
void	onDeviceAssigned(Test test, Device device) Invoked each time a device is assigned to any test/node
void	onLogAdded(Test test, Log log) Invoked each time a log is added to any test/node
void	onNodeStarted(Test node) Invoked when a node is started using createNode()
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
void	onTestRemoved(Test test) Invoked when a test is removed using removeTest()
void	onTestStarted(Test test) Invoked when a test is started using createTest()
void	setAnalysisStrategy(AnalysisStrategy strategy)
void	setEndTime(java.util.Date endTime)
void	setStartTime(java.util.Date startTime)
void	stop() Stops the reporter.

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, start

Constructor Detail

AbstractReporter

public AbstractReporter()

Method Detail

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

Parameters:

reportAggregates - a ReportAggregates object

getStartTime

public java.util.Date getStartTime()

setStartTime

public void setStartTime(java.util.Date startTime)

setEndTime

public void setEndTime(java.util.Date endTime)

getEndTime

public java.util.Date getEndTime()

setAnalysisStrategy

public void setAnalysisStrategy(AnalysisStrategy strategy)

Specified by:

setAnalysisStrategy in interface IAnalysisStrategyMethod

getAnalysisStrategy

public AnalysisStrategy getAnalysisStrategy()

Specified by:

getAnalysisStrategy in interface IAnalysisStrategyMethod

getRunDuration

public long getRunDuration()

getLongRunDuration

public java.lang.String getLongRunDuration()

getTestList

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

getTestRunnerLogs

public java.util.List<java.lang.String> getTestRunnerLogs()

getCategoryContextInfo

public TestAttributeTestContextStore<Category> getCategoryContextInfo()

getAuthorContextInfo

public TestAttributeTestContextStore<Author> getAuthorContextInfo()

getDeviceContextInfo

public TestAttributeTestContextStore<Device> getDeviceContextInfo()

getExceptionContextInfo

public ExceptionTestContextStore getExceptionContextInfo()

getSystemAttributeContext

public SystemAttributeContext getSystemAttributeContext()

getReportStatusStats

public ReportStatusStats getReportStatusStats()

getStatusCollection

public java.util.Collection<Status> getStatusCollection()

onTestStarted

public void onTestStarted(Test test)

Description copied from interface: TestListener

Invoked when a test is started using createTest()

Specified by:

onTestStarted in interface TestListener

Parameters:

test - Test object

onTestRemoved

public void onTestRemoved(Test test)

Description copied from interface: TestListener

Invoked when a test is removed using removeTest()

Specified by:

onTestRemoved in interface TestListener

Parameters:

test - Test object

onNodeStarted

public void onNodeStarted(Test node)

Description copied from interface: TestListener

Invoked when a node is started using createNode()

Specified by:

onNodeStarted in interface TestListener

Parameters:

node - Test object

onLogAdded

public void onLogAdded(Test test,
                       Log log)

Description copied from interface: TestListener

Invoked each time a log is added to any test/node

Specified by:

onLogAdded in interface TestListener

Parameters:

test - Test object

log - Log object

onCategoryAssigned

public void onCategoryAssigned(Test test,
                               Category category)

Description copied from interface: TestListener

Invoked each time a category is assigned to any test/node

Specified by:

onCategoryAssigned in interface TestListener

Parameters:

test - Test object

category - Category object

onAuthorAssigned

public void onAuthorAssigned(Test test,
                             Author author)

Description copied from interface: TestListener

Invoked each time an author is assigned to any test/node

Specified by:

onAuthorAssigned in interface TestListener

Parameters:

test - Test object

author - Author object

onDeviceAssigned

public void onDeviceAssigned(Test test,
                             Device device)

Description copied from interface: TestListener

Invoked each time a device is assigned to any test/node

Specified by:

onDeviceAssigned in interface TestListener

Parameters:

test - Test object

device - Device 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

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

Parameters:

log - Log object

screenCapture - ScreenCapture object

Throws:

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

autoCreateRelativePathMedia

protected void autoCreateRelativePathMedia(ScreenCapture screenCapture,
                                           java.lang.Boolean autoCreateRelativePath,
                                           java.lang.String destination)
                                    throws java.io.IOException

Throws:

java.io.IOException

stop

public void stop()

Description copied from interface: ExtentReporter

Stops the reporter. Ensures no information is passed to the reporter.

Specified by:

stop in interface ExtentReporter