org.sonar.api.server.rule

Interface RulesDefinition.DebtRemediationFunctions

Enclosing interface:

RulesDefinition

public static interface RulesDefinition.DebtRemediationFunctions

Factory of DebtRemediationFunction.

Method Summary

Methods

Modifier and Type	Method and Description
DebtRemediationFunction	constantPerIssue(String constant) Shortcut for create(Type.CONSTANT_ISSUE, null, constant).
DebtRemediationFunction	create(DebtRemediationFunction.Type type, String coefficient, String offset) Flexible way to create a DebtRemediationFunction.
DebtRemediationFunction	linear(String coefficient) Shortcut for create(Type.LINEAR, coefficient, null).
DebtRemediationFunction	linearWithOffset(String coefficient, String offset) Shortcut for create(Type.LINEAR_OFFSET, coefficient, offset).

Method Detail

linear

DebtRemediationFunction linear(String coefficient)

Shortcut for create(Type.LINEAR, coefficient, null).

Parameters:

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

See Also:

DebtRemediationFunction.Type.LINEAR

linearWithOffset

DebtRemediationFunction linearWithOffset(String coefficient,
                                       String offset)

Shortcut for create(Type.LINEAR_OFFSET, coefficient, offset).

Parameters:

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

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

See Also:

DebtRemediationFunction.Type.LINEAR_OFFSET

constantPerIssue

DebtRemediationFunction constantPerIssue(String constant)

Shortcut for create(Type.CONSTANT_ISSUE, null, constant).

Parameters:

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

See Also:

DebtRemediationFunction.Type.CONSTANT_ISSUE

create

DebtRemediationFunction create(DebtRemediationFunction.Type type,
                             @Nullable
                             String coefficient,
                             @Nullable
                             String offset)

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