Uses of Class
org.spdx.utility.compare.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 voidSpdxFileComparer. addDocumentFile(SpdxDocument spdxDocument, SpdxFile spdxFile)Add a file to the comparer and compare to the existing filesvoidSpdxItemComparer. 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 addedvoidSpdxPackageComparer. addDocumentPackage(SpdxDocument spdxDocument, SpdxPackage spdxPackage)Add a package to the comparer and performs the comparison to any existing documentsvoidSpdxSnippetComparer. addDocumentSnippet(SpdxDocument spdxDocument, SpdxSnippet snippet)Add a snippet to the comparer and performs the comparison to any existing documentsprotected voidSpdxItemComparer. checkCompareMade()protected voidSpdxFileComparer. checkInProgress()checks to make sure there is not a compare in progressprotected voidSpdxItemComparer. checkInProgress()checks to make sure there is not a compare in progressprotected voidSpdxPackageComparer. checkInProgress()checks to make sure there is not a compare in progressprotected voidSpdxSnippetComparer. checkInProgress()checks to make sure there is not a compare in progressvoidSpdxComparer. compare(List<SpdxDocument> spdxDocuments)Compares multiple SPDX documentsvoidSpdxComparer. compare(SpdxDocument spdxDoc1, SpdxDocument spdxDoc2)Compares 2 SPDX documentsbooleanSpdxComparer. 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 invokedSpdxPackageSpdxPackageComparer. getDocPackage(SpdxDocument document)Return the package associated with the documentList<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 differentSpdxFileSpdxFileComparer. getFile(SpdxDocument spdxDocument)SpdxFileDifferenceSpdxFileComparer. getFileDifference(SpdxDocument docA, SpdxDocument docB)Return a file difference for the file contained in two different documentsList<SpdxFileDifference>SpdxComparer. getFileDifferences(int docindex1, int docindex2)Returns any file differences found between the first and second SPDX documents as specified by the document indexList<SpdxFileDifference>SpdxPackageComparer. getFileDifferences(SpdxDocument docA, SpdxDocument docB)Get any fileDifferences which are in docA but not in docBSpdxItemSpdxItemComparer. getItem(SpdxDocument doc)Get the item contained by the document docstatic 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 textintSpdxPackageComparer. getNumPackages()List<SpdxPackageComparer>SpdxComparer. getPackageDifferences()StringSpdxPackageComparer. getPackageName()SpdxFileDifferenceSpdxSnippetComparer. 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 fileSpdxDocumentSpdxComparer. getSpdxDoc(int docIndex)List<Annotation>SpdxItemComparer. getUniqueAnnotations(SpdxDocument docA, SpdxDocument docB)Get annotations that are in docA but not in docBList<Checksum>SpdxFileComparer. getUniqueChecksums(SpdxDocument docA, SpdxDocument docB)Get the checksums which are present in the file contained document A but not in document BList<Checksum>SpdxPackageComparer. getUniqueChecksums(SpdxDocument docA, SpdxDocument docB)Get the checksums which are present in document A but not in document BList<String>SpdxComparer. getUniqueCreators(int doc1index, int doc2index)Returns any creators which are in the SPDX document 1 which are not in document 2List<Annotation>SpdxComparer. getUniqueDocumentAnnotations(int docindex1, int docindex2)Return any document annotations which are in spdx document index 1 but not in spdx document index 2List<Relationship>SpdxComparer. getUniqueDocumentRelationship(int docindex1, int docindex2)Return any document annotations which are in spdx document index 1 but not in spdx document index 2List<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 2List<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 matchingList<SpdxFile>SpdxComparer. getUniqueFiles(int docindex1, int docindex2)Return any files which are in spdx document index 1 but not in spdx document index 2List<SpdxFile>SpdxPackageComparer. getUniqueFiles(SpdxDocument docA, SpdxDocument docB)Return any unique files by name which are in docA but not in docBList<SpdxPackage>SpdxComparer. getUniquePackages(int docindex1, int docindex2)Return any files which are in spdx document index 1 but not in spdx document index 2List<Relationship>SpdxItemComparer. getUniqueRelationship(SpdxDocument docA, SpdxDocument docB)Get relationships that are in docA but not in docBList<AnyLicenseInfo>SpdxItemComparer. getUniqueSeenLicenses(SpdxDocument docA, SpdxDocument docB)Get any licenses found in docA but not in docBSpdxFileSpdxSnippetComparer. getUniqueSnippetFromFile(SpdxDocument docA, SpdxDocument docB)Get an SpdxFile that only exists in docA but not docBbooleanSpdxItemComparer. isAnnotationsEquals()booleanSpdxItemComparer. isAttributionTextEquals()booleanSpdxSnippetComparer. isByteRangeEquals()booleanSpdxFileComparer. isChecksumsEquals()booleanSpdxItemComparer. isCommentsEquals()booleanSpdxItemComparer. isConcludedLicenseEquals()booleanSpdxFileComparer. isContributorsEquals()booleanSpdxItemComparer. isCopyrightsEquals()booleanSpdxComparer. isCreatorCommentsEqual()booleanSpdxComparer. isCreatorDatesEqual()booleanSpdxComparer. isCreatorInformationEqual()booleanSpdxComparer. isDataLicenseEqual()booleanSpdxPackageComparer. isDeclaredLicensesEquals()booleanSpdxFileComparer. isDifferenceFound()booleanSpdxItemComparer. isDifferenceFound()booleanSpdxPackageComparer. isDifferenceFound()booleanSpdxSnippetComparer. isDifferenceFound()booleanSpdxComparer. isDocumentAnnotationsEquals()booleanSpdxComparer. isDocumentCommentsEqual()booleanSpdxComparer. isDocumentContentsEquals()booleanSpdxComparer. isDocumentRelationshipsEquals()booleanSpdxComparer. isExternalDcoumentRefsEquals()booleanSpdxPackageComparer. isExternalRefsEquals()booleanSpdxComparer. isExtractedLicensingInfosEqual()booleanSpdxPackageComparer. isFilesAnalyzedEquals()booleanSpdxComparer. isfilesEquals()booleanSpdxItemComparer. isInProgress()booleanSpdxItemComparer. isLicenseCommmentsEquals()static booleanLicenseCompareHelper. 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 licensebooleanSpdxComparer. isLicenseListVersionEqual()booleanSpdxSnippetComparer. isLineRangeEquals()booleanSpdxSnippetComparer. isNameEquals()booleanSpdxFileComparer. isNoticeTextEquals()booleanSpdxPackageComparer. isPackageChecksumsEquals()booleanSpdxPackageComparer. isPackageDescriptionsEquals()booleanSpdxPackageComparer. isPackageDownloadLocationsEquals()booleanSpdxPackageComparer. isPackageFilenamesEquals()booleanSpdxPackageComparer. isPackageFilesEquals()booleanSpdxPackageComparer. isPackageHomePagesEquals()booleanSpdxPackageComparer. isPackageOriginatorsEqual()booleanSpdxComparer. isPackagesEquals()booleanSpdxPackageComparer. isPackageSourceInfosEquals()booleanSpdxPackageComparer. isPackageSummaryEquals()booleanSpdxPackageComparer. isPackageSuppliersEquals()booleanSpdxPackageComparer. isPackageVerificationCodesEquals()booleanSpdxPackageComparer. isPackageVersionsEquals()booleanSpdxItemComparer. isRelationshipsEquals()booleanSpdxItemComparer. isSeenLicenseEquals()booleanSpdxSnippetComparer. isSnippetFromFilesEquals()The snippetFromFiles can be true if there are some unique snippetFromFiles or differences between the snippetFromFiles (or both)booleanSpdxComparer. isSnippetsEqual()booleanSpdxComparer. isSpdxVersionEqual()static CompareTemplateOutputHandler.DifferenceDescriptionLicenseCompareHelper. isTextStandardException(LicenseException exception, String compareText)Compares exception text to the exception text of an SPDX Standard exceptionstatic CompareTemplateOutputHandler.DifferenceDescriptionLicenseCompareHelper. isTextStandardLicense(License license, String compareText)Compares license text to the license text of an SPDX Standard LicensebooleanSpdxFileComparer. 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)