org.sonar.api.server.debt

Interface DebtRemediationFunction

All Known Implementing Classes:

DefaultDebtRemediationFunction

public interface DebtRemediationFunction

Function used to calculate the remediation cost of an issue. There are three types :

• Linear - Each issue of the rule costs the same amount of time (coefficient) to fix.
• Linear with offset - It takes a certain amount of time to analyze the issues of such kind on the file (offset). Then, each issue of the rule costs the same amount of time (coefficient) to fix. Total remediation cost by file = offset + (number of issues x coefficient)
• Constant/issue - The cost to fix all the issues of the rule is the same whatever the number of issues of this rule in the file. Total remediation cost by file = constant

Since:

4.3

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DebtRemediationFunction.Type

Method Summary

Methods

Modifier and Type	Method and Description
String	coefficient() Factor is set on types DebtRemediationFunction.Type.LINEAR and DebtRemediationFunction.Type.LINEAR_OFFSET, else it's null.
String	offset() Offset is set on types DebtRemediationFunction.Type.LINEAR_OFFSET and DebtRemediationFunction.Type.CONSTANT_ISSUE, else it's null.
DebtRemediationFunction.Type	type()

Method Detail

type

DebtRemediationFunction.Type type()

coefficient

@CheckForNull
String coefficient()

Factor is set on types DebtRemediationFunction.Type.LINEAR and DebtRemediationFunction.Type.LINEAR_OFFSET, else it's null.

offset

@CheckForNull
String offset()

Offset is set on types DebtRemediationFunction.Type.LINEAR_OFFSET and DebtRemediationFunction.Type.CONSTANT_ISSUE, else it's null.