org.sonar.api.rules
Interface RulesRepository<LANG extends Language>

Type Parameters:

LANG -

All Superinterfaces:

BatchExtension, Extension, ServerExtension

All Known Implementing Classes:

AbstractImportableRulesRepository, AbstractRulesRepository, CheckToRuleRepositoryBridge

public interface RulesRepository<LANG extends Language>
extends BatchExtension, ServerExtension

The interface to implement to create a repository of rules

Method Summary

List<Rule>	getInitialReferential()
LANG	getLanguage()
List<RulesProfile>	getProvidedProfiles()
List<Rule>	parseReferential(String fileContent) The method to parse the base referential of rules and return a list of rules

Method Detail

getLanguage

LANG getLanguage()

Returns:

the language the repository is associated

getInitialReferential

List<Rule> getInitialReferential()

Returns:

the list of rules of the repository

parseReferential

List<Rule> parseReferential(String fileContent)

The method to parse the base referential of rules and return a list of rules

Parameters:

fileContent - the initial referential

Returns:

a list of rules

getProvidedProfiles

List<RulesProfile> getProvidedProfiles()

Returns:

a list of profiles that are provided with the referential