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 */
020package org.sonar.api.batch.rule;
021
022import org.sonar.api.rule.RuleKey;
023
024import javax.annotation.CheckForNull;
025
026import java.util.Collection;
027
028/**
029 * Searches for rules. This component is available by dependency injection. It must not
030 * be extended by plugins.
031 *
032 * @since 4.2
033 */
034public interface Rules {
035
036  /**
037   * Get a rule by its key. Returns <code>null</code> if rule does not exist.
038   */
039  @CheckForNull
040  Rule find(RuleKey key);
041
042  Collection<Rule> findAll();
043
044  /**
045   * Get the rules of the given repository. Returns an empty collection if the
046   * repository does not exist.
047   */
048  Collection<Rule> findByRepository(String repository);
049
050}