001/* 002 * SonarQube 003 * Copyright (C) 2009-2016 SonarSource SA 004 * mailto:contact AT sonarsource DOT com 005 * 006 * This program 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 * This program 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.batch.ScannerSide; 023import org.sonar.api.rule.RuleKey; 024 025import javax.annotation.CheckForNull; 026 027import java.util.Collection; 028 029/** 030 * The rules that are activated on the current module. Quality profiles are 031 * merged, so rules can relate to different repositories and languages. 032 * <br> 033 * Use {@link org.sonar.api.batch.rule.internal.ActiveRulesBuilder} to instantiate 034 * this component in unit tests. 035 * 036 * @since 4.2 037 */ 038@ScannerSide 039public interface ActiveRules { 040 041 /** 042 * Find a {@link ActiveRule} by the associated rule key. <code>null</code> 043 * is returned if the rule does not exist or if the rule is not activated 044 * on any Quality profile associated with the module. 045 */ 046 @CheckForNull 047 ActiveRule find(RuleKey ruleKey); 048 049 /** 050 * All the active rules, whatever their repository and related language. 051 */ 052 Collection<ActiveRule> findAll(); 053 054 /** 055 * The active rules for a given repository, like <code>findbugs</code> 056 */ 057 Collection<ActiveRule> findByRepository(String repository); 058 059 /** 060 * The active rules for a given language, like <code>java</code> 061 */ 062 Collection<ActiveRule> findByLanguage(String language); 063 064 /** 065 * Find a {@link ActiveRule} by the associated internal key. <code>null</code> 066 * is returned if the rule does not exist or if the rule is not activated 067 * on any Quality profile associated with the module. 068 */ 069 @CheckForNull 070 ActiveRule findByInternalKey(String repository, String internalKey); 071 072}