org.sonar.api.measures

Class RuleMeasure

java.lang.Object

org.sonar.api.measures.Measure

org.sonar.api.measures.RuleMeasure

public class RuleMeasure
extends Measure

Since:

1.10

Field Summary

Fields inherited from class org.sonar.api.measures.Measure

alertStatus, alertText, characteristic, data, date, DEFAULT_PRECISION, description, MAX_TEXT_SIZE, metric, metricKey, persistenceMode, personId, requirement, tendency, url, value, variation1, variation2, variation3, variation4, variation5

Constructor Summary

Constructors

Constructor and Description
RuleMeasure(Metric metric, Rule rule, RulePriority rulePriority, Integer ruleCategory) This constructor is for internal use only.

Method Summary

Methods

Modifier and Type	Method and Description
static RuleMeasure	createForCategory(Metric metric, Integer category, Double value) Deprecated. since 2.5. See SONAR-2007.
static RuleMeasure	createForPriority(Metric metric, RulePriority priority, Double value)
static RuleMeasure	createForRule(Metric metric, Rule rule, Double value)
boolean	equals(Object obj)
Rule	getRule()
Integer	getRuleCategory() Deprecated. since 2.5. See SONAR-2007.
RulePriority	getRulePriority() Deprecated. since 2.14 use getSeverity() instead. See SONAR-1829.
RulePriority	getSeverity()
int	hashCode()
RuleMeasure	setRule(Rule rule)
void	setRuleCategory(Integer ruleCategory) Deprecated. since 2.5. See SONAR-2007.
RuleMeasure	setRulePriority(RulePriority rulePriority) Deprecated. since 2.14 use setSeverity(org.sonar.api.rules.RulePriority) instead. See SONAR-1829.
RuleMeasure	setSeverity(RulePriority severity)
RuleMeasure	setValue(Double v) Sets the measure value with the default precision of 1
String	toString()

Methods inherited from class org.sonar.api.measures.Measure

getAlertStatus, getAlertText, getCharacteristic, getData, getDataAsLevel, getDate, getDescription, getId, getIntValue, getMetric, getMetricKey, getPersistenceMode, getPersonId, getRequirement, getTendency, getUrl, getValue, getVariation, getVariation1, getVariation2, getVariation3, getVariation4, getVariation5, hasData, isBestValue, setAlertStatus, setAlertText, setCharacteristic, setData, setData, setDate, setDescription, setId, setIntValue, setMetric, setPersistenceMode, setPersonId, setRequirement, setTendency, setUrl, setValue, setVariation, setVariation1, setVariation2, setVariation3, setVariation4, setVariation5, unsetData

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RuleMeasure

public RuleMeasure(Metric metric,
           @Nullable
           Rule rule,
           @Nullable
           RulePriority rulePriority,
           @Nullable
           Integer ruleCategory)

This constructor is for internal use only. Please use static methods createForXXX().

Method Detail

getRule

public Rule getRule()

setRule

public RuleMeasure setRule(Rule rule)

getRulePriority

@Deprecated
public RulePriority getRulePriority()

Deprecated. since 2.14 use getSeverity() instead. See SONAR-1829.

getSeverity

public RulePriority getSeverity()

Since:

2.14

setRulePriority

@Deprecated
public RuleMeasure setRulePriority(RulePriority rulePriority)

Deprecated. since 2.14 use setSeverity(org.sonar.api.rules.RulePriority) instead. See SONAR-1829.

setSeverity

public RuleMeasure setSeverity(RulePriority severity)

Since:

2.14

getRuleCategory

@Deprecated
public Integer getRuleCategory()

Deprecated. since 2.5. See SONAR-2007.

setRuleCategory

@Deprecated
public void setRuleCategory(Integer ruleCategory)

Deprecated. since 2.5. See SONAR-2007.

equals

public boolean equals(Object obj)

Overrides:

equals in class Measure

setValue

public RuleMeasure setValue(@Nullable
                   Double v)

Description copied from class: Measure

Sets the measure value with the default precision of 1

Overrides:

setValue in class Measure

Parameters:

v - the measure value

Returns:

the measure object instance

hashCode

public int hashCode()

Overrides:

hashCode in class Measure

toString

public String toString()

Overrides:

toString in class Measure

createForRule

public static RuleMeasure createForRule(Metric metric,
                        Rule rule,
                        @Nullable
                        Double value)

createForPriority

public static RuleMeasure createForPriority(Metric metric,
                            RulePriority priority,
                            @Nullable
                            Double value)

createForCategory

@Deprecated
public static RuleMeasure createForCategory(Metric metric,
                                       Integer category,
                                       @Nullable
                                       Double value)

Deprecated. since 2.5. See SONAR-2007.