Package io.jenkins.plugins.analysis.core.util

Class WarningsQualityGate

java.lang.Object

hudson.model.AbstractDescribableImpl<io.jenkins.plugins.util.QualityGate>

io.jenkins.plugins.util.QualityGate

io.jenkins.plugins.analysis.core.util.WarningsQualityGate

All Implemented Interfaces:

Describable<io.jenkins.plugins.util.QualityGate>, Serializable

public class WarningsQualityGate
extends io.jenkins.plugins.util.QualityGate

Defines a quality gate based on a specific threshold of issues (total, new, delta) 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:

Ullrich Hafner

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WarningsQualityGate.QualityGateType	Available quality gate types.
static class	WarningsQualityGate.WarningsQualityGateDescriptor	Descriptor of the WarningsQualityGate.

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
WarningsQualityGate(int threshold, WarningsQualityGate.QualityGateType type, io.jenkins.plugins.util.QualityGate.QualityGateCriticality criticality)	Creates a new instance of WarningsQualityGate.
WarningsQualityGate(WarningsQualityGate.QualityGateType type)	Creates a new instance of WarningsQualityGate.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Function<IssuesStatistics,Integer>	getActualSizeMethodReference()	Returns the method that should be used to determine the actual number of issues in the build.
String	getName()
WarningsQualityGate.QualityGateType	getType()
int	hashCode()
boolean	isUnstable()
void	setUnstable(boolean unstable)	Deprecated. use QualityGate.setCriticality(QualityGateCriticality) instead

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, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

WarningsQualityGate

@DataBoundConstructor
public WarningsQualityGate(WarningsQualityGate.QualityGateType type)

Creates a new instance of WarningsQualityGate.

Parameters:

type - the type of the quality gate

WarningsQualityGate

public WarningsQualityGate(int threshold,
 WarningsQualityGate.QualityGateType type,
 io.jenkins.plugins.util.QualityGate.QualityGateCriticality criticality)

Creates a new instance of WarningsQualityGate.

Parameters:

threshold - the minimum number of issues that fails the quality gate

type - the type of the quality gate

criticality - the criticality of the quality gate

Method Details

isUnstable

public boolean isUnstable()

setUnstable

@DataBoundSetter
@Deprecated
public void setUnstable(boolean unstable)

Deprecated.

use QualityGate.setCriticality(QualityGateCriticality) instead

Sets the criticality of the quality gate.

Parameters:

unstable - the criticality of the quality gate

getActualSizeMethodReference

public Function<IssuesStatistics,Integer> getActualSizeMethodReference()

Returns the method that should be used to determine the actual number of issues in the build.

Returns:

threshold getter

getName

public String getName()

Specified by:

getName in class io.jenkins.plugins.util.QualityGate

getType

public WarningsQualityGate.QualityGateType getType()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object