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

Enum QualityGateStatus

java.lang.Object

java.lang.Enum<QualityGateStatus>

io.jenkins.plugins.analysis.core.util.QualityGateStatus

All Implemented Interfaces:

Serializable, Comparable<QualityGateStatus>

public enum QualityGateStatus
extends Enum<QualityGateStatus>

Result of a QualityGateEvaluator.evaluate(IssuesStatistics, FormattedLogger) call.

Author:

Ullrich Hafner

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAILED	Quality gate has been missed: severity is an error.
INACTIVE	Quality gate is inactive, so result evaluation is not available.
PASSED	Quality gate has been passed.
WARNING	Quality gate has been missed: severity is a warning.

Method Summary

Modifier and Type	Method	Description
BallColor	getColor()	Deprecated. BallColor is not used anymore, build status icons are now rendered on the UI side only
String	getDescription()	Returns the localized description be used in the UI.
String	getIconClass()	Returns the associated Result icon class to be used in the UI.
Result	getResult()	Returns the associated Result.
boolean	isSuccessful()	Returns whether the quality gate has been passed (or has not been activated at all).
boolean	isWorseThan(QualityGateStatus other)	Returns whether this status is worse than the specified status.
static QualityGateStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static QualityGateStatus[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INACTIVE

public static final QualityGateStatus INACTIVE

Quality gate is inactive, so result evaluation is not available.

PASSED

public static final QualityGateStatus PASSED

Quality gate has been passed.

WARNING

public static final QualityGateStatus WARNING

Quality gate has been missed: severity is a warning.

FAILED

public static final QualityGateStatus FAILED

Quality gate has been missed: severity is an error.

Method Detail

values

public static QualityGateStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (QualityGateStatus c : QualityGateStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static QualityGateStatus valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getColor

@Deprecated
public BallColor getColor()

Deprecated.

BallColor is not used anymore, build status icons are now rendered on the UI side only

Returns the associated Result color.

Returns:

Jenkins' Result color

getIconClass

public String getIconClass()

Returns the associated Result icon class to be used in the UI.

Returns:

Jenkins' Result icon class

getDescription

public String getDescription()

Returns the localized description be used in the UI.

Returns:

the localized description

isSuccessful

public boolean isSuccessful()

Returns whether the quality gate has been passed (or has not been activated at all).

Returns:

true if the quality gate has been passed, false otherwise

getResult

public Result getResult()

Returns the associated Result.

Returns:

the associated Result

isWorseThan

public boolean isWorseThan(QualityGateStatus other)

Returns whether this status is worse than the specified status.

Parameters:

other - the other status

Returns:

true if this status is worse than the other status, false otherwise