Enum Class Baseline

java.lang.Object
java.lang.Enum<Baseline>
io.jenkins.plugins.coverage.metrics.model.Baseline
All Implemented Interfaces:
Serializable, Comparable<Baseline>, Constable

public enum Baseline extends Enum<Baseline>
The baseline for the code coverage computation.
  • Enum Constant Details

    • PROJECT

      public static final Baseline PROJECT
      Coverage of the whole project. This is an absolute value that might not change much from build to build.
    • PROJECT_DELTA

      public static final Baseline PROJECT_DELTA
      Difference between the project coverages of the current build and the reference build. Teams can use this delta value to ensure that the coverage will not decrease.
    • MODIFIED_LINES

      public static final Baseline MODIFIED_LINES
      Coverage of the modified lines (e.g., within the modified lines of a pull or merge request) will focus on new or modified code only.
    • MODIFIED_LINES_DELTA

      public static final Baseline MODIFIED_LINES_DELTA
      Difference between the project coverage and the modified lines coverage of the current build. Teams can use this delta value to ensure that the coverage of pull requests is better than the whole project coverage.
    • MODIFIED_FILES

      public static final Baseline MODIFIED_FILES
      Coverage of the modified files (e.g., within the files that have been touched in a pull or merge request) will focus on new or modified code only.
    • MODIFIED_FILES_DELTA

      public static final Baseline MODIFIED_FILES_DELTA
      Difference between the project coverage and the modified file coverage of the current build. Teams can use this delta value to ensure that the coverage of pull requests is better than the whole project coverage.
    • INDIRECT

      public static final Baseline INDIRECT
      Indirect changes of the overall code coverage that are not part of the changed code. These changes might occur if new tests are added without touching the underlying code under test.
  • Method Details

    • values

      public static Baseline[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static Baseline valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • getTitle

      public String getTitle()
    • getUrl

      public String getUrl()
    • getDisplayColors

      public ColorProvider.DisplayColors getDisplayColors(double value, ColorProvider colorProvider)
      Returns the display colors to use render a value of this baseline.
      Parameters:
      value - the value to render
      colorProvider - the color provider to use
      Returns:
      the display colors to use
    • isDelta

      public boolean isDelta()