001    /*
002     * SonarQube, open source software quality management tool.
003     * Copyright (C) 2008-2014 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * SonarQube 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     * SonarQube 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     */
020    package org.sonar.api.rules;
021    
022    import org.sonar.api.ServerComponent;
023    import org.sonar.api.rule.RuleKey;
024    import org.sonar.api.task.TaskComponent;
025    
026    import javax.annotation.CheckForNull;
027    
028    import java.util.Collection;
029    
030    /**
031     * @since 2.3
032     */
033    public interface RuleFinder extends TaskComponent, ServerComponent {
034    
035      /**
036       * @since 2.5
037       * @deprecated since 4.4, Please use {@link #findByKey(org.sonar.api.rule.RuleKey)}}
038       */
039      @CheckForNull
040      @Deprecated
041      Rule findById(int ruleId);
042    
043      @CheckForNull
044      Rule findByKey(String repositoryKey, String key);
045    
046      @CheckForNull
047      Rule findByKey(RuleKey key);
048    
049      /**
050       * @throw NonUniqueResultException if more than one result
051       */
052      @CheckForNull
053      Rule find(RuleQuery query);
054    
055      Collection<Rule> findAll(RuleQuery query);
056    
057    }