public static class RulesDefinition.NewRule
extends java.lang.Object
Modifier and Type | Method and Description |
---|---|
RulesDefinition.NewRule |
addCwe(int... nums) |
RulesDefinition.NewRule |
addDeprecatedRuleKey(java.lang.String repository,
java.lang.String key)
Register a repository and key under which this rule used to be known
(see
RulesDefinition.Rule.deprecatedRuleKeys for details). |
RulesDefinition.NewRule |
addOwaspTop10(RulesDefinition.OwaspTop10... standards) |
RulesDefinition.NewRule |
addTags(java.lang.String... list) |
RulesDefinition.NewParam |
createParam(java.lang.String paramKey)
Create a parameter with given unique key.
|
RulesDefinition.DebtRemediationFunctions |
debtRemediationFunctions()
Factory of
DebtRemediationFunction |
java.lang.String |
key() |
RulesDefinition.NewParam |
param(java.lang.String paramKey) |
java.util.Collection<RulesDefinition.NewParam> |
params() |
RuleScope |
scope() |
RulesDefinition.NewRule |
setActivatedByDefault(boolean activatedByDefault)
Should this rule be enabled by default.
|
RulesDefinition.NewRule |
setDebtRemediationFunction(DebtRemediationFunction fn) |
RulesDefinition.NewRule |
setDebtSubCharacteristic(java.lang.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(java.lang.String s)
Deprecated.
since 5.5, replaced by
setGapDescription(String) |
RulesDefinition.NewRule |
setGapDescription(java.lang.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(java.lang.String s)
The optional description, in HTML format, has no max length.
|
RulesDefinition.NewRule |
setHtmlDescription(java.net.URL classpathUrl)
Load description from a file available in classpath.
|
RulesDefinition.NewRule |
setInternalKey(java.lang.String s)
Optional key that can be used by the rule engine.
|
RulesDefinition.NewRule |
setMarkdownDescription(java.lang.String s)
The optional description, in a restricted Markdown format, has no max length.
|
RulesDefinition.NewRule |
setMarkdownDescription(java.net.URL classpathUrl)
Load description from a file available in classpath.
|
RulesDefinition.NewRule |
setName(java.lang.String s)
Required rule name
|
RulesDefinition.NewRule |
setScope(RuleScope scope) |
RulesDefinition.NewRule |
setSeverity(java.lang.String s) |
RulesDefinition.NewRule |
setStatus(RuleStatus status)
Default value is
RuleStatus.READY . |
RulesDefinition.NewRule |
setTags(java.lang.String... list) |
RulesDefinition.NewRule |
setTemplate(boolean template) |
RulesDefinition.NewRule |
setType(RuleType t)
The type as defined by the SonarQube Quality Model.
|
java.lang.String |
toString() |
public java.lang.String key()
@CheckForNull public RuleScope scope()
public RulesDefinition.NewRule setScope(RuleScope scope)
public RulesDefinition.NewRule setName(java.lang.String s)
public RulesDefinition.NewRule setTemplate(boolean template)
public RulesDefinition.NewRule setActivatedByDefault(boolean activatedByDefault)
public RulesDefinition.NewRule setSeverity(java.lang.String s)
public RulesDefinition.NewRule setType(RuleType t)
RuleType.BUG
RuleType.VULNERABILITY
RuleType.BUG
RuleType.CODE_SMELL
public RulesDefinition.NewRule setHtmlDescription(@Nullable java.lang.String s)
setMarkdownDescription(String)
)public RulesDefinition.NewRule setHtmlDescription(@Nullable java.net.URL classpathUrl)
setHtmlDescription(getClass().getResource("/myrepo/Rule1234.html")
public RulesDefinition.NewRule setMarkdownDescription(@Nullable java.lang.String s)
setHtmlDescription(String)
)public RulesDefinition.NewRule setMarkdownDescription(@Nullable java.net.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 java.lang.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 java.lang.String s)
setGapDescription(String)
public RulesDefinition.NewRule setGapDescription(@Nullable java.lang.String s)
public RulesDefinition.NewParam createParam(java.lang.String paramKey)
@CheckForNull public RulesDefinition.NewParam param(java.lang.String paramKey)
public java.util.Collection<RulesDefinition.NewParam> params()
public RulesDefinition.NewRule addTags(java.lang.String... list)
RuleTagFormat
public RulesDefinition.NewRule setTags(java.lang.String... list)
RuleTagFormat
public RulesDefinition.NewRule addOwaspTop10(RulesDefinition.OwaspTop10... standards)
public RulesDefinition.NewRule addCwe(int... nums)
public RulesDefinition.NewRule setInternalKey(@Nullable java.lang.String s)
public RulesDefinition.NewRule addDeprecatedRuleKey(java.lang.String repository, java.lang.String key)
RulesDefinition.Rule.deprecatedRuleKeys
for details).
Deprecated keys should be added with this method in order, oldest first, for documentation purpose.
java.lang.IllegalArgumentException
- if repository
or key
is null
or empty.RulesDefinition.Rule.deprecatedRuleKeys
public java.lang.String toString()
toString
in class java.lang.Object