001 /* 002 * Sonar, open source software quality management tool. 003 * Copyright (C) 2009 SonarSource SA 004 * mailto:contact AT sonarsource DOT com 005 * 006 * Sonar is free software; you can redistribute it and/or 007 * modify it under the terms of the GNU Lesser General Public 008 * License as published by the Free Software Foundation; either 009 * version 3 of the License, or (at your option) any later version. 010 * 011 * Sonar is distributed in the hope that it will be useful, 012 * but WITHOUT ANY WARRANTY; without even the implied warranty of 013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014 * Lesser General Public License for more details. 015 * 016 * You should have received a copy of the GNU Lesser General Public 017 * License along with Sonar; if not, write to the Free Software 018 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02 019 */ 020 package org.sonar.api.rules; 021 022 import org.sonar.api.BatchExtension; 023 import org.sonar.api.ServerExtension; 024 import org.sonar.api.profiles.RulesProfile; 025 import org.sonar.api.resources.Language; 026 027 import java.util.List; 028 029 /** 030 * The interface to implement to create a repository of rules 031 * 032 * @param <LANG> 033 */ 034 public interface RulesRepository<LANG extends Language> extends BatchExtension, ServerExtension { 035 036 /** 037 * @return the language the repository is associated 038 */ 039 LANG getLanguage(); 040 041 /** 042 * @return the list of rules of the repository 043 */ 044 List<Rule> getInitialReferential(); 045 046 /** 047 * The method to parse the base referential of rules and return a list of rules 048 * 049 * @param fileContent the initial referential 050 * @return a list of rules 051 */ 052 List<Rule> parseReferential(String fileContent); 053 054 /** 055 * @return a list of profiles that are provided with the referential 056 */ 057 List<RulesProfile> getProvidedProfiles(); 058 059 }