org.sonar.api.batch.rule.ActiveRules Maven / Gradle / Ivy
/*
* SonarQube, open source software quality management tool.
* Copyright (C) 2008-2014 SonarSource
* mailto:contact AT sonarsource DOT com
*
* SonarQube is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* SonarQube is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.api.batch.rule;
import org.sonar.api.BatchComponent;
import org.sonar.api.rule.RuleKey;
import javax.annotation.CheckForNull;
import java.util.Collection;
/**
* The rules that are activated on the current module. Quality profiles are
* merged, so rules can relate to different repositories and languages.
*
* Use {@link org.sonar.api.batch.rule.internal.ActiveRulesBuilder} to instantiate
* this component in unit tests.
*
* @since 4.2
*/
public interface ActiveRules extends BatchComponent {
/**
* Find a {@link ActiveRule} by the associated rule key. null
* is returned if the rule does not exist or if the rule is not activated
* on any Quality profile associated with the module.
*/
@CheckForNull
ActiveRule find(RuleKey ruleKey);
/**
* All the active rules, whatever their repository and related language.
*/
Collection findAll();
/**
* The active rules for a given repository, like findbugs
*/
Collection findByRepository(String repository);
/**
* The active rules for a given language, like java
*/
Collection findByLanguage(String language);
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy