org.sonar.api.measures
Class Metric

java.lang.Object
  org.sonar.api.database.BaseIdentifiable
      org.sonar.api.measures.Metric

All Implemented Interfaces:

BatchExtension, Extension, ServerExtension

public class Metric
extends BaseIdentifiable
implements ServerExtension, BatchExtension

Since:

1.10

Nested Class Summary

static class	Metric.Level
static class	Metric.Origin
static class	Metric.ValueType

Field Summary

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

Constructor Summary

Metric()

Metric(String key)

Metric(String key, Metric.ValueType type)

Metric(String key, String name, Metric.ValueType type, Integer direction, Boolean qualitative, String domain, Formula formula)

Metric(String key, String name, String description, Metric.ValueType type, Integer direction, Boolean qualitative, String domain)

Metric(String key, String name, String description, Metric.ValueType type, Integer direction, Boolean qualitative, String domain, boolean userManaged)
Deprecated.

Method Summary

boolean	equals(Object obj)
String	getDescription()
Integer	getDirection()
String	getDomain()
Boolean	getEnabled()
Formula	getFormula()
String	getKey()
String	getName()
Metric.Origin	getOrigin()
Boolean	getQualitative()
Metric.ValueType	getType()
Boolean	getUserManaged()
int	hashCode()
boolean	isDataType()
boolean	isNumericType()
boolean	isPercentageType()
void	setDescription(String description)
void	setDirection(Integer direction)
void	setDomain(String domain)
void	setEnabled(Boolean enabled)
Metric	setFormula(Formula formula)
void	setKey(String key)
void	setName(String name)
void	setOrigin(Metric.Origin origin)
void	setQualitative(Boolean qualitative)
void	setType(Metric.ValueType type)
void	setUserManaged(Boolean userManaged)
String	toString()

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

getId, setId

Methods inherited from class java.lang.Object

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

Field Detail

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

public Metric()

Metric

public Metric(String key)

Metric

public Metric(String key,
              Metric.ValueType type)

Metric

public Metric(String key,
              String name,
              String description,
              Metric.ValueType type,
              Integer direction,
              Boolean qualitative,
              String domain)

Metric

@Deprecated
public Metric(String key,
                         String name,
                         String description,
                         Metric.ValueType type,
                         Integer direction,
                         Boolean qualitative,
                         String domain,
                         boolean userManaged)

Deprecated.

Metric

public Metric(String key,
              String name,
              Metric.ValueType type,
              Integer direction,
              Boolean qualitative,
              String domain,
              Formula formula)

Method Detail

getFormula

public Formula getFormula()

setFormula

public Metric setFormula(Formula formula)

getQualitative

public Boolean getQualitative()

setQualitative

public void setQualitative(Boolean qualitative)

getKey

public String getKey()

setKey

public void setKey(String key)

getType

public Metric.ValueType getType()

setType

public void setType(Metric.ValueType type)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getUserManaged

public Boolean getUserManaged()

setUserManaged

public void setUserManaged(Boolean userManaged)

getEnabled

public Boolean getEnabled()

setEnabled

public void setEnabled(Boolean enabled)

getDirection

public Integer getDirection()

setDirection

public void setDirection(Integer direction)

getDomain

public String getDomain()

setDomain

public void setDomain(String domain)

getName

public String getName()

setName

public void setName(String name)

getOrigin

public Metric.Origin getOrigin()

setOrigin

public void setOrigin(Metric.Origin origin)

isNumericType

public boolean isNumericType()

isDataType

public boolean isDataType()

isPercentageType

public boolean isPercentageType()

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