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.rules;
021
022import java.util.Collection;
023import javax.annotation.CheckForNull;
024import org.sonar.api.batch.ScannerSide;
025import org.sonar.api.batch.rule.ActiveRules;
026import org.sonar.api.rule.RuleKey;
027import org.sonar.api.ce.ComputeEngineSide;
028import org.sonar.api.server.ServerSide;
029
030/**
031 * @since 2.3
032 * @deprecated since 5.1. Use {@link ActiveRules} on batch side.
033 */
034@Deprecated
035@ScannerSide
036@ServerSide
037@ComputeEngineSide
038public interface RuleFinder {
039
040  /**
041   * @since 2.5
042   * @deprecated since 4.4, Please use {@link #findByKey(org.sonar.api.rule.RuleKey)}}
043   */
044  @CheckForNull
045  @Deprecated
046  Rule findById(int ruleId);
047
048  @CheckForNull
049  Rule findByKey(String repositoryKey, String key);
050
051  @CheckForNull
052  Rule findByKey(RuleKey key);
053
054  /**
055   * @throws IllegalArgumentException if more than one result
056   */
057  @CheckForNull
058  Rule find(RuleQuery query);
059
060  Collection<Rule> findAll(RuleQuery query);
061
062}