com.github.writethemfirst.approvals.reporters

Class ThrowsReporter

java.lang.Object

com.github.writethemfirst.approvals.reporters.ThrowsReporter

All Implemented Interfaces:

Reporter

public class ThrowsReporter
extends java.lang.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(java.nio.file.Path approved, java.nio.file.Path received) Method called in case a mismatch is found.

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(java.nio.file.Path approved,
                     java.nio.file.Path received)

Method called in case a mismatch is found.

Specified by:

mismatch in interface Reporter

Parameters:

approved - The Path to the approved file (which contains the data reviewed and approved by the developer)

received - The Path to the temporary received file (which contains the data generated by the Program Under Tests)

Throws:

java.lang.AssertionError - if an actual mismatch is found.

See Also:

Reporter.mismatch(Path, Path)

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.