org.sonar.api.server.rule

Interface RulesDefinition.DebtRemediationFunctions

Enclosing interface:

RulesDefinition

public static interface RulesDefinition.DebtRemediationFunctions

Factory of DebtRemediationFunction.

Method Summary

Modifier and Type	Method and Description
DebtRemediationFunction	constantPerIssue(String baseEffort) Shortcut for create(Type.CONSTANT_ISSUE, null, base effort).
DebtRemediationFunction	create(DebtRemediationFunction.Type type, String gapMultiplier, String baseEffort) Flexible way to create a DebtRemediationFunction.
DebtRemediationFunction	linear(String gapMultiplier) Shortcut for create(Type.LINEAR, gap multiplier, null).
DebtRemediationFunction	linearWithOffset(String gapMultiplier, String baseEffort) Shortcut for create(Type.LINEAR_OFFSET, gap multiplier, base effort).

Method Detail

linear

DebtRemediationFunction linear(String gapMultiplier)

Shortcut for create(Type.LINEAR, gap multiplier, null).

Parameters:

gapMultiplier - the duration to fix one issue. See DebtRemediationFunction for details about format.

See Also:

DebtRemediationFunction.Type.LINEAR

linearWithOffset

DebtRemediationFunction linearWithOffset(String gapMultiplier,
                                         String baseEffort)

Shortcut for create(Type.LINEAR_OFFSET, gap multiplier, base effort).

Parameters:

gapMultiplier - duration to fix one point of complexity. See DebtRemediationFunction for details and format.

baseEffort - duration to make basic analysis. See DebtRemediationFunction for details and format.

See Also:

DebtRemediationFunction.Type.LINEAR_OFFSET

constantPerIssue

DebtRemediationFunction constantPerIssue(String baseEffort)

Shortcut for create(Type.CONSTANT_ISSUE, null, base effort).

Parameters:

baseEffort - cost per issue. See DebtRemediationFunction for details and format.

See Also:

DebtRemediationFunction.Type.CONSTANT_ISSUE

create

DebtRemediationFunction create(DebtRemediationFunction.Type type,
                               @Nullable
                               String gapMultiplier,
                               @Nullable
                               String baseEffort)

Flexible way to create a DebtRemediationFunction. An unchecked exception is thrown if coefficient and/or offset are not valid according to the given @{code type}.

Since:

5.3