Uses of Class
org.sonar.api.rules.Rule

Packages that use Rule

Package	Description
org.sonar.api.i18n
org.sonar.api.measures
org.sonar.api.profiles
org.sonar.api.rules

Uses of Rule in org.sonar.api.i18n

Methods in org.sonar.api.i18n with parameters of type Rule

Modifier and Type	Method and Description
String	RuleI18n.getName(Rule rule) Deprecated. Returns the name of the rule.
String	RuleI18n.getName(Rule rule, Locale locale) Deprecated. since 4.1. Rules are not localized anymore. See http://jira.sonarsource.com/browse/SONAR-4885

Uses of Rule in org.sonar.api.measures

Methods in org.sonar.api.measures that return Rule

Modifier and Type	Method and Description
Rule	RuleMeasure.getRule() Deprecated. since 4.4 use RuleMeasure.ruleKey()

Methods in org.sonar.api.measures with parameters of type Rule

Modifier and Type	Method and Description
static RuleMeasure	RuleMeasure.createForRule(Metric metric, Rule rule, Double value) Deprecated. since 4.4 use RuleMeasure.createForRule(Metric, RuleKey, Double)
static MeasuresFilter<RuleMeasure>	MeasuresFilters.rule(Metric metric, Rule rule)
RuleMeasure	RuleMeasure.setRule(Rule rule) Deprecated. since 4.4 use RuleMeasure.setRuleKey(org.sonar.api.rule.RuleKey)

Constructors in org.sonar.api.measures with parameters of type Rule

Constructor and Description
RuleMeasure(Metric metric, Rule rule, RulePriority rulePriority, Integer ruleCategory) Deprecated. since 4.4 use RuleMeasure.RuleMeasure(Metric, RuleKey, RulePriority, Integer)

Uses of Rule in org.sonar.api.profiles

Methods in org.sonar.api.profiles with parameters of type Rule

Modifier and Type	Method and Description
ActiveRule	RulesProfile.activateRule(Rule rule, RulePriority optionalSeverity)
ActiveRule	RulesProfile.getActiveRule(Rule rule) Note: disabled rules are excluded.

Uses of Rule in org.sonar.api.rules

Methods in org.sonar.api.rules that return Rule

Modifier and Type	Method and Description
static Rule	Rule.create()
static Rule	Rule.create(String repositoryKey, String key) Create with all required fields
static Rule	Rule.create(String repositoryKey, String key, String name) Create with all required fields
Rule	RuleFinder.find(RuleQuery query) Deprecated.
Rule	RuleFinder.findById(int ruleId) Deprecated. since 4.4, Please use RuleFinder.findByKey(org.sonar.api.rule.RuleKey)}
Rule	RuleFinder.findByKey(RuleKey key) Deprecated.
Rule	RuleFinder.findByKey(String repositoryKey, String key) Deprecated.
Rule	Rule.getParent() Deprecated. since 4.4, use getTemplate()
Rule	RuleParam.getRule()
Rule	ActiveRule.getRule()
Rule	Rule.getTemplate()
Rule	Rule.setCardinality(Cardinality c) Deprecated. since 4.4, use setIsTemplate(boolean)
Rule	Rule.setCharacteristicId(Integer characteristicId) Deprecated. since 4.4, use setCharacteristicKey(String)
Rule	Rule.setCharacteristicKey(String characteristicKey)
Rule	Rule.setConfigKey(String configKey) Sets the configuration key
Rule	Rule.setCreatedAt(Date d)
Rule	Rule.setDefaultCharacteristicId(Integer defaultCharacteristicId) Deprecated. since 4.4, use setDefaultCharacteristicKey(String)
Rule	Rule.setDefaultCharacteristicKey(String defaultCharacteristicKey)
Rule	Rule.setDefaultSubCharacteristicKey(String defaultSubCharacteristicKey)
Rule	Rule.setDescription(String description) Sets the rule description
Rule	Rule.setIsTemplate(boolean isTemplate)
Rule	Rule.setKey(String key) Sets the rule key
Rule	Rule.setLanguage(String language) For internal use only.
Rule	Rule.setName(String name) Sets the rule name
Rule	Rule.setParams(List<RuleParam> params) Sets the rule parameters
Rule	Rule.setParent(Rule parent) Deprecated. since 4.4, use setTemplate(Rule)}
Rule	Rule.setRepositoryKey(String s)
Rule	Rule.setSeverity(RulePriority severity)
Rule	Rule.setStatus(String status)
Rule	Rule.setSubCharacteristicKey(String subCharacteristicKey)
Rule	Rule.setTags(String[] tags) For definition of rule only
Rule	Rule.setTemplate(Rule template)
Rule	Rule.setUniqueKey(String repositoryKey, String key)
Rule	Rule.setUpdatedAt(Date updatedAt)

Methods in org.sonar.api.rules that return types with arguments of type Rule

Modifier and Type	Method and Description
abstract List<Rule>	RuleRepository.createRules() Deprecated.
Collection<Rule>	RuleFinder.findAll(RuleQuery query) Deprecated.
List<Rule>	XMLRuleParser.parse(File file) Deprecated.
List<Rule>	XMLRuleParser.parse(InputStream input) Deprecated. Warning : the input stream is closed in this method
List<Rule>	XMLRuleParser.parse(Reader reader) Deprecated.
List<Rule>	AnnotationRuleParser.parse(String repositoryKey, Collection<Class> annotatedClasses) Deprecated.

Methods in org.sonar.api.rules with parameters of type Rule

Modifier and Type	Method and Description
Rule	Rule.setParent(Rule parent) Deprecated. since 4.4, use setTemplate(Rule)}
void	ActiveRule.setRule(Rule rule) Deprecated. visibility should be reduced to protected or package
Rule	Rule.setTemplate(Rule template)

Constructors in org.sonar.api.rules with parameters of type Rule

Constructor and Description
ActiveRule(RulesProfile profile, Rule rule, RulePriority severity) Deprecated. visibility should be reduced to protected or package
RuleParam(Rule rule, String key, String description, String type) Deprecated. since 2.3 use the factory method setParameter()