com.github.writethemfirst.approvals.reporters

Class ThrowsReporter

java.lang.Object

com.github.writethemfirst.approvals.reporters.ThrowsReporter

All Implemented Interfaces:

Reporter

public class ThrowsReporter
extends Object
implements Reporter

ThrowsReporter

That basic reporter simply allows to throw an AssertionError in case a mismatch is found in the approval files. It is always available since it’s only throwing a pure Java error, and requires no particular software or library to be present on the running machine.

Field Summary

Fields inherited from interface com.github.writethemfirst.approvals.Reporter

DEFAULT

Constructor Summary

Constructors

Constructor and Description
ThrowsReporter()

Method Summary

Modifier and Type	Method and Description
boolean	isAvailable() A ThrowsReporter is considered as always available since it has no external requirements at all.
void	mismatch(ApprovalFiles files) A Reporter is called whenever a difference is found while comparing the output of a Program Under Tests and the existing approved files linked to the tests.

Methods inherited from class java.lang.Object

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

Constructor Detail

ThrowsReporter

public ThrowsReporter()

Method Detail

mismatch

public void mismatch(ApprovalFiles files)

Description copied from interface: Reporter

A Reporter is called whenever a difference is found while comparing the output of a Program Under Tests and the existing approved files linked to the tests. That method is the one which will be called by the framework, specifying the approved and received files which present differences.

It is then used to implement the behavior to execute for dealing with that mismatch between both files.

Specified by:

mismatch in interface Reporter

Parameters:

files - the ApprovalFiles which holds the approved file (which contains the data reviewed and approved by the developer) and the temporary received file (which contains the data generated by the Program Under Tests)

isAvailable

public boolean isAvailable()

A ThrowsReporter is considered as always available since it has no external requirements at all.

Specified by:

isAvailable in interface Reporter

Returns:

True. Always and forever.