Constructor Detail

• ScanSummary

  ScanSummary(Instant startTime, Instant endTime, Set<LicenseFinding> licenseFindings, Set<CopyrightFinding> copyrightFindings, Set<SnippetFinding> snippetFindings, List<Issue> issues)

Method Detail

• getLicenses

   final Set<SpdxExpression> getLicenses()

• getStartTime

   final Instant getStartTime()

  The time when the scan started.

• getEndTime

   final Instant getEndTime()

  The time when the scan finished.

• getLicenseFindings

   final Set<LicenseFinding> getLicenseFindings()

  The detected license findings.

• getCopyrightFindings

   final Set<CopyrightFinding> getCopyrightFindings()

  The detected copyright findings.

• getSnippetFindings

   final Set<SnippetFinding> getSnippetFindings()

  The detected snippet findings.

• getIssues

   final List<Issue> getIssues()

  The list of issues that occurred during the scan. This property is not serialized if the list is empty to reduce the size of the result file.

• filterByPath

   final ScanSummary filterByPath(String path)

  Filter all detected licenses and copyrights from this ScanSummary which are underneath path. Findings which RootLicenseMatcher assigns as root license files for path are also kept.

• filterByPaths

   final ScanSummary filterByPaths(Collection<String> paths)

  Filter all detected licenses and copyrights from this ScanSummary which are underneath the given paths. Findings which RootLicenseMatcher assigns as root license files for path in paths are also kept.

• filterByIgnorePatterns

   final ScanSummary filterByIgnorePatterns(Collection<String> ignorePatterns)

  Return a ScanSummary which contains only findings whose location / path is not matched by any glob expression in ignorePatterns.