001/*
002 * SonarQube, open source software quality management tool.
003 * Copyright (C) 2008-2013 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.BatchComponent;
023import org.sonar.api.rule.RuleKey;
024
025import javax.annotation.CheckForNull;
026import java.util.Collection;
027
028/**
029 * The rules that are activated on the current module. Quality profiles are
030 * merged, so rules can relate to different repositories and languages.
031 * <p/>
032 * Use {@link org.sonar.api.batch.rule.internal.ActiveRulesBuilder} to instantiate
033 * this component in unit tests.
034 * @since 4.2
035 */
036public interface ActiveRules extends BatchComponent {
037
038  /**
039   * Find a {@link ActiveRule} by the associated rule key. <code>null</code>
040   * is returned if the rule does not exist or if the rule is not activated
041   * on any Quality profile associated with the module.
042   */
043  @CheckForNull
044  ActiveRule find(RuleKey ruleKey);
045
046  /**
047   * All the active rules, whatever their repository and related language.
048   */
049  Collection<ActiveRule> findAll();
050
051  /**
052   * The active rules for a given repository, like Findbugs
053   */
054  Collection<ActiveRule> findByRepository(String repository);
055
056}