Package org.ossreviewtoolkit.model
Class ScanResult
-
- All Implemented Interfaces:
public final class ScanResultThe result of a single scan of a single package.
-
-
Field Summary
Fields Modifier and Type Field Description private final Provenanceprovenanceprivate final ScannerDetailsscannerprivate final ScanSummarysummaryprivate final Map<String, String>additionalData
-
Constructor Summary
Constructors Constructor Description ScanResult(Provenance provenance, ScannerDetails scanner, ScanSummary summary, Map<String, String> additionalData)
-
Method Summary
Modifier and Type Method Description final ProvenancegetProvenance()Provenance information about the scanned source code. final ScannerDetailsgetScanner()Details about the used scanner. final ScanSummarygetSummary()A summary of the scan results. final Map<String, String>getAdditionalData()A map for scanner specific data that cannot be mapped into any generalized property, but still needs to be stored in the scan result. final ScanResultfilterByPath(String path)Filter all detected licenses and copyrights from the summary which are underneath path, and set the path for provenance. final ScanResultfilterByIgnorePatterns(Collection<String> ignorePatterns)Return a ScanResult whose summary contains only findings whose location / path is not matched by any glob expression in ignorePatterns. -
-
Constructor Detail
-
ScanResult
ScanResult(Provenance provenance, ScannerDetails scanner, ScanSummary summary, Map<String, String> additionalData)
-
-
Method Detail
-
getProvenance
final Provenance getProvenance()
Provenance information about the scanned source code.
-
getScanner
final ScannerDetails getScanner()
Details about the used scanner.
-
getSummary
final ScanSummary getSummary()
A summary of the scan results.
-
getAdditionalData
final Map<String, String> getAdditionalData()
A map for scanner specific data that cannot be mapped into any generalized property, but still needs to be stored in the scan result.
-
filterByPath
final ScanResult filterByPath(String path)
Filter all detected licenses and copyrights from the summary which are underneath path, and set the path for provenance. Findings which RootLicenseMatcher assigns as root license files for path are also kept.
-
filterByIgnorePatterns
final ScanResult filterByIgnorePatterns(Collection<String> ignorePatterns)
Return a ScanResult whose summary contains only findings whose location / path is not matched by any glob expression in ignorePatterns.
-
-
-
-