Package com.atlassian.bitbucket.codeinsights.coverage

Interface CodeCoverageCallback

@ParametersAreNonnullByDefault public interface CodeCoverageCallback
Describes a callback for supplying code coverage information for a file path. The callers of this class must call the following methods in the following order:
  • onFileStart
  • onRange (repeat for each range)
  • onFileEnd
Since:
6.8

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    onFileEnd()
    Called just after streaming the coverage report for a file.
    void
    onFileStart(String reportKey, String fileCoverageUrl, String path)
    Called just before streaming the coverage report for a file.
    void
    onRange(CodeCoverage codeCoverage)
    Called just before streaming the coverage report for a given range.

  • Method Details

    • onFileEnd

      void onFileEnd()
      Called just after streaming the coverage report for a file.

    • onFileStart

      void onFileStart(String reportKey, String fileCoverageUrl, String path)
      Called just before streaming the coverage report for a file.
      Parameters:
      reportKey - a key identifying the coverage report
      fileCoverageUrl - a URL with a link back to the reporter that produced the coverage report for a given file
      path - full path of the file

    • onRange

      void onRange(CodeCoverage codeCoverage)
      Called just before streaming the coverage report for a given range.
      Parameters:
      codeCoverage - coverage report for the file