public class Checks<C>
extends java.lang.Object
@org.sonar.check.Rule(key = "S001") public class CheckS001 { @org.sonar.check.RuleProperty private String pattern; public String getPattern() { return pattern; } }How to use:
public class MyRuleEngine extends BatchExtension { private final CheckFactory checkFactory; public MyRuleEngine(CheckFactory checkFactory) { this.checkFactory = checkFactory; } public void execute() { Checks checks = checkFactory.create("my-rule-repository"); checks.addAnnotatedChecks(CheckS001.class); // checks.all() contains an instance of CheckS001 // with field "pattern" set to the value specified in // the Quality profile // Checks are used to detect issues on source code // checks.ruleKey(obj) can be used to create the related issues } }
Modifier and Type | Method and Description |
---|---|
Checks<C> |
addAnnotatedChecks(java.util.Collection checkClassesOrObjects)
Deprecated.
since 5.2 use
addAnnotatedChecks(Iterable) |
Checks<C> |
addAnnotatedChecks(java.lang.Iterable checkClassesOrObjects) |
Checks<C> |
addAnnotatedChecks(java.lang.Object... checkClassesOrObjects) |
java.util.Collection<C> |
all() |
C |
of(RuleKey ruleKey) |
RuleKey |
ruleKey(C check) |
public java.util.Collection<C> all()
@Deprecated public Checks<C> addAnnotatedChecks(java.util.Collection checkClassesOrObjects)
addAnnotatedChecks(Iterable)