Class QualityGateEvaluator


  • public class QualityGateEvaluator
    extends Object
    Evaluates a set of quality gates for a static analysis report.
    Author:
    Ullrich Hafner
    • Constructor Detail

      • QualityGateEvaluator

        public QualityGateEvaluator()
    • Method Detail

      • evaluate

        public QualityGateStatus evaluate​(IssuesStatistics report,
                                          QualityGateEvaluator.FormattedLogger logger)
        Enforces this quality gate for the specified run.
        Parameters:
        report - the report to evaluate
        logger - the logger that reports the passed and failed quality gate thresholds
        Returns:
        result of the evaluation, expressed by a build state
      • add

        public void add​(int size,
                        QualityGate.QualityGateType type,
                        QualityGate.QualityGateResult strength)
        Appends the specified quality gates to the end of the list of quality gates.
        Parameters:
        size - the minimum number of issues that fails the quality gate
        type - the type of the quality gate
        strength - determines whether the quality gate is a warning or failure
      • addAll

        public void addAll​(Collection<? extends QualityGate> additionalQualityGates)
        Appends all of the quality gates in the specified collection to the end of the list of quality gates.
        Parameters:
        additionalQualityGates - the quality gates to add
      • isEnabled

        public boolean isEnabled()
        Returns whether at least one quality gate has been added.
        Returns:
        true if at least one quality gate has been added, false otherwise