com.reqdesign.reqif.difference

Class DifferenceAnalyzer

java.lang.Object

com.reqdesign.reqif.difference.DifferenceAnalyzer

public final class DifferenceAnalyzer
extends java.lang.Object

This class implements the difference analyzer. Two ReqIF archives are provided in the argument. Differences are determined and delivered to the specified consumer.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DifferenceAnalyzer.ComparableReqIFFiles Class wrapper for two ReqIFFile objects to be used in comparison scenarios

Constructor Summary

Constructors

Constructor and Description
DifferenceAnalyzer()

Method Summary

Modifier and Type	Method and Description
static void	analyzeDifferences(ReqIFArchive reqIFArchive1, ReqIFArchive reqIFArchive2, java.util.function.Consumer<Difference> differenceConsumer) This method analyzes the differences between the 1st ReqIFArchive and the 2nd ReqIFArchive.
static void	analyzeDifferences(ReqIFFile reqIFFile1, ReqIFFile reqIFFile2, java.util.function.Consumer<Difference> differenceConsumer) This method analyzes the differences between the 1st ReqIFFile and the 2nd ReqIFFile.
static java.util.List<DifferenceAnalyzer.ComparableReqIFFiles>	getComparableReqIFFilesList(ReqIFArchive reqIFArchive1, ReqIFArchive reqIFArchive2) Compiles a DifferenceAnalyzer.ComparableReqIFFiles object from the two specified ReqIFArchive objects
static boolean	isSameReqIFFile(ReqIFFile reqIFFile1, ReqIFFile reqIFFile2) Compares two ReqIFFile.

Methods inherited from class java.lang.Object

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

Constructor Detail

DifferenceAnalyzer

public DifferenceAnalyzer()

Method Detail

analyzeDifferences

public static void analyzeDifferences(ReqIFArchive reqIFArchive1,
                                      ReqIFArchive reqIFArchive2,
                                      java.util.function.Consumer<Difference> differenceConsumer)
                               throws DifferenceAnalyzerException

This method analyzes the differences between the 1st ReqIFArchive and the 2nd ReqIFArchive.

Parameters:

reqIFArchive1 - the first archive ReqIFArchive, not null

reqIFArchive2 - the second archive ReqIFArchive, not null

differenceConsumer - a consumer of Difference objects, not null

Throws:

DifferenceAnalyzerException - if no comparable files.

getComparableReqIFFilesList

public static java.util.List<DifferenceAnalyzer.ComparableReqIFFiles> getComparableReqIFFilesList(ReqIFArchive reqIFArchive1,
                                                                                                  ReqIFArchive reqIFArchive2)

Compiles a DifferenceAnalyzer.ComparableReqIFFiles object from the two specified ReqIFArchive objects

Parameters:

reqIFArchive1 - the first archive, not null

reqIFArchive2 - the second archive, not null

Returns:

the created ComparableReqIFFiles collection, not null

isSameReqIFFile

public static boolean isSameReqIFFile(ReqIFFile reqIFFile1,
                                      ReqIFFile reqIFFile2)

Compares two ReqIFFile. The comparison is made on at least one shared SpecType identifier

Parameters:

reqIFFile1 - the first ReqIFFile to check, not null

reqIFFile2 - the second ReqIFFile to check, not null

Returns:

{code Boolean} flag indicating whether the two ReqIFFile objects are related

analyzeDifferences

public static void analyzeDifferences(ReqIFFile reqIFFile1,
                                      ReqIFFile reqIFFile2,
                                      java.util.function.Consumer<Difference> differenceConsumer)
                               throws DifferenceAnalyzerException

This method analyzes the differences between the 1st ReqIFFile and the 2nd ReqIFFile.

Parameters:

reqIFFile1 - the first ReqIFFile to check, not null

reqIFFile2 - the second ReqIFFile to check, not null

differenceConsumer - a Consumer of Difference objects, not null

Throws:

DifferenceAnalyzerException - if the ReqIFFile objects are not related in the sense that boolean would return True