Package org.spdx.utility.compare

Utility classes for comparing SPDX model objects

Author:

Gary O'Neall

Class Summary

Class	Description
CompareTemplateOutputHandler	Compares the output of a parsed license template to text.
FilterTemplateOutputHandler	Deprecated. The TemplateRegexMatcher class should be used in place of this class.
LicenseCompareHelper	Primarily a static class of helper functions for comparing two SPDX licenses
SpdxComparer	Performs a comparison between two or more SPDX documents and holds the results of the comparison The main function to perform the comparison is compare(spdxdoc1, spdxdoc2) For files, the comparison results are separated into unique files based on the file names which can be obtained by the method getUniqueFiles(index1, index2).
SpdxExternalRefDifference	Contains information on differences between two different External Refs.
SpdxFileComparer	Compares two SPDX files.
SpdxFileDifference	Contains the results of a comparison between two SPDX files with the same name
SpdxItemComparer	Compares two SPDX items.
SpdxItemDifference	Contains the results of a comparison between two SPDX items with the same name
SpdxLicenseDifference	Contains the results of a comparison between two SPDX non-standard licenses where the license text is equivalent and the license comment, license ID, or other fields are different
SpdxPackageComparer	Compares two SPDX package.
SpdxSnippetComparer	Compares two SPDX snippets.
TemplateRegexMatcher	Constructs a regular expression from a license or exception template and provide a matching method to see if code matching the template exists within the text provided Note that the regular expression assumes a fully normalized text string to match isTemplateMatchWithinText(String text) will return true if the text text matches the template getQuickMatchRegex() will return a regular expression with limited backtracking which can be used for a quick search getCompleteRegex() will return a regular expression for the entire license where getStartRegex(int wordLimit) will return a regular expression to match the beginning of a license and getEndRegex(int wordLimit) will return a regular expression to match the end of a license

Enum Summary

Enum	Description
FilterTemplateOutputHandler.OptionalTextHandling
FilterTemplateOutputHandler.VarTextHandling

Exception Summary

Exception	Description
SpdxCompareException