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