Class ResolvedLicense
-
- All Implemented Interfaces:
public final class ResolvedLicenseResolved information for a single license.
-
-
Field Summary
Fields Modifier and Type Field Description private final Set<LicenseSource>sourcesprivate final BooleanisDetectedExcludedprivate final SpdxSingleLicenseExpressionlicenseprivate final Set<String>originalDeclaredLicensesprivate final Set<ResolvedOriginalExpression>originalExpressionsprivate final Set<ResolvedLicenseLocation>locations
-
Constructor Summary
Constructors Constructor Description ResolvedLicense(SpdxSingleLicenseExpression license, Set<String> originalDeclaredLicenses, Set<ResolvedOriginalExpression> originalExpressions, Set<ResolvedLicenseLocation> locations)
-
Method Summary
Modifier and Type Method Description final Set<LicenseSource>getSources()The sources where this license was found. final BooleanisDetectedExcluded()True, if this license was detected and all locations have matching path excludes. final SpdxSingleLicenseExpressiongetLicense()The license. final Set<String>getOriginalDeclaredLicenses()The set of original declared license that were processed to this license, or an empty list, if this license was not modified during processing. final Set<ResolvedOriginalExpression>getOriginalExpressions()The original SPDX expressions of this license. final Set<ResolvedLicenseLocation>getLocations()All text locations where this license was found. final List<ResolvedCopyright>getResolvedCopyrights(Boolean process, Boolean omitExcluded)Return all resolved copyrights for this license. final Set<String>getCopyrights(Boolean process, Boolean omitExcluded)Return all copyright statements associated to this license. final Set<String>getCopyrights(Boolean process)Return all copyright statements associated to this license. final Set<String>getCopyrights()Return all copyright statements associated to this license. final ResolvedLicensefilterExcludedCopyrights()Filter all excluded copyrights. final ResolvedLicensefilterExcludedOriginalExpressions()Filter all excluded original expressions. -
-
Constructor Detail
-
ResolvedLicense
ResolvedLicense(SpdxSingleLicenseExpression license, Set<String> originalDeclaredLicenses, Set<ResolvedOriginalExpression> originalExpressions, Set<ResolvedLicenseLocation> locations)
-
-
Method Detail
-
getSources
final Set<LicenseSource> getSources()
The sources where this license was found.
-
isDetectedExcluded
final Boolean isDetectedExcluded()
-
getLicense
final SpdxSingleLicenseExpression getLicense()
The license.
-
getOriginalDeclaredLicenses
final Set<String> getOriginalDeclaredLicenses()
The set of original declared license that were processed to this license, or an empty list, if this license was not modified during processing.
-
getOriginalExpressions
final Set<ResolvedOriginalExpression> getOriginalExpressions()
The original SPDX expressions of this license.
-
getLocations
final Set<ResolvedLicenseLocation> getLocations()
All text locations where this license was found.
-
getResolvedCopyrights
final List<ResolvedCopyright> getResolvedCopyrights(Boolean process, Boolean omitExcluded)
Return all resolved copyrights for this license. Copyright findings that are excluded by PathExcludes are omitted by default. The copyrights are processed by default using the CopyrightStatementsProcessor.
-
getCopyrights
@JvmOverloads() final Set<String> getCopyrights(Boolean process, Boolean omitExcluded)
Return all copyright statements associated to this license. Copyright findings that are excluded by PathExcludes are omitted by default. The copyrights are processed by default using the CopyrightStatementsProcessor.
-
getCopyrights
@JvmOverloads() final Set<String> getCopyrights(Boolean process)
Return all copyright statements associated to this license. Copyright findings that are excluded by PathExcludes are omitted by default. The copyrights are processed by default using the CopyrightStatementsProcessor.
-
getCopyrights
@JvmOverloads() final Set<String> getCopyrights()
Return all copyright statements associated to this license. Copyright findings that are excluded by PathExcludes are omitted by default. The copyrights are processed by default using the CopyrightStatementsProcessor.
-
filterExcludedCopyrights
final ResolvedLicense filterExcludedCopyrights()
Filter all excluded copyrights. Copyrights which have matching path excludes are removed.
-
filterExcludedOriginalExpressions
final ResolvedLicense filterExcludedOriginalExpressions()
Filter all excluded original expressions. Detected license findings which have matching path excludes are removed. If the resolved license becomes empty, then null is returned.
-
-
-
-