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    @Deprecated
035    public interface RulesRepository<LANG extends Language> extends BatchExtension, ServerExtension {
036    
037      /**
038       * @return the language the repository is associated
039       */
040      LANG getLanguage();
041    
042      /**
043       * @return the list of rules of the repository
044       */
045      List<Rule> getInitialReferential();
046    
047      /**
048       * The method to parse the base referential of rules and return a list of rules
049       *
050       * @param fileContent the initial referential
051       * @return a list of rules
052       */
053      List<Rule> parseReferential(String fileContent);
054    
055      /**
056       * @return a list of profiles that are provided with the referential
057       */
058      List<RulesProfile> getProvidedProfiles();
059    
060    }