Measure (sonar-plugin-api 7.2.1 API)

java.lang.Object
- org.sonar.api.measures.Measure<G>

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

RuleMeasure

Deprecated.
since 5.6. To create a new measure on scanner side use SensorContext.newMeasure()
```
@Deprecated
public class Measure<G extends java.io.Serializable>
extends java.lang.Object
implements java.io.Serializable
```
A class to handle measures.

Since:

1.10

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Metric.Level`	`alertStatus` Deprecated.
`protected java.lang.String`	`alertText` Deprecated.
`protected java.lang.String`	`data` Deprecated.
`protected java.util.Date`	`date` Deprecated.
`static int`	`DEFAULT_PRECISION` Deprecated. in 5.3. Decimal scale is provided by metric, not by measure.
`protected java.lang.String`	`description` Deprecated.
`protected static int`	`MAX_TEXT_SIZE` Deprecated.
`protected Metric<G>`	`metric` Deprecated.
`protected java.lang.String`	`metricKey` Deprecated.
`protected java.lang.String`	`url` Deprecated.
`protected java.lang.Double`	`value` Deprecated.
`protected java.lang.Double`	`variation1` Deprecated.
`protected java.lang.Double`	`variation2` Deprecated.
`protected java.lang.Double`	`variation3` Deprecated.
`protected java.lang.Double`	`variation4` Deprecated.
`protected java.lang.Double`	`variation5` Deprecated.

Constructor Summary

Constructors
Constructor and Description
`Measure()` Deprecated. Creates an empty measure
`Measure(Metric metric)` Deprecated. Creates a measure with a metric
`Measure(Metric metric, java.lang.Double value)` Deprecated. Creates a measure with a metric and a value
`Measure(Metric metric, java.lang.Double value, int precision)` Deprecated. Creates a measure with a metric, a value and a precision for the value
`Measure(Metric metric, java.lang.Double value, java.lang.String data)` Deprecated. Creates a measure with a metric, a value and a data field
`Measure(Metric metric, Metric.Level level)` Deprecated. Creates a measure with a metric and an alert level
`Measure(Metric metric, java.lang.String data)` Deprecated. * Creates a measure with a metric and a data field
`Measure(java.lang.String metricKey)` Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)` Deprecated.
`Metric.Level`	`getAlertStatus()` Deprecated.
`java.lang.String`	`getAlertText()` Deprecated.
`java.lang.String`	`getData()` Deprecated.
`Metric.Level`	`getDataAsLevel()` Deprecated.
`java.util.Date`	`getDate()` Deprecated.
`java.lang.String`	`getDescription()` Deprecated.
`java.lang.Integer`	`getIntValue()` Deprecated.
`Metric<G>`	`getMetric()` Deprecated.
`java.lang.String`	`getMetricKey()` Deprecated.
`java.lang.Integer`	`getPersonId()` Deprecated. in 6.5 with end of support of Developer cockpit plugin. Always return `null`.
`java.lang.Integer`	`getTendency()` Deprecated. since 5.2. See https://jira.sonarsource.com/browse/SONAR-6392
`java.lang.String`	`getUrl()` Deprecated.
`java.lang.Double`	`getValue()` Deprecated.
`java.lang.Double`	`getVariation(int index)` Deprecated.
`java.lang.Double`	`getVariation1()` Deprecated.
`java.lang.Double`	`getVariation2()` Deprecated.
`java.lang.Double`	`getVariation3()` Deprecated.
`java.lang.Double`	`getVariation4()` Deprecated.
`java.lang.Double`	`getVariation5()` Deprecated.
`boolean`	`hasData()` Deprecated.
`int`	`hashCode()` Deprecated.
`boolean`	`isBestValue()` Deprecated.
`Measure<G>`	`setAlertStatus(Metric.Level status)` Deprecated. Set the alert status of the measure
`Measure<G>`	`setAlertText(java.lang.String alertText)` Deprecated. Sets the text associated to the alert on the measure
`Measure<G>`	`setData(Metric.Level level)` Deprecated. Sets an alert level as the data field
`Measure<G>`	`setData(java.lang.String s)` Deprecated. Sets the data field of the measure.
`Measure<G>`	`setDate(java.util.Date date)` Deprecated. Sets the date of the measure - Used only in TimeMachine queries
`Measure<G>`	`setDescription(java.lang.String description)` Deprecated. Sets the measure description
`Measure<G>`	`setIntValue(java.lang.Integer i)` Deprecated. Sets the measure value as an int
`Measure<G>`	`setMetric(Metric<G> metric)` Deprecated. Set the underlying metric
`Measure<G>`	`setPersonId(java.lang.Integer i)` Deprecated. in 6.5 with end of support of Developer cockpit plugin.
`Measure<G>`	`setRawValue(java.lang.Double v)` Deprecated. For internal use
`Measure<G>`	`setTendency(java.lang.Integer tendency)` Deprecated. since 5.2. See https://jira.sonarsource.com/browse/SONAR-6392
`Measure<G>`	`setUrl(java.lang.String url)` Deprecated. Sets the URL of the measure
`Measure<G>`	`setValue(java.lang.Double v)` Deprecated. Sets the measure value with the default precision of 1
`Measure<G>`	`setValue(java.lang.Double v, int decimalScale)` Deprecated. in 5.3. The decimal scale is given by the metric, not by the measure. Anyway this parameter was enforced to 1 before version 5.3.
`Measure<G>`	`setVariation(int index, java.lang.Double d)` Deprecated. Internal use only
`Measure<G>`	`setVariation1(java.lang.Double d)` Deprecated. Internal use only
`Measure<G>`	`setVariation2(java.lang.Double d)` Deprecated. Internal use only
`Measure<G>`	`setVariation3(java.lang.Double d)` Deprecated. Internal use only
`Measure<G>`	`setVariation4(java.lang.Double d)` Deprecated. Internal use only
`Measure<G>`	`setVariation5(java.lang.Double d)` Deprecated. Internal use only
`java.lang.String`	`toString()` Deprecated.
`Measure<G>`	`unsetData()` Deprecated.
`G`	`value()` Deprecated. For internal use.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - MAX_TEXT_SIZE
```
protected static final int MAX_TEXT_SIZE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PRECISION
```
@Deprecated
public static final int DEFAULT_PRECISION
```
    Deprecated. in 5.3. Decimal scale is provided by metric, not by measure.
    
    Default precision when saving a float type metric
    
    See Also:
    
    Constant Field Values
  - metricKey
```
protected java.lang.String metricKey
```
    Deprecated.
  - metric
```
protected Metric<G extends java.io.Serializable> metric
```
    Deprecated.
  - value
```
protected java.lang.Double value
```
    Deprecated.
  - data
```
protected java.lang.String data
```
    Deprecated.
  - description
```
protected java.lang.String description
```
    Deprecated.
  - alertStatus
```
protected Metric.Level alertStatus
```
    Deprecated.
  - alertText
```
protected java.lang.String alertText
```
    Deprecated.
  - date
```
protected java.util.Date date
```
    Deprecated.
  - variation1
```
protected java.lang.Double variation1
```
    Deprecated.
  - variation2
```
protected java.lang.Double variation2
```
    Deprecated.
  - variation3
```
protected java.lang.Double variation3
```
    Deprecated.
  - variation4
```
protected java.lang.Double variation4
```
    Deprecated.
  - variation5
```
protected java.lang.Double variation5
```
    Deprecated.
  - url
```
protected java.lang.String url
```
    Deprecated.
- Constructor Detail
  - Measure
```
public Measure(java.lang.String metricKey)
```
    Deprecated.
  - Measure
```
public Measure(Metric metric)
```
    Deprecated.
    
    Creates a measure with a metric
    
    Parameters:
    
    metric - the metric
  - Measure
```
public Measure(Metric metric,
               java.lang.Double value)
```
    Deprecated.
    
    Creates a measure with a metric and a value
    
    Parameters:
    
    metric - the metric
    
    value - its value
  - Measure
```
public Measure(Metric metric,
               java.lang.Double value,
               int precision)
```
    Deprecated.
    
    Creates a measure with a metric, a value and a precision for the value
    
    Parameters:
    
    metric - the metric
    
    value - its value
    
    precision - the value precision
  - Measure
```
public Measure(Metric metric,
               java.lang.Double value,
               java.lang.String data)
```
    Deprecated.
    
    Creates a measure with a metric, a value and a data field
    
    Parameters:
    
    metric - the metric
    
    value - the value
    
    data - the data field
  - Measure
```
public Measure(Metric metric,
               java.lang.String data)
```
    Deprecated.
    
    * Creates a measure with a metric and a data field
    
    Parameters:
    
    metric - the metric
    
    data - the data field
  - Measure
```
public Measure(Metric metric,
               @Nullable
               Metric.Level level)
```
    Deprecated.
    
    Creates a measure with a metric and an alert level
    
    Parameters:
    
    metric - the metric
    
    level - the alert level
  - Measure
```
public Measure()
```
    Deprecated.
    
    Creates an empty measure
- Method Detail
  - getMetric
```
public Metric<G> getMetric()
```
    Deprecated.
    
    Returns:
    
    return the measures underlying metric
  - getMetricKey
```
public java.lang.String getMetricKey()
```
    Deprecated.
  - setMetric
```
public Measure<G> setMetric(Metric<G> metric)
```
    Deprecated.
    
    Set the underlying metric
    
    Parameters:
    
    metric - the metric
    
    Returns:
    
    the measure object instance
  - getDataAsLevel
```
public Metric.Level getDataAsLevel()
```
    Deprecated.
    
    Returns:
    
    transforms and returns the data fields as a level of alert
  - hasData
```
public boolean hasData()
```
    Deprecated.
  - getDate
```
public java.util.Date getDate()
```
    Deprecated.
    
    Returns:
    
    the date of the measure, i.e. the date the measure was taken. Used only in TimeMachine queries
  - setDate
```
public Measure<G> setDate(java.util.Date date)
```
    Deprecated.
    
    Sets the date of the measure - Used only in TimeMachine queries
    
    Parameters:
    
    date - the date
    
    Returns:
    
    the measure object instance
  - getValue
```
@CheckForNull
public java.lang.Double getValue()
```
    Deprecated.
    
    Returns:
    
    the value of the measure as a double
  - value
```
public G value()
```
    Deprecated.
    
    For internal use.
  - getIntValue
```
public java.lang.Integer getIntValue()
```
    Deprecated.
    
    Returns:
    
    the value of the measure as an int
  - setValue
```
public Measure<G> setValue(@Nullable
                           java.lang.Double v)
```
    Deprecated.
    
    Sets the measure value with the default precision of 1
    
    Parameters:
    
    v - the measure value
    
    Returns:
    
    the measure object instance
  - setRawValue
```
public Measure<G> setRawValue(@Nullable
                              java.lang.Double v)
```
    Deprecated.
    
    For internal use
  - setIntValue
```
public Measure<G> setIntValue(@Nullable
                              java.lang.Integer i)
```
    Deprecated.
    
    Sets the measure value as an int
    
    Parameters:
    
    i - the value
    
    Returns:
    
    the measure object instance
  - setValue
```
@Deprecated
public Measure<G> setValue(@Nullable
                                       java.lang.Double v,
                                       int decimalScale)
```
    Deprecated. in 5.3. The decimal scale is given by the metric, not by the measure. Anyway this parameter was enforced to 1 before version 5.3.
    
    Sets the measure value with a given precision
    
    Returns:
    
    this
  - getData
```
@CheckForNull
public java.lang.String getData()
```
    Deprecated.
    
    Returns:
    
    the data field of the measure
  - setData
```
public Measure<G> setData(java.lang.String s)
```
    Deprecated.
    
    Sets the data field of the measure.
    
    Parameters:
    
    s - the data
    
    Returns:
    
    the measure object instance
  - setData
```
public Measure<G> setData(@Nullable
                          Metric.Level level)
```
    Deprecated.
    
    Sets an alert level as the data field
    
    Parameters:
    
    level - the alert level
    
    Returns:
    
    the measure object instance
  - unsetData
```
public Measure<G> unsetData()
```
    Deprecated.
    
    Since:
    
    2.7
  - getDescription
```
public java.lang.String getDescription()
```
    Deprecated.
    
    Returns:
    
    the description of the measure
  - setDescription
```
public Measure<G> setDescription(java.lang.String description)
```
    Deprecated.
    
    Sets the measure description
    
    Parameters:
    
    description - the description
    
    Returns:
    
    the measure object instance
  - getAlertStatus
```
public Metric.Level getAlertStatus()
```
    Deprecated.
    
    Returns:
    
    the alert status of the measure
  - setAlertStatus
```
public Measure<G> setAlertStatus(@Nullable
                                 Metric.Level status)
```
    Deprecated.
    
    Set the alert status of the measure
    
    Parameters:
    
    status - the status
    
    Returns:
    
    the measure object instance
  - getAlertText
```
public java.lang.String getAlertText()
```
    Deprecated.
    
    Returns:
    
    the text associated to the alert on the measure
  - setAlertText
```
public Measure<G> setAlertText(@Nullable
                               java.lang.String alertText)
```
    Deprecated.
    
    Sets the text associated to the alert on the measure
    
    Parameters:
    
    alertText - the text
    
    Returns:
    
    the measure object instance
  - getTendency
```
@Deprecated
 @CheckForNull
public java.lang.Integer getTendency()
```
    Deprecated. since 5.2. See https://jira.sonarsource.com/browse/SONAR-6392
    
    Concept of measure trend is dropped.
    
    Returns:
    
    null since version 5.2
  - setTendency
```
@Deprecated
public Measure<G> setTendency(@Nullable
                                          java.lang.Integer tendency)
```
    Deprecated. since 5.2. See https://jira.sonarsource.com/browse/SONAR-6392
    
    Concept of measure trend is dropped. This method does nothing.
    
    Returns:
    
    the measure object instance
  - getVariation1
```
public java.lang.Double getVariation1()
```
    Deprecated.
    
    Returns:
    
    the first variation value
    
    Since:
    
    2.5
  - setVariation1
```
public Measure<G> setVariation1(@Nullable
                                java.lang.Double d)
```
    Deprecated.
    
    Internal use only
    
    Since:
    
    2.5
  - getVariation2
```
public java.lang.Double getVariation2()
```
    Deprecated.
    
    Returns:
    
    the second variation value
    
    Since:
    
    2.5
  - setVariation2
```
public Measure<G> setVariation2(@Nullable
                                java.lang.Double d)
```
    Deprecated.
    
    Internal use only
    
    Since:
    
    2.5
  - getVariation3
```
public java.lang.Double getVariation3()
```
    Deprecated.
    
    Returns:
    
    the third variation value
    
    Since:
    
    2.5
  - setVariation3
```
public Measure<G> setVariation3(@Nullable
                                java.lang.Double d)
```
    Deprecated.
    
    Internal use only
    
    Since:
    
    2.5
  - getVariation4
```
public java.lang.Double getVariation4()
```
    Deprecated.
    
    Returns:
    
    the third variation value
    
    Since:
    
    2.5
  - setVariation4
```
public Measure<G> setVariation4(@Nullable
                                java.lang.Double d)
```
    Deprecated.
    
    Internal use only
    
    Since:
    
    2.5
  - getVariation5
```
public java.lang.Double getVariation5()
```
    Deprecated.
    
    Returns:
    
    the third variation value
    
    Since:
    
    2.5
  - setVariation5
```
public Measure<G> setVariation5(@Nullable
                                java.lang.Double d)
```
    Deprecated.
    
    Internal use only
    
    Since:
    
    2.5
  - getVariation
```
public java.lang.Double getVariation(int index)
```
    Deprecated.
    
    Since:
    
    2.5
  - setVariation
```
public Measure<G> setVariation(int index,
                               java.lang.Double d)
```
    Deprecated.
    
    Internal use only
    
    Since:
    
    2.5
  - getUrl
```
public java.lang.String getUrl()
```
    Deprecated.
    
    Returns:
    
    the url of the measure
  - setUrl
```
public Measure<G> setUrl(java.lang.String url)
```
    Deprecated.
    
    Sets the URL of the measure
    
    Parameters:
    
    url - the url
    
    Returns:
    
    the measure object instance
  - getPersonId
```
@CheckForNull
 @Deprecated
public java.lang.Integer getPersonId()
```
    Deprecated. in 6.5 with end of support of Developer cockpit plugin. Always return null.
    
    Since:
    
    2.14
  - setPersonId
```
@Deprecated
public Measure<G> setPersonId(@Nullable
                                          java.lang.Integer i)
```
    Deprecated. in 6.5 with end of support of Developer cockpit plugin.
    
    Since:
    
    2.14
  - isBestValue
```
public boolean isBestValue()
```
    Deprecated.
    
    Since:
    
    3.2
  - equals
```
public boolean equals(java.lang.Object o)
```
    Deprecated.
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Deprecated.
    
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Deprecated.
    
    Overrides:
    
    toString in class java.lang.Object

Class Measure<G extends java.io.Serializable>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_TEXT_SIZE

DEFAULT_PRECISION

metricKey

metric

value

data

description

alertStatus

alertText

date

variation1

variation2

variation3

variation4

variation5

url

Constructor Detail

Measure

Measure

Measure

Measure

Measure

Measure

Measure

Measure

Method Detail

getMetric

getMetricKey

setMetric

getDataAsLevel

hasData

getDate

setDate

getValue

value

getIntValue

setValue

setRawValue

setIntValue

setValue

getData

setData

setData

unsetData

getDescription

setDescription

getAlertStatus

setAlertStatus

getAlertText

setAlertText

getTendency

setTendency

getVariation1

setVariation1

getVariation2

setVariation2

getVariation3

setVariation3

getVariation4

setVariation4

getVariation5

setVariation5

getVariation

setVariation

getUrl

setUrl

getPersonId

setPersonId

isBestValue

equals

hashCode

toString