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

Type Parameters:
LANG -
All Superinterfaces:
BatchExtension, Extension, ServerExtension
All Known Implementing Classes:
AbstractImportableRulesRepository, AbstractRulesRepository

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

The interface to implement to create a repository of rules


Method Summary
 java.util.List<Rule> getInitialReferential()
           
 LANG getLanguage()
           
 java.util.List<RulesProfile> getProvidedProfiles()
           
 java.util.List<Rule> parseReferential(java.lang.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

java.util.List<Rule> getInitialReferential()
Returns:
the list of rules of the repository

parseReferential

java.util.List<Rule> parseReferential(java.lang.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

java.util.List<RulesProfile> getProvidedProfiles()
Returns:
a list of profiles that are provided with the referential


Copyright © 2009-2010 SonarSource SA. All Rights Reserved.