detekt-api/io.gitlab.arturbosch.detekt.api/Metric

Metric

class Metric(val value: Int, val threshold: Int, val isDouble: Boolean = false, val conversionFactor: Int = DEFAULT_FLOAT_CONVERSION_FACTOR)

Metric type, can be an integer or double value. Internally it is stored as an integer, but the conversion factor and is double attributes can be used to retrieve it as a double value.

Constructors

Metric

constructor(value: Double, threshold: Double, conversionFactor: Int = DEFAULT_FLOAT_CONVERSION_FACTOR)

constructor(value: Int, threshold: Int, isDouble: Boolean = false, conversionFactor: Int = DEFAULT_FLOAT_CONVERSION_FACTOR)

Properties

conversionFactor

val conversionFactor: Int

isDouble

val isDouble: Boolean = false

threshold

val threshold: Int

value

val value: Int

Functions

doubleThreshold

fun doubleThreshold(): Double

Specified threshold for this metric as a double value.

doubleValue

fun doubleValue(): Double

Convenient method to retrieve the raised value as a double. Internally the value is stored as an int with a conversion factor to not loose any precision in calculations.

toString

open override fun toString(): String