Metric (SonarQube :: Plugin API 6.0 API)

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

All Implemented Interfaces:

Serializable, Metric<G>
```
@ScannerSide
 @ServerSide
 @ComputeEngineSide
public class Metric<G extends Serializable>
extends Object
implements Serializable, Metric<G>
```
Used to define a metric in a plugin. Should be used with Metrics extension point. Should no more be used on scanner side. Use Metric instead.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Metric.Builder` Metric.Builder is used to create metric definitions.
`static class`	`Metric.Level`
`static class`	`Metric.ValueType`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_DECIMAL_SCALE`
`static int`	`DIRECTION_BETTER` A metric bigger value means an improvement
`static int`	`DIRECTION_NONE` The metric direction has no meaning
`static int`	`DIRECTION_WORST` A metric bigger value means a degradation
`static int`	`MAX_DECIMAL_SCALE` The maximum supported value of scale for decimal metrics

Constructor Summary

Constructors
Constructor and Description
`Metric()` Deprecated. in 1.12. Use the `Metric.Builder` factory.
`Metric(String key)` Deprecated. since 2.7 use the `Metric.Builder` factory.
`Metric(String key, Metric.ValueType type)` Deprecated. since 2.7 use the `Metric.Builder` factory.
`Metric(String key, String name, String description, Metric.ValueType type, Integer direction, Boolean qualitative, String domain)` Deprecated. since 2.7 use the `Metric.Builder` factory.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Double`	`getBestValue()`
`Integer`	`getDecimalScale()` Return the number scale if metric type is `Metric.ValueType.FLOAT`, else `null`
`Boolean`	`getDeleteHistoricalData()`
`String`	`getDescription()`
`Integer`	`getDirection()`
`String`	`getDomain()`
`Boolean`	`getEnabled()`
`Formula`	`getFormula()` Deprecated. since 5.2 there's no more decorator on batch side, please use `MeasureComputer` instead
`Integer`	`getId()` For internal use only
`String`	`getKey()`
`String`	`getName()`
`Boolean`	`getQualitative()`
`Metric.ValueType`	`getType()`
`Boolean`	`getUserManaged()`
`Double`	`getWorstValue()`
`int`	`hashCode()`
`boolean`	`isDataType()`
`Boolean`	`isHidden()`
`boolean`	`isNumericType()`
`Boolean`	`isOptimizedBestValue()`
`boolean`	`isPercentageType()`
`String`	`key()`
`Metric<G>`	`merge(Metric with)` Merge with fields from other metric.
`Metric<G>`	`setBestValue(Double bestValue)`
`Metric<G>`	`setDescription(String description)` Sets the metric description
`Metric<G>`	`setDirection(Integer direction)` Sets the metric direction.
`Metric<G>`	`setDomain(String domain)` Sets the domain for the metric (General, Complexity...)
`Metric<G>`	`setEnabled(Boolean enabled)` Sets whether the metric is enabled
`Metric<G>`	`setFormula(Formula formula)` Deprecated. since 5.2 there's no more decorator on batch side, please use `MeasureComputer` instead
`Metric<G>`	`setHidden(Boolean hidden)`
`Metric<G>`	`setId(Integer id)` For internal use only
`Metric<G>`	`setKey(String key)` Sets the metric key
`Metric<G>`	`setName(String name)` Sets the metric name
`Metric<G>`	`setOptimizedBestValue(Boolean b)`
`Metric<G>`	`setQualitative(Boolean qualitative)` Sets whether the metric is qualitative
`Metric<G>`	`setType(Metric.ValueType type)` Sets the metric type
`Metric<G>`	`setUserManaged(Boolean userManaged)` Sets whether the metric is managed by users ("manual metric")
`Metric<G>`	`setWorstValue(Double d)`
`String`	`toString()`
`Class<G>`	`valueType()`

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

- Field Detail
  - DEFAULT_DECIMAL_SCALE
```
public static final int DEFAULT_DECIMAL_SCALE
```
    Since:
    
    5.3
    
    See Also:
    
    Constant Field Values
  - MAX_DECIMAL_SCALE
```
public static final int MAX_DECIMAL_SCALE
```
    The maximum supported value of scale for decimal metrics
    
    Since:
    
    5.3
    
    See Also:
    
    Constant Field Values
  - DIRECTION_WORST
```
public static final int DIRECTION_WORST
```
    A metric bigger value means a degradation
    
    See Also:
    
    Constant Field Values
  - DIRECTION_BETTER
```
public static final int DIRECTION_BETTER
```
    A metric bigger value means an improvement
    
    See Also:
    
    Constant Field Values
  - DIRECTION_NONE
```
public static final int DIRECTION_NONE
```
    The metric direction has no meaning
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Metric
```
@Deprecated
public Metric()
```
    Deprecated. in 1.12. Use the Metric.Builder factory.
    
    Creates an empty metric
  - Metric
```
@Deprecated
public Metric(String key)
```
    Deprecated. since 2.7 use the Metric.Builder factory.
    
    Creates a metric based on its key. Shortcut to Metric(key, ValueType.INT)
    
    Parameters:
    
    key - the metric key
  - Metric
```
@Deprecated
public Metric(String key,
                          Metric.ValueType type)
```
    Deprecated. since 2.7 use the Metric.Builder factory.
    
    Creates a metric based on a key and a type. Shortcut to Metric(key, key, key, type, -1, Boolean.FALSE, null, false)
    
    Parameters:
    
    key - the key
    
    type - the type
  - Metric
```
@Deprecated
public Metric(String key,
                          String name,
                          String description,
                          Metric.ValueType type,
                          Integer direction,
                          Boolean qualitative,
                          String domain)
```
    Deprecated. since 2.7 use the Metric.Builder factory.
- Method Detail
  - getId
```
public Integer getId()
```
    For internal use only
  - setId
```
public Metric<G> setId(@Nullable
                       Integer id)
```
    For internal use only
  - getFormula
```
@Deprecated
public Formula getFormula()
```
    Deprecated. since 5.2 there's no more decorator on batch side, please use MeasureComputer instead
    
    Returns:
    
    the metric formula
  - setFormula
```
@Deprecated
public Metric<G> setFormula(Formula formula)
```
    Deprecated. since 5.2 there's no more decorator on batch side, please use MeasureComputer instead
    
    Sets the metric formula
    
    Parameters:
    
    formula - the formula
    
    Returns:
    
    this
  - getQualitative
```
public Boolean getQualitative()
```
    Returns:
    
    wether the metric is qualitative
  - setQualitative
```
public Metric<G> setQualitative(Boolean qualitative)
```
    Sets whether the metric is qualitative
    
    Parameters:
    
    qualitative - whether the metric is qualitative
    
    Returns:
    
    this
  - getKey
```
public String getKey()
```
    Returns:
    
    the metric key
  - setKey
```
public Metric<G> setKey(String key)
```
    Sets the metric key
    
    Parameters:
    
    key - the key
    
    Returns:
    
    this
  - getType
```
public Metric.ValueType getType()
```
    Returns:
    
    the metric type
  - setType
```
public Metric<G> setType(Metric.ValueType type)
```
    Sets the metric type
    
    Parameters:
    
    type - the type
    
    Returns:
    
    this
  - getDescription
```
@CheckForNull
public String getDescription()
```
    Returns:
    
    the metric description
  - setDescription
```
public Metric<G> setDescription(@Nullable
                                String description)
```
    Sets the metric description
    
    Parameters:
    
    description - the description
    
    Returns:
    
    this
  - getUserManaged
```
public Boolean getUserManaged()
```
    Returns:
    
    whether the metric is a managed by the users ("manual metric")
  - setUserManaged
```
public Metric<G> setUserManaged(Boolean userManaged)
```
    Sets whether the metric is managed by users ("manual metric")
    
    Parameters:
    
    userManaged - whether the metric is user managed
    
    Returns:
    
    this
  - getEnabled
```
public Boolean getEnabled()
```
    Returns:
    
    whether the metric is enabled
  - setEnabled
```
public Metric<G> setEnabled(Boolean enabled)
```
    Sets whether the metric is enabled
    
    Parameters:
    
    enabled - whether the metric is enabled
    
    Returns:
    
    this
  - getDirection
```
public Integer getDirection()
```
    Returns:
    
    the metric direction
  - setDirection
```
public Metric<G> setDirection(Integer direction)
```
    Sets the metric direction.
    
    Parameters:
    
    direction - the direction
  - getDomain
```
public String getDomain()
```
    Returns:
    
    the domain of the metric
  - setDomain
```
public Metric<G> setDomain(String domain)
```
    Sets the domain for the metric (General, Complexity...)
    
    Parameters:
    
    domain - the domain
    
    Returns:
    
    this
  - getName
```
public String getName()
```
    Returns:
    
    the metric name
  - setName
```
public Metric<G> setName(String name)
```
    Sets the metric name
    
    Parameters:
    
    name - the name
    
    Returns:
    
    this
  - getWorstValue
```
public Double getWorstValue()
```
  - getBestValue
```
@CheckForNull
public Double getBestValue()
```
  - setWorstValue
```
public Metric<G> setWorstValue(@Nullable
                               Double d)
```
    Returns:
    
    this
  - setBestValue
```
public Metric<G> setBestValue(@Nullable
                              Double bestValue)
```
    Parameters:
    
    bestValue - the best value. It can be null.
    
    Returns:
    
    this
  - isNumericType
```
public boolean isNumericType()
```
    Returns:
    
    whether the metric is of a numeric type (int, percentage...)
  - isDataType
```
public boolean isDataType()
```
    Returns:
    
    whether the metric is of type data
  - isPercentageType
```
public boolean isPercentageType()
```
    Returns:
    
    whether the metric is of type percentage
  - setOptimizedBestValue
```
public Metric<G> setOptimizedBestValue(@Nullable
                                       Boolean b)
```
  - isOptimizedBestValue
```
@CheckForNull
public Boolean isOptimizedBestValue()
```
    Returns:
    
    null for manual metrics
  - isHidden
```
public Boolean isHidden()
```
  - setHidden
```
public Metric<G> setHidden(Boolean hidden)
```
  - getDeleteHistoricalData
```
public Boolean getDeleteHistoricalData()
```
  - getDecimalScale
```
@CheckForNull
public Integer getDecimalScale()
```
    Return the number scale if metric type is Metric.ValueType.FLOAT, else null
    
    Since:
    
    5.3
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - merge
```
public Metric<G> merge(Metric with)
```
    Merge with fields from other metric. All fields are copied, except the id.
    
    Returns:
    
    this
  - key
```
public String key()
```
    Specified by:
    
    key in interface Metric<G extends Serializable>
  - valueType
```
public Class<G> valueType()
```
    Specified by:
    
    valueType in interface Metric<G extends Serializable>

Class Metric<G extends Serializable>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_DECIMAL_SCALE

MAX_DECIMAL_SCALE

DIRECTION_WORST

DIRECTION_BETTER

DIRECTION_NONE

Constructor Detail

Metric

Metric

Metric

Metric

Method Detail

getId

setId

getFormula

setFormula

getQualitative

setQualitative

getKey

setKey

getType

setType

getDescription

setDescription

getUserManaged

setUserManaged

getEnabled

setEnabled

getDirection

setDirection

getDomain

setDomain

getName

setName

getWorstValue

getBestValue

setWorstValue

setBestValue

isNumericType

isDataType

isPercentageType

setOptimizedBestValue

isOptimizedBestValue

isHidden

setHidden

getDeleteHistoricalData

getDecimalScale

hashCode

equals

toString

merge

key

valueType