Class Findings
-
- All Implemented Interfaces:
public final class FindingsA collection of license and copyright findings detected in the source code located at provenance.
-
-
Field Summary
Fields Modifier and Type Field Description private final Provenanceprovenanceprivate final Set<LicenseFinding>licensesprivate final Set<CopyrightFinding>copyrightsprivate final List<LicenseFindingCuration>licenseFindingCurationsprivate final List<PathExclude>pathExcludesprivate final StringrelativeFindingsPath
-
Constructor Summary
Constructors Constructor Description Findings(Provenance provenance, Set<LicenseFinding> licenses, Set<CopyrightFinding> copyrights, List<LicenseFindingCuration> licenseFindingCurations, List<PathExclude> pathExcludes, String relativeFindingsPath)
-
Method Summary
Modifier and Type Method Description final ProvenancegetProvenance()The Provenance of the scanned source code. final Set<LicenseFinding>getLicenses()The set of all license findings. final Set<CopyrightFinding>getCopyrights()The set of all copyright findings. final List<LicenseFindingCuration>getLicenseFindingCurations()The list of all license finding curations that apply to this provenance. final List<PathExclude>getPathExcludes()The list of all path excludes that apply to this provenance. final StringgetRelativeFindingsPath()The root path of the locations of the licenses and copyrights relative to the paths used in the licenseFindingCurations and pathExcludes. -
-
Constructor Detail
-
Findings
Findings(Provenance provenance, Set<LicenseFinding> licenses, Set<CopyrightFinding> copyrights, List<LicenseFindingCuration> licenseFindingCurations, List<PathExclude> pathExcludes, String relativeFindingsPath)
-
-
Method Detail
-
getProvenance
final Provenance getProvenance()
The Provenance of the scanned source code.
-
getLicenses
final Set<LicenseFinding> getLicenses()
The set of all license findings.
-
getCopyrights
final Set<CopyrightFinding> getCopyrights()
The set of all copyright findings.
-
getLicenseFindingCurations
final List<LicenseFindingCuration> getLicenseFindingCurations()
The list of all license finding curations that apply to this provenance.
-
getPathExcludes
final List<PathExclude> getPathExcludes()
The list of all path excludes that apply to this provenance.
-
getRelativeFindingsPath
final String getRelativeFindingsPath()
The root path of the locations of the licenses and copyrights relative to the paths used in the licenseFindingCurations and pathExcludes. An empty string, if all refer to the same root path.
The roots can be different in case of projects inside nested repositories (see Repository.nestedRepositories), where the license and copyright finding locations are relative to the nested repository, but the licenseFindingCurations and pathExcludes are relative to the root repository, because they are configured in the RepositoryConfiguration of the root repository.
-
-
-
-