org.spdx.compare

Class SpdxFileComparer

java.lang.Object

org.spdx.compare.SpdxFileComparer

public class SpdxFileComparer
extends Object

Compares two SPDX files. The compare(fileA, fileB) method will perform the comparison and store the results. isDifferenceFound() will return true of any differences were found.

Author:

Gary O'Neall

Constructor Summary

Constructors

Constructor and Description
SpdxFileComparer()

Method Summary

Methods

Modifier and Type	Method and Description
void	compare(SPDXFile fileA, SPDXFile fileB, HashMap<String,String> licenseXlationMap) Compare two SPDX files and store the results
static String[]	filesToFileNames(SPDXFile[] files) Extracts out the file names into a string array
SPDXFile	getFileA()
SPDXFile	getFileB()
SpdxFileDifference	getFileDifference() Return a file difference - the two file names must equal
DOAPProject[]	getUniqueArtifactOfA()
DOAPProject[]	getUniqueArtifactOfB()
SPDXLicenseInfo[]	getUniqueSeenLicensesA()
SPDXLicenseInfo[]	getUniqueSeenLicensesB()
boolean	isArtifactOfEquals()
boolean	isChecksumsEquals()
boolean	isCommentsEquals()
boolean	isConcludedLicenseEquals()
boolean	isContributorsEquals()
boolean	isCopyrightsEquals()
boolean	isDifferenceFound()
boolean	isFileDependenciesEquals()
boolean	isLicenseCommmentsEquals()
boolean	isNamesEquals()
boolean	isNoticeTextEquals()
boolean	isSeenLicenseEquals()
boolean	isTypesEquals()

Methods inherited from class java.lang.Object

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

Constructor Detail

SpdxFileComparer

public SpdxFileComparer()

Method Detail

isFileDependenciesEquals

public boolean isFileDependenciesEquals()

Returns:

the fileDependenciesEquals

isContributorsEquals

public boolean isContributorsEquals()

Returns:

the contributorsEquals

isNoticeTextEquals

public boolean isNoticeTextEquals()

Returns:

the noticeTextEquals

compare

public void compare(SPDXFile fileA,
           SPDXFile fileB,
           HashMap<String,String> licenseXlationMap)
             throws SpdxCompareException

Compare two SPDX files and store the results

Parameters:

fileA -

fileB -

licenseXlationMap - A mapping between the license IDs from licenses in fileA to fileB

Throws:

SpdxCompareException

filesToFileNames

public static String[] filesToFileNames(SPDXFile[] files)

Extracts out the file names into a string array

Parameters:

files -

Returns:

getFileA

public SPDXFile getFileA()

Returns:

the fileA

getFileB

public SPDXFile getFileB()

Returns:

the fileB

isConcludedLicenseEquals

public boolean isConcludedLicenseEquals()

Returns:

the concludedLicenseEquals

isSeenLicenseEquals

public boolean isSeenLicenseEquals()

Returns:

the seenLicenseEquals

isArtifactOfEquals

public boolean isArtifactOfEquals()

Returns:

the artifactOfEquals

getUniqueSeenLicensesB

public SPDXLicenseInfo[] getUniqueSeenLicensesB()

Returns:

the uniqueSeenLicensesB

getUniqueSeenLicensesA

public SPDXLicenseInfo[] getUniqueSeenLicensesA()

Returns:

the uniqueSeenLicensesA

getUniqueArtifactOfA

public DOAPProject[] getUniqueArtifactOfA()

Returns:

the uniqueArtifactOfA

getUniqueArtifactOfB

public DOAPProject[] getUniqueArtifactOfB()

Returns:

the uniqueArtifactOfB

isCommentsEquals

public boolean isCommentsEquals()

Returns:

the commentsEquals

isCopyrightsEquals

public boolean isCopyrightsEquals()

Returns:

the copyrightsEquals

isLicenseCommmentsEquals

public boolean isLicenseCommmentsEquals()

Returns:

the licenseCommmentsEquals

isNamesEquals

public boolean isNamesEquals()

Returns:

the namesEquals

isChecksumsEquals

public boolean isChecksumsEquals()

Returns:

the checksumsEquals

isTypesEquals

public boolean isTypesEquals()

Returns:

the typesEquals

isDifferenceFound

public boolean isDifferenceFound()
                          throws SpdxCompareException

Returns:

Throws:

SpdxCompareException

getFileDifference

public SpdxFileDifference getFileDifference()
                                     throws SpdxCompareException

Return a file difference - the two file names must equal

Returns:

Throws:

SpdxCompareException