org.sonar.api.batch.rule

Interface ActiveRule

All Known Implementing Classes:

DefaultActiveRule

public interface ActiveRule

Configuration of a rule activated on a Quality profile

Since:

4.2

Method Summary

Modifier and Type	Method and Description
String	internalKey() Optional key declared and used by the underlying rule engine.
String	language() Language of rule, for example java
String	param(String key) Value of given parameter.
Map<String,String>	params() Immutable parameter values.
RuleKey	ruleKey()
String	severity() Non-null severity.
String	templateRuleKey() Optional rule key of the template rule.

Method Detail

ruleKey

RuleKey ruleKey()

severity

String severity()

Non-null severity.

See Also:

Severity

language

String language()

Language of rule, for example java

param

@CheckForNull
String param(String key)

Value of given parameter. Returns null if the parameter key does not exist on the rule or if the parameter has no value nor default value.

params

Map<String,String> params()

Immutable parameter values. Returns an empty map if no parameters are defined.

internalKey

@CheckForNull
String internalKey()

Optional key declared and used by the underlying rule engine. As an example the key of a Checkstyle rule looks like com.puppycrawl.tools.checkstyle.checks.FooCheck whereas its internal key can be Checker/TreeWalker/Foo.

templateRuleKey

@CheckForNull
String templateRuleKey()

Optional rule key of the template rule.

Since:

4.5.3