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. See DebtRemediationFunction.Type for details.

The gap multiplier and base effort involved in the functions are durations. They are defined in hours, minutes and/or seconds. Examples: "5min", "1h 10min". Supported units are "d" (days), "h" (hour), and "min" (minutes).

Since:

4.3

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DebtRemediationFunction.Type

Method Summary

Modifier and Type	Method and Description
String	baseEffort() Non-null value on DebtRemediationFunction.Type.LINEAR_OFFSET and DebtRemediationFunction.Type.CONSTANT_ISSUE functions, else null.
String	coefficient() Deprecated. since 5.5, replaced by gapMultiplier()
String	gapMultiplier() Non-null value on DebtRemediationFunction.Type.LINEAR and DebtRemediationFunction.Type.LINEAR_OFFSET functions, else null.
String	offset() Deprecated. since 5.5, replaced by baseEffort()
DebtRemediationFunction.Type	type()

Method Detail

type

DebtRemediationFunction.Type type()

Since:

5.5

coefficient

@Deprecated
 @CheckForNull
String coefficient()

Deprecated. since 5.5, replaced by gapMultiplier()

gapMultiplier

@CheckForNull
String gapMultiplier()

Non-null value on DebtRemediationFunction.Type.LINEAR and DebtRemediationFunction.Type.LINEAR_OFFSET functions, else null.

Since:

5.5

offset

@Deprecated
 @CheckForNull
String offset()

Deprecated. since 5.5, replaced by baseEffort()

baseEffort

@CheckForNull
String baseEffort()

Non-null value on DebtRemediationFunction.Type.LINEAR_OFFSET and DebtRemediationFunction.Type.CONSTANT_ISSUE functions, else null.

Since:

5.5