Package com.atlassian.bamboo.clover.build.coverage

Interface ReportProvider

All Known Implementing Classes:
CloverReportLinker
public interface ReportProvider
Provides links and meta-data about Clover reports

  • Method Summary

    Modifier and Type
    Method
    Description
    ImmutableResultsSummary
    getBuildResultsSummary()
    Returns build results
    @NotNull Collection<Artifact>
    getCloverArtifacts()
    Returns a list of artifacts (shared and local) containing Clover HTML report.
    @Nullable String
    getCloverReportUrl()
    Deprecated.
    since 5.7 use #getCloverArtifacts() and #getCloverReportUrl(Artifact) to handle more than one report in a build
    @Nullable String
    getCloverReportUrl(@NotNull Artifact artifact)
    Returns URL of the given report artifact.
    @NotNull String
    getTimestamp()
    Deprecated.
    since 5.7 use #getCloverArtifacts() and #getTimestamp(Artifact) to handle more than one report in a build
    @NotNull String
    getTimestamp(@NotNull Artifact artifact)
    Deprecated.
    use #getCloverArtifacts() and #getTimestamp(Artifact) to handle more than one report in a build
    boolean
    isCloverAdgReport(@NotNull Artifact artifact)
    Returns true if given artifact contains Clover's HTML report in ADG style (introduced in Clover 4)
    boolean
    isCloverReport(@NotNull Artifact artifact)
    Returns true if given artifact contains Clover's HTML report.

  • Method Details

    • getCloverArtifacts

      @NotNull @NotNull Collection<Artifact> getCloverArtifacts()
      Returns a list of artifacts (shared and local) containing Clover HTML report.
      Returns:
      Collection<Artifact> list of reports or empty list

    • getCloverReportUrl

      @Nullable @Deprecated @Nullable String getCloverReportUrl()
      Deprecated.
      since 5.7 use #getCloverArtifacts() and #getCloverReportUrl(Artifact) to handle more than one report in a build
      Return URL of the Clover's HTML report artifact from a build. In case when build contains many Clover reports, a first found will be returned.
      Returns:
      String URL to Clover report or null if not exists

    • getCloverReportUrl

      @Nullable @Nullable String getCloverReportUrl(@NotNull @NotNull Artifact artifact)
      Returns URL of the given report artifact.
      Returns:
      String artifact URL or null if not exists

    • getTimestamp

      @Deprecated @NotNull @NotNull String getTimestamp()
      Deprecated.
      since 5.7 use #getCloverArtifacts() and #getTimestamp(Artifact) to handle more than one report in a build
      Returns timestamp of the Clover's HTML report artifact from a build. In case when build contains many Clover reports, a first found will be returned. If there are no Clover reports in build it returns empty string.
      Returns:
      String timestamp of Clover report or "" if not found

    • getTimestamp

      @Deprecated @NotNull @NotNull String getTimestamp(@NotNull @NotNull Artifact artifact)
      Deprecated.
      use #getCloverArtifacts() and #getTimestamp(Artifact) to handle more than one report in a build
      Returns timestamp of the given report artifact.
      Returns:
      String timestamp of Clover report or "" if not found

    • getBuildResultsSummary

      ImmutableResultsSummary getBuildResultsSummary()
      Returns build results
      Returns:
      ImmutableResultsSummary

    • isCloverReport

      boolean isCloverReport(@NotNull @NotNull Artifact artifact)
      Returns true if given artifact contains Clover's HTML report.
      Parameters:
      artifact - artifact to check
      Returns:
      boolean

    • isCloverAdgReport

      boolean isCloverAdgReport(@NotNull @NotNull Artifact artifact)
      Returns true if given artifact contains Clover's HTML report in ADG style (introduced in Clover 4)
      Parameters:
      artifact - artifact to check
      Returns:
      boolean