Uses of Class
org.spdx.utility.compare.SpdxCompareException

Packages that use SpdxCompareException

Package	Description
org.spdx.utility.compare	Utility classes for comparing SPDX model objects

Uses of SpdxCompareException in org.spdx.utility.compare

Methods in org.spdx.utility.compare that throw SpdxCompareException

Modifier and Type	Method	Description
void	SpdxFileComparer.addDocumentFile(SpdxDocument spdxDocument, SpdxFile spdxFile)	Add a file to the comparer and compare to the existing files
void	SpdxItemComparer.addDocumentItem(SpdxDocument spdxDocument, SpdxItem spdxItem)	Add a new item to the comparer and compare the contents of the item to all items which have been previously added
void	SpdxPackageComparer.addDocumentPackage(SpdxDocument spdxDocument, SpdxPackage spdxPackage)	Add a package to the comparer and performs the comparison to any existing documents
void	SpdxSnippetComparer.addDocumentSnippet(SpdxDocument spdxDocument, SpdxSnippet snippet)	Add a snippet to the comparer and performs the comparison to any existing documents
protected void	SpdxItemComparer.checkCompareMade()
protected void	SpdxFileComparer.checkInProgress()	checks to make sure there is not a compare in progress
protected void	SpdxItemComparer.checkInProgress()	checks to make sure there is not a compare in progress
protected void	SpdxPackageComparer.checkInProgress()	checks to make sure there is not a compare in progress
protected void	SpdxSnippetComparer.checkInProgress()	checks to make sure there is not a compare in progress
void	SpdxComparer.compare(List<SpdxDocument> spdxDocuments)	Compares multiple SPDX documents
void	SpdxComparer.compare(SpdxDocument spdxDoc1, SpdxDocument spdxDoc2)	Compares 2 SPDX documents
boolean	SpdxComparer.compareLicense(int doc1, AnyLicenseInfo license1, int doc2, AnyLicenseInfo license2)	Compares two licenses from two different SPDX documents taking into account the extracted license infos who's ID's may be different between the two documents Note: The ExtracedLicenseIDMap must be initialized before this method is invoked
SpdxPackage	SpdxPackageComparer.getDocPackage(SpdxDocument document)	Return the package associated with the document
List<SpdxExternalRefDifference>	SpdxPackageComparer.getExternalRefDifferences(SpdxDocument docA, SpdxDocument docB)
List<SpdxLicenseDifference>	SpdxComparer.getExtractedLicenseDifferences(int docIndexA, int docIndexB)	Retrieves any licenses which where the text matches in both documents but other fields are different
SpdxFile	SpdxFileComparer.getFile(SpdxDocument spdxDocument)
SpdxFileDifference	SpdxFileComparer.getFileDifference(SpdxDocument docA, SpdxDocument docB)	Return a file difference for the file contained in two different documents
List<SpdxFileDifference>	SpdxComparer.getFileDifferences(int docindex1, int docindex2)	Returns any file differences found between the first and second SPDX documents as specified by the document index
List<SpdxFileDifference>	SpdxPackageComparer.getFileDifferences(SpdxDocument docA, SpdxDocument docB)	Get any fileDifferences which are in docA but not in docB
SpdxItem	SpdxItemComparer.getItem(SpdxDocument doc)	Get the item contained by the document doc
static List<String>	LicenseCompareHelper.getNonOptionalLicenseText(String licenseTemplate, boolean includeVarText)	Deprecated.
static List<String>	LicenseCompareHelper.getNonOptionalLicenseText(String licenseTemplate, FilterTemplateOutputHandler.VarTextHandling varTextHandling)	Get the text of a license minus any optional text - note: this include the default variable text
int	SpdxPackageComparer.getNumPackages()
List<SpdxPackageComparer>	SpdxComparer.getPackageDifferences()
String	SpdxPackageComparer.getPackageName()
SpdxFileDifference	SpdxSnippetComparer.getSnippetFromFileDifference(SpdxDocument docA, SpdxDocument docB)	Get any file difference for the Spdx Snippet From File between the two SPDX documents If the fileName is different, the they are considered unique files and the getUniqueSnippetFromFile should be called to obtain the unique file
SpdxDocument	SpdxComparer.getSpdxDoc(int docIndex)
List<Annotation>	SpdxItemComparer.getUniqueAnnotations(SpdxDocument docA, SpdxDocument docB)	Get annotations that are in docA but not in docB
List<Checksum>	SpdxFileComparer.getUniqueChecksums(SpdxDocument docA, SpdxDocument docB)	Get the checksums which are present in the file contained document A but not in document B
List<Checksum>	SpdxPackageComparer.getUniqueChecksums(SpdxDocument docA, SpdxDocument docB)	Get the checksums which are present in document A but not in document B
List<String>	SpdxComparer.getUniqueCreators(int doc1index, int doc2index)	Returns any creators which are in the SPDX document 1 which are not in document 2
List<Annotation>	SpdxComparer.getUniqueDocumentAnnotations(int docindex1, int docindex2)	Return any document annotations which are in spdx document index 1 but not in spdx document index 2
List<Relationship>	SpdxComparer.getUniqueDocumentRelationship(int docindex1, int docindex2)	Return any document annotations which are in spdx document index 1 but not in spdx document index 2
List<ExternalDocumentRef>	SpdxComparer.getUniqueExternalDocumentRefs(int docindex1, int docindex2)	Return any external document references which are in spdx document index 1 but not in spdx document index 2
List<ExternalRef>	SpdxPackageComparer.getUniqueExternalRefs(SpdxDocument docA, SpdxDocument docB)
List<ExtractedLicenseInfo>	SpdxComparer.getUniqueExtractedLicenses(int docIndexA, int docIndexB)	Retrieves any unique extracted licenses fromt the first SPDX document index relative to the second - unique is determined by the license text matching
List<SpdxFile>	SpdxComparer.getUniqueFiles(int docindex1, int docindex2)	Return any files which are in spdx document index 1 but not in spdx document index 2
List<SpdxFile>	SpdxPackageComparer.getUniqueFiles(SpdxDocument docA, SpdxDocument docB)	Return any unique files by name which are in docA but not in docB
List<SpdxPackage>	SpdxComparer.getUniquePackages(int docindex1, int docindex2)	Return any files which are in spdx document index 1 but not in spdx document index 2
List<Relationship>	SpdxItemComparer.getUniqueRelationship(SpdxDocument docA, SpdxDocument docB)	Get relationships that are in docA but not in docB
List<AnyLicenseInfo>	SpdxItemComparer.getUniqueSeenLicenses(SpdxDocument docA, SpdxDocument docB)	Get any licenses found in docA but not in docB
SpdxFile	SpdxSnippetComparer.getUniqueSnippetFromFile(SpdxDocument docA, SpdxDocument docB)	Get an SpdxFile that only exists in docA but not docB
boolean	SpdxItemComparer.isAnnotationsEquals()
boolean	SpdxItemComparer.isAttributionTextEquals()
boolean	SpdxSnippetComparer.isByteRangeEquals()
boolean	SpdxFileComparer.isChecksumsEquals()
boolean	SpdxItemComparer.isCommentsEquals()
boolean	SpdxItemComparer.isConcludedLicenseEquals()
boolean	SpdxFileComparer.isContributorsEquals()
boolean	SpdxItemComparer.isCopyrightsEquals()
boolean	SpdxComparer.isCreatorCommentsEqual()
boolean	SpdxComparer.isCreatorDatesEqual()
boolean	SpdxComparer.isCreatorInformationEqual()
boolean	SpdxComparer.isDataLicenseEqual()
boolean	SpdxPackageComparer.isDeclaredLicensesEquals()
boolean	SpdxFileComparer.isDifferenceFound()
boolean	SpdxItemComparer.isDifferenceFound()
boolean	SpdxPackageComparer.isDifferenceFound()
boolean	SpdxSnippetComparer.isDifferenceFound()
boolean	SpdxComparer.isDocumentAnnotationsEquals()
boolean	SpdxComparer.isDocumentCommentsEqual()
boolean	SpdxComparer.isDocumentContentsEquals()
boolean	SpdxComparer.isDocumentRelationshipsEquals()
boolean	SpdxComparer.isExternalDcoumentRefsEquals()
boolean	SpdxPackageComparer.isExternalRefsEquals()
boolean	SpdxComparer.isExtractedLicensingInfosEqual()
boolean	SpdxPackageComparer.isFilesAnalyzedEquals()
boolean	SpdxComparer.isfilesEquals()
boolean	SpdxItemComparer.isInProgress()
boolean	SpdxItemComparer.isLicenseCommmentsEquals()
static boolean	LicenseCompareHelper.isLicenseEqual(AnyLicenseInfo license1, AnyLicenseInfo license2, Map<String,String> xlationMap)	Compares two licenses from potentially two different documents which may have different license ID's for the same license
boolean	SpdxComparer.isLicenseListVersionEqual()
boolean	SpdxSnippetComparer.isLineRangeEquals()
boolean	SpdxSnippetComparer.isNameEquals()
boolean	SpdxFileComparer.isNoticeTextEquals()
boolean	SpdxPackageComparer.isPackageChecksumsEquals()
boolean	SpdxPackageComparer.isPackageDescriptionsEquals()
boolean	SpdxPackageComparer.isPackageDownloadLocationsEquals()
boolean	SpdxPackageComparer.isPackageFilenamesEquals()
boolean	SpdxPackageComparer.isPackageFilesEquals()
boolean	SpdxPackageComparer.isPackageHomePagesEquals()
boolean	SpdxPackageComparer.isPackageOriginatorsEqual()
boolean	SpdxComparer.isPackagesEquals()
boolean	SpdxPackageComparer.isPackageSourceInfosEquals()
boolean	SpdxPackageComparer.isPackageSummaryEquals()
boolean	SpdxPackageComparer.isPackageSuppliersEquals()
boolean	SpdxPackageComparer.isPackageVerificationCodesEquals()
boolean	SpdxPackageComparer.isPackageVersionsEquals()
boolean	SpdxItemComparer.isRelationshipsEquals()
boolean	SpdxItemComparer.isSeenLicenseEquals()
boolean	SpdxSnippetComparer.isSnippetFromFilesEquals()	The snippetFromFiles can be true if there are some unique snippetFromFiles or differences between the snippetFromFiles (or both)
boolean	SpdxComparer.isSnippetsEqual()
boolean	SpdxComparer.isSpdxVersionEqual()
static CompareTemplateOutputHandler.DifferenceDescription	LicenseCompareHelper.isTextStandardException(LicenseException exception, String compareText)	Compares exception text to the exception text of an SPDX Standard exception
static CompareTemplateOutputHandler.DifferenceDescription	LicenseCompareHelper.isTextStandardLicense(License license, String compareText)	Compares license text to the license text of an SPDX Standard License
boolean	SpdxFileComparer.isTypesEquals()
static List<String>	LicenseCompareHelper.matchingStandardLicenseExceptionIdsWithinText(String text)	Returns a list of SPDX Standard License Exception ID's that were found within the text, using the SPDX matching guidelines.
static List<String>	LicenseCompareHelper.matchingStandardLicenseExceptionIdsWithinText(String text, List<String> licenseExceptionIds)	Returns a list of SPDX Standard License Exception ID's from the provided list that were found within the text, using the SPDX matching guidelines.
static String[]	LicenseCompareHelper.matchingStandardLicenseIds(String licenseText)	Returns a list of SPDX Standard License ID's that match the text provided using the SPDX matching guidelines.
static List<String>	LicenseCompareHelper.matchingStandardLicenseIdsWithinText(String text)	Returns a list of SPDX Standard License ID's that were found within the text, using the SPDX matching guidelines.
static List<String>	LicenseCompareHelper.matchingStandardLicenseIdsWithinText(String text, List<String> licenseIds)	Returns a list of SPDX Standard License ID's from the provided list that were found within the text, using the SPDX matching guidelines.

Constructors in org.spdx.utility.compare that throw SpdxCompareException

Constructor	Description
SpdxFileDifference(SpdxFile fileA, SpdxFile fileB, boolean concludedLicensesEqual, boolean seenLicensesEqual, List<AnyLicenseInfo> uniqueSeenLicensesA, List<AnyLicenseInfo> uniqueSeenLicensesB, boolean checksumsEquals, List<Checksum> uniqueChecksumsA, List<Checksum> uniqueChecksumsB, boolean relationshipsEquals, List<Relationship> uniqueRelationshipA, List<Relationship> uniqueRelationshipB, boolean annotationsEquals, List<Annotation> uniqueAnnotationsA, List<Annotation> uniqueAnnotationsB)
SpdxItemDifference(SpdxItem itemA, SpdxItem itemB, boolean concludedLicensesEqual, boolean seenLicensesEqual, List<AnyLicenseInfo> uniqueSeenLicensesA, List<AnyLicenseInfo> uniqueSeenLicensesB, boolean relationshipsEquals, List<Relationship> uniqueRelationshipA, List<Relationship> uniqueRelationshipB, boolean annotationsEquals, List<Annotation> uniqueAnnotationsA, List<Annotation> uniqueAnnotationsB)