Package io.jenkins.plugins.coverage.metrics.steps

Class CoverageQualityGate

java.lang.Object
hudson.model.AbstractDescribableImpl<io.jenkins.plugins.util.QualityGate>
io.jenkins.plugins.util.QualityGate
io.jenkins.plugins.coverage.metrics.steps.CoverageQualityGate
All Implemented Interfaces:
Describable<io.jenkins.plugins.util.QualityGate>, Serializable
public class CoverageQualityGate extends io.jenkins.plugins.util.QualityGate
Defines a quality gate based on a specific threshold of code coverage in the current build. After a build has been finished, a set of quality gates will be evaluated and the overall quality gate status will be reported in Jenkins UI.
Author:
Johannes Walter
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    CoverageQualityGate.Descriptor
    Descriptor of the CoverageQualityGate.

    Nested classes/interfaces inherited from class io.jenkins.plugins.util.QualityGate

    io.jenkins.plugins.util.QualityGate.QualityGateCriticality, io.jenkins.plugins.util.QualityGate.QualityGateDescriptor

  • Constructor Summary

    Constructors
    Constructor
    Description
    CoverageQualityGate(edu.hm.hafner.coverage.Metric metric)
    Creates a new instance of CoverageQualityGate.

  • Method Summary

    Modifier and Type
    Method
    Description
    Baseline
    getBaseline()
     
    edu.hm.hafner.coverage.Metric
    getMetric()
     
    String
    getName()
    Returns a human-readable name of the quality gate.
    final void
    setBaseline(Baseline baseline)
    Sets the baseline that will be used for the quality gate evaluation.

    Methods inherited from class io.jenkins.plugins.util.QualityGate

    getCriticality, getIntegerThreshold, getStatus, getThreshold, setCriticality, setIntegerThreshold, setThreshold, toString

    Methods inherited from class hudson.model.AbstractDescribableImpl

    getDescriptor

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • CoverageQualityGate

      @DataBoundConstructor public CoverageQualityGate(edu.hm.hafner.coverage.Metric metric)
      Creates a new instance of CoverageQualityGate.
      Parameters:
      metric - the metric to compare

  • Method Details

    • setBaseline

      @DataBoundSetter public final void setBaseline(Baseline baseline)
      Sets the baseline that will be used for the quality gate evaluation.
      Parameters:
      baseline - the baseline to use

    • getName

      public String getName()
      Returns a human-readable name of the quality gate.
      Specified by:
      getName in class io.jenkins.plugins.util.QualityGate
      Returns:
      a human-readable name

    • getMetric

      public edu.hm.hafner.coverage.Metric getMetric()

    • getBaseline

      public Baseline getBaseline()