Package io.jenkins.plugins.util

Class QualityGateResult

java.lang.Object

io.jenkins.plugins.util.QualityGateResult

All Implemented Interfaces:

Serializable

public class QualityGateResult
extends Object
implements Serializable

Result of a quality gate evaluation. Aggregates the individual results of the quality gates into an overall status.

Author:

Ullrich Hafner

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QualityGateResult.QualityGateItemApi	Remote API to show the content of an individual quality gate item.
static class	QualityGateResult.QualityGateResultApi	Remote API to list the overview of the quality gate evaluation.
static class	QualityGateResult.QualityGateResultItem	Represents a single item of the quality gate results.

Constructor Summary

Constructors

Constructor	Description
QualityGateResult()	Creates a new instance of QualityGateResult that has its overall status set to QualityGateStatus.INACTIVE.
QualityGateResult(QualityGateStatus overallStatus)	Creates a new instance of QualityGateResult with the specified overall status.

Method Summary

Modifier and Type	Method	Description
void	add(QualityGate qualityGate, QualityGateStatus actualStatus, String actualValue)	Adds another quality gate result to the aggregated result.
Collection<String>	getMessages()
QualityGateStatus	getOverallStatus()
List<QualityGateResult.QualityGateResultItem>	getResultItems()
boolean	isInactive()
boolean	isSuccessful()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

QualityGateResult

public QualityGateResult()

Creates a new instance of QualityGateResult that has its overall status set to QualityGateStatus.INACTIVE.

QualityGateResult

public QualityGateResult(QualityGateStatus overallStatus)

Creates a new instance of QualityGateResult with the specified overall status.

Parameters:

overallStatus - the overall status of all quality gates

Method Details

add

public void add(QualityGate qualityGate,
 QualityGateStatus actualStatus,
 String actualValue)

Adds another quality gate result to the aggregated result.

Parameters:

qualityGate - the quality gate that has been evaluated

actualStatus - the status of the quality gate

actualValue - the value that has been evaluated against the quality gate threshold

getResultItems

public List<QualityGateResult.QualityGateResultItem> getResultItems()

getOverallStatus

public QualityGateStatus getOverallStatus()

isSuccessful

public boolean isSuccessful()

isInactive

public boolean isInactive()

getMessages

public Collection<String> getMessages()

toString

public String toString()

Overrides:

toString in class Object