Class ResolvedLicenseFile
-
- All Implemented Interfaces:
public final class ResolvedLicenseFileInformation about a single resolved license file.
-
-
Field Summary
Fields Modifier and Type Field Description private final Stringtextprivate final Provenanceprovenanceprivate final List<ResolvedLicense>licensesprivate final Stringpathprivate final Filefile
-
Constructor Summary
Constructors Constructor Description ResolvedLicenseFile(Provenance provenance, List<ResolvedLicense> licenses, String path, File file)
-
Method Summary
Modifier and Type Method Description final StringgetText()The textual content of the license file. final ProvenancegetProvenance()The Provenance of the license file. final List<ResolvedLicense>getLicenses()The ResolvedLicenses detected in this file. final StringgetPath()The path of the license file relative to the provenance. final FilegetFile()The unarchived license file. final Set<String>getCopyrights(Boolean process, Boolean omitExcluded)Return all copyright statements associated to the licenses found in this license file. final Set<String>getCopyrights(Boolean process)Return all copyright statements associated to the licenses found in this license file. final Set<String>getCopyrights()Return all copyright statements associated to the licenses found in this license file. -
-
Constructor Detail
-
ResolvedLicenseFile
ResolvedLicenseFile(Provenance provenance, List<ResolvedLicense> licenses, String path, File file)
-
-
Method Detail
-
getText
final String getText()
The textual content of the license file.
-
getProvenance
final Provenance getProvenance()
The Provenance of the license file.
-
getLicenses
final List<ResolvedLicense> getLicenses()
The ResolvedLicenses detected in this file. Contains the whole resolved license including license and copyright locations found in other files with the same provenance.
-
getPath
final String getPath()
The path of the license file relative to the provenance.
-
getCopyrights
@JvmOverloads() final Set<String> getCopyrights(Boolean process, Boolean omitExcluded)
Return all copyright statements associated to the licenses found in this license file. Copyright findings that are excluded by PathExcludes are omitted by default. The copyright statements are by default reprocessed using the CopyrightStatementsProcessor.
-
getCopyrights
@JvmOverloads() final Set<String> getCopyrights(Boolean process)
Return all copyright statements associated to the licenses found in this license file. Copyright findings that are excluded by PathExcludes are omitted by default. The copyright statements are by default reprocessed using the CopyrightStatementsProcessor.
-
getCopyrights
@JvmOverloads() final Set<String> getCopyrights()
Return all copyright statements associated to the licenses found in this license file. Copyright findings that are excluded by PathExcludes are omitted by default. The copyright statements are by default reprocessed using the CopyrightStatementsProcessor.
-
-
-
-