org.spdx.compare

Class LicenseCompareHelper

java.lang.Object

org.spdx.compare.LicenseCompareHelper

public class LicenseCompareHelper
extends Object

Primarily a static class of helper functions for comparing two SPDX licenses

Author:

Gary O'Neall

Field Summary

Fields

Modifier and Type	Field and Description
protected static HashMap<String,String>	EQUIV_TOKENS
protected static HashSet<String>	SKIPPABLE_TOKENS
protected static String	TOKEN_DELIM

Constructor Summary

Constructors

Constructor and Description
LicenseCompareHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	isLicenseEqual(SPDXLicenseInfo license1, SPDXLicenseInfo license2, HashMap<String,String> xlationMap) Compares two licenses from potentially two different documents which may have different license ID's for the same license
static boolean	isLicenseTextEquivalent(String licenseTextA, String licenseTextB) Returns true if two sets of license text is considered a match per the SPDX License matching guidelines documented at spdx.org (currently http://spdx.org/wiki/spdx-license-list-match-guidelines) There are 2 unimplemented features - bullets/numbering is not considered and comments with no whitespace between text is not skipped
static boolean	isTextStandardLicense(SPDXStandardLicense license, String compareText)

Methods inherited from class java.lang.Object

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

Field Detail

TOKEN_DELIM

protected static final String TOKEN_DELIM

See Also:

Constant Field Values

SKIPPABLE_TOKENS

protected static final HashSet<String> SKIPPABLE_TOKENS

EQUIV_TOKENS

protected static final HashMap<String,String> EQUIV_TOKENS

Constructor Detail

LicenseCompareHelper

public LicenseCompareHelper()

Method Detail

isLicenseTextEquivalent

public static boolean isLicenseTextEquivalent(String licenseTextA,
                              String licenseTextB)

Returns true if two sets of license text is considered a match per the SPDX License matching guidelines documented at spdx.org (currently http://spdx.org/wiki/spdx-license-list-match-guidelines) There are 2 unimplemented features - bullets/numbering is not considered and comments with no whitespace between text is not skipped

Parameters:

licenseTextA -

licenseTextB -

Returns:

isLicenseEqual

public static boolean isLicenseEqual(SPDXLicenseInfo license1,
                     SPDXLicenseInfo license2,
                     HashMap<String,String> xlationMap)
                              throws SpdxCompareException

Compares two licenses from potentially two different documents which may have different license ID's for the same license

Parameters:

license1 -

license2 -

xlationMap - Mapping the license ID's from license 1 to license 2

Returns:

Throws:

SpdxCompareException

isTextStandardLicense

public static boolean isTextStandardLicense(SPDXStandardLicense license,
                            String compareText)
                                     throws SpdxCompareException

Throws:

SpdxCompareException