com.github.writethemfirst.approvals.reporters

Class FirstWorkingReporter

java.lang.Object

com.github.writethemfirst.approvals.reporters.FirstWorkingReporter

All Implemented Interfaces:

Reporter

public class FirstWorkingReporter
extends java.lang.Object
implements Reporter

FirstWorkingReporter

Particular Reporter which allows to search in a list of potentially usable reporters for the first one available, and uses it.

This Reporter only searches in the reporters which are given to it while constructing it (it won’t parse the classpath or anything like this).

It also won’t try the reporters, but simply rely on their isAvailable() methods.

Field Summary

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

DEFAULT

Constructor Summary

Constructors

Constructor and Description
FirstWorkingReporter(Reporter... reporters) Constructs a FirstWorkingReporter with a list of potentially usable reporters

Method Summary

Modifier and Type	Method and Description
boolean	isAvailable() Checks if a working reporter has been found or not.
void	mismatch(java.nio.file.Path approved, java.nio.file.Path received) Reports a mismatch between the provided approved and received files using the first working reporter found.

Methods inherited from class java.lang.Object

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

Constructor Detail

FirstWorkingReporter

public FirstWorkingReporter(Reporter... reporters)

Constructs a FirstWorkingReporter with a list of potentially usable reporters

Careful: the provided reporters will be parsed in the order you provided them! Be sure to order them in the order you actually want!

Parameters:

reporters - The reporters that could be usable, in which will search for the actual first availabe

Method Detail

mismatch

public void mismatch(java.nio.file.Path approved,
                     java.nio.file.Path received)

Reports a mismatch between the provided approved and received files using the first working reporter found.

Since the FirstWorkingReporter is usualy used as a fallback reporter, in case no first working reporter can be found and a mismatch is raised, a log entry will be written in System.err.

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)

isAvailable

public boolean isAvailable()

Checks if a working reporter has been found or not.

Specified by:

isAvailable in interface Reporter

Returns:

true if an available reporter has been found in the provided ones.