org.sonar.api.batch.rule.ActiveRules Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-plugin-api Show documentation
The newest version!
/*
 * SonarQube
 * Copyright (C) 2009-2022 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program 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.
 *
 * This program 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.scanner.ScannerSide;
import org.sonar.api.rule.RuleKey;

import javax.annotation.CheckForNull;
import javax.annotation.concurrent.Immutable;

import java.util.Collection;

/**
 * The rules that are activated on the current project. Quality profiles are
 * merged, so rules can relate to different repositories and languages.
 * 

 * Use {@link org.sonar.api.batch.rule.internal.ActiveRulesBuilder} available in sonar-plugin-api-impl to instantiate
 * this component in unit tests.
 *
 * @since 4.2
 */
@Immutable
@ScannerSide
public interface ActiveRules {

  /**
   * 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 project.
   */
  @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);

  /**
   * Find a {@link ActiveRule} by the associated internal key. null
   * is returned if the rule does not exist or if the rule is not activated
   * on any Quality profile associated with the project.
   */
  @CheckForNull
  ActiveRule findByInternalKey(String repository, String internalKey);

}