Package it.unive.lisa.outputs.compare

Class JsonReportComparer

java.lang.Object

it.unive.lisa.outputs.compare.JsonReportComparer

public class JsonReportComparer
extends java.lang.Object

A class providing capabilities for finding differences between two JsonReports.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JsonReportComparer.DiffReporter	An object that provides callbacks for reporting differences when comparing JsonReports.
static class	JsonReportComparer.REPORT_TYPE	An enumeration defining the different type of reports that can be issued.
static class	JsonReportComparer.REPORTED_COMPONENT	An enumeration defining the different components of a JsonReport, in order to distinguish which one of them caused a difference being reported.

Constructor Summary

Constructors

Constructor	Description
JsonReportComparer()

Method Summary

Modifier and Type	Method	Description
static boolean	compare(JsonReport first, JsonReport second, java.io.File firstFileRoot, java.io.File secondFileRoot)	Compares the two reports.
static boolean	compare(JsonReport first, JsonReport second, java.io.File firstFileRoot, java.io.File secondFileRoot, JsonReportComparer.DiffReporter reporter)	Compares the two reports.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonReportComparer

public JsonReportComparer()

Method Detail

compare

public static boolean compare(JsonReport first,
                              JsonReport second,
                              java.io.File firstFileRoot,
                              java.io.File secondFileRoot)
                       throws java.io.IOException

Compares the two reports. The JsonReportComparer.DiffReporter used during the comparison will dump the differences to System.err.

Parameters:

first - the first report

second - the second report

firstFileRoot - the root folder for the resolution of the file names in the first report (this should be either the workdir of that analysis or the folder where first lies)

secondFileRoot - the root folder for the resolution of the file names in the second report (this should be either the workdir of that analysis or the folder where second lies)

Returns:

true if and only the two reports are equal

Throws:

java.io.IOException - if errors happen while opening or reading the files contained in the reports

compare

public static boolean compare(JsonReport first,
                              JsonReport second,
                              java.io.File firstFileRoot,
                              java.io.File secondFileRoot,
                              JsonReportComparer.DiffReporter reporter)
                       throws java.io.IOException

Compares the two reports.

Parameters:

first - the first report

second - the second report

firstFileRoot - the root folder for the resolution of the file names in the first report (this should be either the workdir of that analysis or the folder where first lies)

secondFileRoot - the root folder for the resolution of the file names in the second report (this should be either the workdir of that analysis or the folder where second lies)

reporter - the JsonReportComparer.DiffReporter that will be used for dumping the differences found in the two reports

Returns:

true if and only the two reports are equal

Throws:

java.io.IOException - if errors happen while opening or reading the files contained in the reports