public static class RulesDefinition.NewRule extends Object
Modifier and Type | Method and Description |
---|---|
RulesDefinition.NewRule |
addTags(String... list) |
RulesDefinition.NewParam |
createParam(String paramKey)
Create a parameter with given unique key.
|
RulesDefinition.DebtRemediationFunctions |
debtRemediationFunctions()
Factory of
DebtRemediationFunction |
String |
key() |
RulesDefinition.NewParam |
param(String paramKey) |
Collection<RulesDefinition.NewParam> |
params() |
RulesDefinition.NewRule |
setDebtRemediationFunction(DebtRemediationFunction fn) |
RulesDefinition.NewRule |
setDebtSubCharacteristic(String s)
Deprecated.
in 5.5. SQALE Quality Model is replaced by SonarQube Quality Model. This method does nothing.
See https://jira.sonarsource.com/browse/MMF-184
|
RulesDefinition.NewRule |
setEffortToFixDescription(String s)
Deprecated.
since 5.5, replaced by
setGapDescription(String) |
RulesDefinition.NewRule |
setGapDescription(String s)
For rules that use LINEAR or LINEAR_OFFSET remediation functions, the meaning
of the function parameter (= "gap") must be set.
|
RulesDefinition.NewRule |
setHtmlDescription(String s)
The optional description, in HTML format, has no max length.
|
RulesDefinition.NewRule |
setHtmlDescription(URL classpathUrl)
Load description from a file available in classpath.
|
RulesDefinition.NewRule |
setInternalKey(String s)
Optional key that can be used by the rule engine.
|
RulesDefinition.NewRule |
setMarkdownDescription(String s)
The optional description, in a restricted Markdown format, has no max length.
|
RulesDefinition.NewRule |
setMarkdownDescription(URL classpathUrl)
Load description from a file available in classpath.
|
RulesDefinition.NewRule |
setName(String s)
Required rule name
|
RulesDefinition.NewRule |
setSeverity(String s) |
RulesDefinition.NewRule |
setStatus(RuleStatus status)
Default value is
RuleStatus.READY . |
RulesDefinition.NewRule |
setTags(String... list) |
RulesDefinition.NewRule |
setTemplate(boolean template) |
RulesDefinition.NewRule |
setType(RuleType t)
The type as defined by the SonarQube Quality Model.
|
String |
toString() |
public RulesDefinition.NewRule setName(String s)
public RulesDefinition.NewRule setTemplate(boolean template)
public RulesDefinition.NewRule setSeverity(String s)
public RulesDefinition.NewRule setType(RuleType t)
RuleType.BUG
RuleType.VULNERABILITY
RuleType.BUG
RuleType.CODE_SMELL
public RulesDefinition.NewRule setHtmlDescription(@Nullable String s)
setMarkdownDescription(String)
)public RulesDefinition.NewRule setHtmlDescription(@Nullable URL classpathUrl)
setHtmlDescription(getClass().getResource("/myrepo/Rule1234.html")
public RulesDefinition.NewRule setMarkdownDescription(@Nullable String s)
setHtmlDescription(String)
)public RulesDefinition.NewRule setMarkdownDescription(@Nullable URL classpathUrl)
setMarkdownDescription(getClass().getResource("/myrepo/Rule1234.md")
public RulesDefinition.NewRule setStatus(RuleStatus status)
RuleStatus.READY
. The value
RuleStatus.REMOVED
is not accepted and raises an
IllegalArgumentException
.public RulesDefinition.NewRule setDebtSubCharacteristic(@Nullable String s)
for constant values
,
setType(RuleType)
public RulesDefinition.DebtRemediationFunctions debtRemediationFunctions()
DebtRemediationFunction
public RulesDefinition.NewRule setDebtRemediationFunction(@Nullable DebtRemediationFunction fn)
debtRemediationFunctions()
@Deprecated public RulesDefinition.NewRule setEffortToFixDescription(@Nullable String s)
setGapDescription(String)
public RulesDefinition.NewRule setGapDescription(@Nullable String s)
public RulesDefinition.NewParam createParam(String paramKey)
@CheckForNull public RulesDefinition.NewParam param(String paramKey)
public Collection<RulesDefinition.NewParam> params()
public RulesDefinition.NewRule addTags(String... list)
RuleTagFormat
public RulesDefinition.NewRule setTags(String... list)
RuleTagFormat
public RulesDefinition.NewRule setInternalKey(@Nullable String s)
Copyright © 2009–2016 SonarSource. All rights reserved.