org.sonar.api.profiles

Class Alert

java.lang.Object

org.sonar.api.database.BaseIdentifiable

org.sonar.api.profiles.Alert

All Implemented Interfaces:

Cloneable

public class Alert
extends BaseIdentifiable
implements Cloneable

Class to map alerts with hibernate model

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPERATOR_EQUALS Operator equals
static String	OPERATOR_GREATER Operator strictly greater than
static String	OPERATOR_NOT_EQUALS Operator not equals
static String	OPERATOR_SMALLER Operator strictly lesser than

Constructor Summary

Constructors

Constructor and Description
Alert() Default constructor
Alert(RulesProfile rulesProfile, Metric metric, String operator, String valueError, String valueWarning) Creates an alert
Alert(RulesProfile rulesProfile, Metric metric, String operator, String valueError, String valueWarning, Integer period) Creates an alert

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone()
String	getAlertLabel(Metric.Level level) Deprecated. since 3.4 because it does not manage alerts with variation
Metric	getMetric()
String	getOperator()
Integer	getPeriod()
RulesProfile	getRulesProfile()
String	getValueError()
String	getValueWarning()
boolean	isEqualsOperator()
boolean	isGreaterOperator()
boolean	isNotEqualsOperator()
boolean	isSmallerOperator()
void	setMetric(Metric metric) Sets the alert metric
void	setOperator(String operator) Sets the alert operator
void	setPeriod(Integer period) Sets the period if any
void	setRulesProfile(RulesProfile rulesProfile) Sets the alert profile
void	setValueError(String valueError) Sets the error value if any
void	setValueWarning(String valueWarning) Sets the warning value if any

Methods inherited from class org.sonar.api.database.BaseIdentifiable

getId, setId

Methods inherited from class java.lang.Object

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

Field Detail

OPERATOR_GREATER

public static final String OPERATOR_GREATER

Operator strictly greater than

See Also:

Constant Field Values

OPERATOR_SMALLER

public static final String OPERATOR_SMALLER

Operator strictly lesser than

See Also:

Constant Field Values

OPERATOR_EQUALS

public static final String OPERATOR_EQUALS

Operator equals

See Also:

Constant Field Values

OPERATOR_NOT_EQUALS

public static final String OPERATOR_NOT_EQUALS

Operator not equals

See Also:

Constant Field Values

Constructor Detail

Alert

public Alert()

Default constructor

Alert

public Alert(RulesProfile rulesProfile,
     Metric metric,
     String operator,
     String valueError,
     String valueWarning)

Creates an alert

Parameters:

rulesProfile - the profile used to trigger the alert

metric - the metric tested for the alert

operator - the operator defined

valueError - the error value

valueWarning - the warning value

Alert

public Alert(RulesProfile rulesProfile,
     Metric metric,
     String operator,
     String valueError,
     String valueWarning,
     Integer period)

Creates an alert

Parameters:

rulesProfile - the profile used to trigger the alert

metric - the metric tested for the alert

operator - the operator defined

valueError - the error value

valueWarning - the warning value

Method Detail

getRulesProfile

public RulesProfile getRulesProfile()

Returns:

the alert profile

setRulesProfile

public void setRulesProfile(RulesProfile rulesProfile)

Sets the alert profile

getMetric

public Metric getMetric()

Returns:

the alert metric

setMetric

public void setMetric(Metric metric)

Sets the alert metric

getOperator

public String getOperator()

Returns:

the alert operator

setOperator

public void setOperator(String operator)

Sets the alert operator

getValueError

public String getValueError()

Returns:

the error value

setValueError

public void setValueError(String valueError)

Sets the error value if any

getValueWarning

public String getValueWarning()

Returns:

the warning value

setValueWarning

public void setValueWarning(String valueWarning)

Sets the warning value if any

getPeriod

public Integer getPeriod()

Returns:

the period

setPeriod

public void setPeriod(Integer period)

Sets the period if any

isGreaterOperator

public boolean isGreaterOperator()

Returns:

whether the operator is greater than

isSmallerOperator

public boolean isSmallerOperator()

Returns:

whether the operator is lesser than

isEqualsOperator

public boolean isEqualsOperator()

Returns:

whether the operator is equals

isNotEqualsOperator

public boolean isNotEqualsOperator()

Returns:

whether the operator is not equals

getAlertLabel

@Deprecated
public String getAlertLabel(Metric.Level level)

Deprecated. since 3.4 because it does not manage alerts with variation

clone

public Object clone()

Overrides:

clone in class Object