Uses of Class org.spdx.utility.compare.SpdxCompareException (java-spdx-library 2.0.2 API)

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(org.spdx.library.model.v2.SpdxDocument spdxDocument, org.spdx.library.model.v2.SpdxFile spdxFile)

Add a file to the comparer and compare to the existing files

void

SpdxItemComparer.addDocumentItem(org.spdx.library.model.v2.SpdxDocument spdxDocument, org.spdx.library.model.v2.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(org.spdx.library.model.v2.SpdxDocument spdxDocument, org.spdx.library.model.v2.SpdxPackage spdxPackage)

Add a package to the comparer and performs the comparison to any existing documents

void

SpdxSnippetComparer.addDocumentSnippet(org.spdx.library.model.v2.SpdxDocument spdxDocument, org.spdx.library.model.v2.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<org.spdx.library.model.v2.SpdxDocument> spdxDocuments)

Compares multiple SPDX documents

void

SpdxComparer.compare(org.spdx.library.model.v2.SpdxDocument spdxDoc1, org.spdx.library.model.v2.SpdxDocument spdxDoc2)

Compares 2 SPDX documents

boolean

SpdxComparer.compareLicense(int doc1, org.spdx.library.model.v2.license.AnyLicenseInfo license1, int doc2, org.spdx.library.model.v2.license.AnyLicenseInfo license2)

Compares two licenses from two different SPDX documents taking into account the extracted license infos whose ID's may be different between the two documents Note: The ExtractedLicenseIDMap must be initialized before this method is invoked

List<SpdxExternalRefDifference>

SpdxPackageComparer.getExternalRefDifferences(org.spdx.library.model.v2.SpdxDocument docA, org.spdx.library.model.v2.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

org.spdx.library.model.v2.SpdxFile

SpdxFileComparer.getFile(org.spdx.library.model.v2.SpdxDocument spdxDocument)

SpdxFileDifference

SpdxFileComparer.getFileDifference(org.spdx.library.model.v2.SpdxDocument docA, org.spdx.library.model.v2.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(org.spdx.library.model.v2.SpdxDocument docA, org.spdx.library.model.v2.SpdxDocument docB)

Get any fileDifferences which are in docA but not in docB

org.spdx.library.model.v2.SpdxItem

SpdxItemComparer.getItem(org.spdx.library.model.v2.SpdxDocument doc)

Get the item contained by the document doc

static List<String>

LicenseCompareHelper.getNonOptionalLicenseText(String licenseTemplate, FilterTemplateOutputHandler.VarTextHandling varTextHandling)

Get the text of a license minus any optional text - note: this includes the default variable text

static List<String>

LicenseCompareHelper.getNonOptionalLicenseText(String licenseTemplate, FilterTemplateOutputHandler.VarTextHandling varTextHandling, FilterTemplateOutputHandler.OptionalTextHandling optionalTextHandling)

Get the text of a license converting variable and optional text according to the options

int

SpdxPackageComparer.getNumPackages()

List<SpdxPackageComparer>

SpdxComparer.getPackageDifferences()

String

SpdxPackageComparer.getPackageName()

SpdxFileDifference

SpdxSnippetComparer.getSnippetFromFileDifference(org.spdx.library.model.v2.SpdxDocument docA, org.spdx.library.model.v2.SpdxDocument docB)

Get any file difference for the Spdx Snippet From File between the two SPDX documents If the fileName is different, they are considered unique files and the getUniqueSnippetFromFile should be called to obtain the unique file

org.spdx.library.model.v2.SpdxDocument

SpdxComparer.getSpdxDoc(int docIndex)

List<org.spdx.library.model.v2.Annotation>

SpdxItemComparer.getUniqueAnnotations(org.spdx.library.model.v2.SpdxDocument docA, org.spdx.library.model.v2.SpdxDocument docB)

Get annotations that are in docA but not in docB

List<org.spdx.library.model.v2.Checksum>

SpdxFileComparer.getUniqueChecksums(org.spdx.library.model.v2.SpdxDocument docA, org.spdx.library.model.v2.SpdxDocument docB)

Get the checksums which are present in the file contained document A but not in document B

List<org.spdx.library.model.v2.Checksum>

SpdxPackageComparer.getUniqueChecksums(org.spdx.library.model.v2.SpdxDocument docA, org.spdx.library.model.v2.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<org.spdx.library.model.v2.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<org.spdx.library.model.v2.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<org.spdx.library.model.v2.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<org.spdx.library.model.v2.ExternalRef>

SpdxPackageComparer.getUniqueExternalRefs(org.spdx.library.model.v2.SpdxDocument docA, org.spdx.library.model.v2.SpdxDocument docB)

List<org.spdx.library.model.v2.license.ExtractedLicenseInfo>

SpdxComparer.getUniqueExtractedLicenses(int docIndexA, int docIndexB)

Retrieves any unique extracted licenses from the first SPDX document index relative to the second - unique is determined by the license text matching

List<org.spdx.library.model.v2.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<org.spdx.library.model.v2.SpdxFile>

SpdxPackageComparer.getUniqueFiles(org.spdx.library.model.v2.SpdxDocument docA, org.spdx.library.model.v2.SpdxDocument docB)

Return any unique files by name which are in docA but not in docB

List<org.spdx.library.model.v2.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<org.spdx.library.model.v2.Relationship>

SpdxItemComparer.getUniqueRelationship(org.spdx.library.model.v2.SpdxDocument docA, org.spdx.library.model.v2.SpdxDocument docB)

Get relationships that are in docA but not in docB

List<org.spdx.library.model.v2.license.AnyLicenseInfo>

SpdxItemComparer.getUniqueSeenLicenses(org.spdx.library.model.v2.SpdxDocument docA, org.spdx.library.model.v2.SpdxDocument docB)

Get any licenses found in docA but not in docB

org.spdx.library.model.v2.SpdxFile

SpdxSnippetComparer.getUniqueSnippetFromFile(org.spdx.library.model.v2.SpdxDocument docA, org.spdx.library.model.v2.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()

Deprecated.

boolean

SpdxComparer.isExternalDocumentRefsEquals()

boolean

SpdxPackageComparer.isExternalRefsEquals()

boolean

SpdxComparer.isExtractedLicensingInfosEqual()

boolean

SpdxPackageComparer.isFilesAnalyzedEquals()

boolean

SpdxComparer.isfilesEquals()

Deprecated.

boolean

SpdxComparer.isFilesEquals()

boolean

SpdxItemComparer.isInProgress()

boolean

SpdxItemComparer.isLicenseCommentsEquals()

boolean

SpdxItemComparer.isLicenseCommmentsEquals()

Deprecated.

static boolean

LicenseCompareHelper.isLicenseEqual(org.spdx.library.model.v2.license.AnyLicenseInfo license1, org.spdx.library.model.v2.license.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

static boolean

LicenseCompareHelper.isLicenseEqual(org.spdx.library.model.v3_0_1.simplelicensing.AnyLicenseInfo license1, org.spdx.library.model.v3_0_1.simplelicensing.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()

boolean

TemplateRegexMatcher.isTemplateMatchWithinText(String text)

static CompareTemplateOutputHandler.DifferenceDescription

LicenseCompareHelper.isTextMatchingTemplate(String template, String compareText)

Compare the provided text against a license template using SPDX matching guidelines

static CompareTemplateOutputHandler.DifferenceDescription

LicenseCompareHelper.isTextStandardException(org.spdx.library.model.v2.license.LicenseException exception, String compareText)

Compares exception text to the exception text of an SPDX Standard exception

static CompareTemplateOutputHandler.DifferenceDescription

LicenseCompareHelper.isTextStandardException(org.spdx.library.model.v3_0_1.expandedlicensing.ListedLicenseException exception, String compareText)

Compares exception text to the exception text of an SPDX Standard exception

static CompareTemplateOutputHandler.DifferenceDescription

LicenseCompareHelper.isTextStandardLicense(org.spdx.library.model.v2.license.License license, String compareText)

Compares license text to the license text of an SPDX Standard License

static CompareTemplateOutputHandler.DifferenceDescription

LicenseCompareHelper.isTextStandardLicense(org.spdx.library.model.v3_0_1.expandedlicensing.License license, String compareText)

Compares license text to the license text of an SPDX Standard License

boolean

SpdxFileComparer.isTypesEquals()

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.

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

Modifier

Constructor

Description

SpdxFileDifference(org.spdx.library.model.v2.SpdxFile fileA, org.spdx.library.model.v2.SpdxFile fileB, boolean concludedLicensesEqual, boolean seenLicensesEqual, List<org.spdx.library.model.v2.license.AnyLicenseInfo> uniqueSeenLicensesA, List<org.spdx.library.model.v2.license.AnyLicenseInfo> uniqueSeenLicensesB, boolean checksumsEquals, List<org.spdx.library.model.v2.Checksum> uniqueChecksumsA, List<org.spdx.library.model.v2.Checksum> uniqueChecksumsB, boolean relationshipsEquals, List<org.spdx.library.model.v2.Relationship> uniqueRelationshipA, List<org.spdx.library.model.v2.Relationship> uniqueRelationshipB, boolean annotationsEquals, List<org.spdx.library.model.v2.Annotation> uniqueAnnotationsA, List<org.spdx.library.model.v2.Annotation> uniqueAnnotationsB)

TemplateRegexMatcher(String template)

Generates regular expressions from a license or exception template

Uses of Classorg.spdx.utility.compare.SpdxCompareException

Uses of SpdxCompareException in org.spdx.utility.compare

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