001    /*
002     * SonarQube, open source software quality management tool.
003     * Copyright (C) 2008-2014 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * SonarQube 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     * SonarQube 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 License
017     * along with this program; if not, write to the Free Software Foundation,
018     * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019     */
020    package org.sonar.api.batch.rule;
021    
022    import org.sonar.api.BatchComponent;
023    import org.sonar.api.rule.RuleKey;
024    
025    import javax.annotation.CheckForNull;
026    
027    import java.util.Collection;
028    
029    /**
030     * Searches for rules. This component is available by dependency injection. It must not
031     * be extended by plugins.
032     *
033     * @since 4.2
034     */
035    public interface Rules extends BatchComponent {
036    
037      /**
038       * Get a rule by its key. Returns <code>null</code> if rule does not exist.
039       */
040      @CheckForNull
041      Rule find(RuleKey key);
042    
043      Collection<Rule> findAll();
044    
045      /**
046       * Get the rules of the given repository. Returns an empty collection if the
047       * repository does not exist.
048       */
049      Collection<Rule> findByRepository(String repository);
050    
051    }