Package org.sonar.api.measures

Class Metric<G extends java.io.Serializable>

java.lang.Object

org.sonar.api.measures.Metric<G>

All Implemented Interfaces:

java.io.Serializable, Metric<G>

@ScannerSide
@ServerSide
@ComputeEngineSide
public class Metric<G extends java.io.Serializable>
extends java.lang.Object
implements java.io.Serializable, Metric<G>

Used to define a metric in a plugin. Should be used with Metrics extension point.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	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	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

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.Double	getBestValue()
java.lang.Integer	getDecimalScale()	Return the number scale if metric type is Metric.ValueType.FLOAT, else null
java.lang.Boolean	getDeleteHistoricalData()
java.lang.String	getDescription()
java.lang.Integer	getDirection()
java.lang.String	getDomain()
java.lang.Boolean	getEnabled()
java.lang.String	getKey()
java.lang.String	getName()
java.lang.Boolean	getQualitative()
Metric.ValueType	getType()
java.lang.Boolean	getUserManaged()	Deprecated. since 9.1.
java.lang.String	getUuid()	For internal use only
java.lang.Double	getWorstValue()
int	hashCode()
boolean	isDataType()
java.lang.Boolean	isHidden()
boolean	isNumericType()
java.lang.Boolean	isOptimizedBestValue()
boolean	isPercentageType()
java.lang.String	key()
Metric<G>	merge(Metric with)	Merge with fields from other metric.
Metric<G>	setBestValue(java.lang.Double bestValue)
Metric<G>	setDescription(java.lang.String description)	Sets the metric description
Metric<G>	setDirection(java.lang.Integer direction)	Sets the metric direction.
Metric<G>	setDomain(java.lang.String domain)	Sets the domain for the metric (General, Complexity...)
Metric<G>	setEnabled(java.lang.Boolean enabled)	Sets whether the metric is enabled
Metric<G>	setHidden(java.lang.Boolean hidden)
Metric<G>	setKey(java.lang.String key)	Sets the metric key
Metric<G>	setName(java.lang.String name)	Sets the metric name
Metric<G>	setOptimizedBestValue(java.lang.Boolean b)
Metric<G>	setQualitative(java.lang.Boolean qualitative)	Sets whether the metric is qualitative
Metric<G>	setType(Metric.ValueType type)	Sets the metric type
Metric<G>	setUserManaged(java.lang.Boolean userManaged)	Deprecated. since 9.1.
Metric<G>	setUuid(java.lang.String uuid)	For internal use only
Metric<G>	setWorstValue(java.lang.Double d)
java.lang.String	toString()
java.lang.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

Method Detail

getUuid

public java.lang.String getUuid()

For internal use only

setUuid

public Metric<G> setUuid(@Nullable
                         java.lang.String uuid)

For internal use only

getQualitative

public java.lang.Boolean getQualitative()

Returns:

wether the metric is qualitative

setQualitative

public Metric<G> setQualitative(java.lang.Boolean qualitative)

Sets whether the metric is qualitative

Parameters:

qualitative - whether the metric is qualitative

Returns:

this

getKey

public java.lang.String getKey()

Returns:

the metric key

setKey

public Metric<G> setKey(java.lang.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 java.lang.String getDescription()

Returns:

the metric description

setDescription

public Metric<G> setDescription(@Nullable
                                java.lang.String description)

Sets the metric description

Parameters:

description - the description

Returns:

this

getUserManaged

@Deprecated(since="9.1")
public java.lang.Boolean getUserManaged()

Deprecated.

since 9.1. There is no replacement

Returns:

whether the metric is a managed by the users ("manual metric")

setUserManaged

@Deprecated(since="9.1")
public Metric<G> setUserManaged(java.lang.Boolean userManaged)

Deprecated.

since 9.1. There is no replacement

Sets whether the metric is managed by users ("manual metric")

Parameters:

userManaged - whether the metric is user managed

Returns:

this

getEnabled

public java.lang.Boolean getEnabled()

Returns:

whether the metric is enabled

setEnabled

public Metric<G> setEnabled(java.lang.Boolean enabled)

Sets whether the metric is enabled

Parameters:

enabled - whether the metric is enabled

Returns:

this

getDirection

public java.lang.Integer getDirection()

Returns:

the metric direction

setDirection

public Metric<G> setDirection(java.lang.Integer direction)

Sets the metric direction.

Parameters:

direction - the direction

getDomain

public java.lang.String getDomain()

Returns:

the domain of the metric

setDomain

public Metric<G> setDomain(java.lang.String domain)

Sets the domain for the metric (General, Complexity...)

Parameters:

domain - the domain

Returns:

this

getName

public java.lang.String getName()

Returns:

the metric name

setName

public Metric<G> setName(java.lang.String name)

Sets the metric name

Parameters:

name - the name

Returns:

this

getWorstValue

public java.lang.Double getWorstValue()

getBestValue

@CheckForNull
public java.lang.Double getBestValue()

setWorstValue

public Metric<G> setWorstValue(@Nullable
                               java.lang.Double d)

Returns:

this

setBestValue

public Metric<G> setBestValue(@Nullable
                              java.lang.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
                                       java.lang.Boolean b)

isOptimizedBestValue

@CheckForNull
public java.lang.Boolean isOptimizedBestValue()

Returns:

null for manual metrics

isHidden

public java.lang.Boolean isHidden()

setHidden

public Metric<G> setHidden(java.lang.Boolean hidden)

getDeleteHistoricalData

public java.lang.Boolean getDeleteHistoricalData()

getDecimalScale

@CheckForNull
public java.lang.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 java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.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 java.lang.String key()

Specified by:

key in interface Metric<G extends java.io.Serializable>

valueType

public java.lang.Class<G> valueType()

Specified by:

valueType in interface Metric<G extends java.io.Serializable>