org.sonar.api.rules
Class RulesManager

java.lang.Object
  org.sonar.api.rules.RulesManager

Deprecated. UGLY COMPONENT - WILL BE COMPLETELY REFACTORED IN SONAR 2.3

@Deprecated
public abstract class RulesManager
extends java.lang.Object

Manage and access rules defined in Sonar.

Constructor Summary

RulesManager()
Deprecated.

Method Summary

abstract java.util.Map<java.lang.String,java.lang.Long>	countRulesByCategory(Language language) Deprecated. Gets count of rules by categories defined for a given language
abstract java.util.List<Plugin>	getExportablePlugins(Language language) Deprecated. Get the list of rules plugin that implement a mechanism of export for a given language
abstract java.util.List<Plugin>	getImportablePlugins(Language language) Deprecated. Get the list of rules plugin that implement a mechanism of import for a given language
abstract java.util.Set<Language>	getLanguages() Deprecated. Returns the list of languages for which there is a rule repository
abstract Rule	getPluginRule(java.lang.String pluginKey, java.lang.String ruleKey) Deprecated. Gets a rule belonging to a defined plugin based on its key
abstract java.util.Collection<Rule>	getPluginRules(java.lang.String pluginKey) Deprecated. Gets a collection of rules belonging to a plugin
abstract java.util.Map<java.lang.String,Rule>	getPluginRulesIndexedByKey(java.lang.String pluginKey) Deprecated. Gets a list of rules indexed by their key for a given plugin
abstract java.util.List<Plugin>	getPlugins(Language language) Deprecated. Gets the list of rules plugins for a given language
abstract java.util.List<RulesRepository<?>>	getRulesRepositories() Deprecated. Gets the complete list of Rules Repositories in the Sonar instance
abstract java.util.List<RulesRepository<?>>	getRulesRepositories(Language language) Deprecated. Gets the list of Rules Repositories available for a language

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RulesManager

public RulesManager()

Deprecated.

Method Detail

getLanguages

public abstract java.util.Set<Language> getLanguages()

Deprecated.

Returns the list of languages for which there is a rule repository

Returns:

a Set of languages

getRulesRepositories

public abstract java.util.List<RulesRepository<?>> getRulesRepositories(Language language)

Deprecated.

Gets the list of Rules Repositories available for a language

Parameters:

language - the language

Returns:

the list of rules repositories

getRulesRepositories

public abstract java.util.List<RulesRepository<?>> getRulesRepositories()

Deprecated.

Gets the complete list of Rules Repositories in the Sonar instance

Returns:

the list of rules repositories

getPlugins

public abstract java.util.List<Plugin> getPlugins(Language language)

Deprecated.

Gets the list of rules plugins for a given language

Parameters:

language - the language

Returns:

the list of plugins

countRulesByCategory

public abstract java.util.Map<java.lang.String,java.lang.Long> countRulesByCategory(Language language)

Deprecated.

Gets count of rules by categories defined for a given language

Parameters:

language - the language

Returns:

a Map with the category as key and the count as value

getExportablePlugins

public abstract java.util.List<Plugin> getExportablePlugins(Language language)

Deprecated.

Get the list of rules plugin that implement a mechanism of export for a given language

Parameters:

language - the language

Returns:

the list of plugins

getImportablePlugins

public abstract java.util.List<Plugin> getImportablePlugins(Language language)

Deprecated.

Get the list of rules plugin that implement a mechanism of import for a given language

Parameters:

language - the language

Returns:

the list of plugins

getPluginRulesIndexedByKey

public abstract java.util.Map<java.lang.String,Rule> getPluginRulesIndexedByKey(java.lang.String pluginKey)

Deprecated.

Gets a list of rules indexed by their key for a given plugin

Parameters:

pluginKey - the plugin key

Returns:

a Map with the rule key and the rule

getPluginRules

public abstract java.util.Collection<Rule> getPluginRules(java.lang.String pluginKey)

Deprecated.

Gets a collection of rules belonging to a plugin

Parameters:

pluginKey - the plugin key

Returns:

the collection of rules

getPluginRule

public abstract Rule getPluginRule(java.lang.String pluginKey,
                                   java.lang.String ruleKey)

Deprecated.

Gets a rule belonging to a defined plugin based on its key

Parameters:

pluginKey - the plugin key

ruleKey - the rule key

Returns:

the rule