org.sonar.api.ce.posttask

Interface QualityGate.Condition

Enclosing interface:

QualityGate

public static interface QualityGate.Condition

Method Summary

Modifier and Type	Method and Description
String	getErrorThreshold() At least one of getErrorThreshold() and getWarningThreshold() is guaranteed to be non null.
String	getMetricKey() The key of the metric this condition has been evaluated on.
QualityGate.Operator	getOperator() The operator used to evaluate the error and/or warning thresholds against the value of the measure
QualityGate.EvaluationStatus	getStatus() Evaluation status of this condition
String	getValue() The value of the measure.
String	getWarningThreshold() At least one of getErrorThreshold() and getWarningThreshold() is guaranteed to be non null.
boolean	isOnLeakPeriod() Whether this condition is defined on the leak period or on an absolute value

Method Detail

getStatus

QualityGate.EvaluationStatus getStatus()

Evaluation status of this condition

getMetricKey

String getMetricKey()

The key of the metric this condition has been evaluated on.

The Metric for the returned key can be retrieved using a MetricFinder instance.

See Also:

MetricFinder.findByKey(String)

getOperator

QualityGate.Operator getOperator()

The operator used to evaluate the error and/or warning thresholds against the value of the measure

getErrorThreshold

@CheckForNull
String getErrorThreshold()

At least one of getErrorThreshold() and getWarningThreshold() is guaranteed to be non null.

See Also:

getWarningThreshold()

getWarningThreshold

@CheckForNull
String getWarningThreshold()

At least one of getErrorThreshold() and getWarningThreshold() is guaranteed to be non null.

See Also:

getErrorThreshold()

isOnLeakPeriod

boolean isOnLeakPeriod()

Whether this condition is defined on the leak period or on an absolute value

getValue

String getValue()

The value of the measure.

If the type of the metric (which key is provided by getMetricKey()) is numerical, the value can be parsed using Integer.valueOf(String), Long.valueOf(String) or Double.valueOf(String).

Throws:

IllegalStateException - if getStatus() is QualityGate.EvaluationStatus.NO_VALUE

See Also:

Metric.getType()