org.cyclonedx.util

Class LicenseResolver

java.lang.Object

org.cyclonedx.util.LicenseResolver

public final class LicenseResolver
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LicenseResolver.LicenseEncoding Lists possible choices for license text encoding
static class	LicenseResolver.LicenseTextSettings Data class aggregating settings for license text output

Method Summary

Modifier and Type	Method and Description
static LicenseChoice	resolve(String licenseString) Attempts to resolve the specified license string via SPDX license identifier and expression parsing first.
static LicenseChoice	resolve(String licenseString, boolean includeLicenseText) Attempts to resolve the specified license string via SPDX license identifier and expression parsing first.
static LicenseChoice	resolve(String licenseString, LicenseResolver.LicenseTextSettings licenseTextSettings) Attempts to resolve the specified license string via SPDX license identifier and expression parsing first.

Methods inherited from class java.lang.Object

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

Method Detail

resolve

public static LicenseChoice resolve(String licenseString)

Attempts to resolve the specified license string via SPDX license identifier and expression parsing first. If SPDX resolution is not successful, the method will attempt fuzzy matching.

Parameters:

licenseString - the license string to resolve

Returns:

a LicenseChoice object if resolution was successful, or null if unresolved

resolve

public static LicenseChoice resolve(String licenseString,
                                    boolean includeLicenseText)

Attempts to resolve the specified license string via SPDX license identifier and expression parsing first. If SPDX resolution is not successful, the method will attempt fuzzy matching.

Parameters:

licenseString - the license string to resolve

includeLicenseText - specifies is the resolved license will include the entire text of the license

Returns:

a LicenseChoice object if resolution was successful, or null if unresolved

resolve

public static LicenseChoice resolve(String licenseString,
                                    LicenseResolver.LicenseTextSettings licenseTextSettings)

Attempts to resolve the specified license string via SPDX license identifier and expression parsing first. If SPDX resolution is not successful, the method will attempt fuzzy matching.

Parameters:

licenseString - the license string to resolve

licenseTextSettings - specifies settings regarding the entire text of the resolved license

Returns:

a LicenseChoice object if resolution was successful, or null if unresolved