source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2022 SonarSource SA
   4  * mailto:info AT sonarsource DOT com
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20 package org.sonar.ce.task.projectanalysis.issue;
  21
  22 import java.util.Set;
  23 import javax.annotation.CheckForNull;
  24 import org.sonar.api.rule.RuleKey;
  25 import org.sonar.api.rule.RuleStatus;
  26 import org.sonar.api.rules.RuleType;
  27 import org.sonar.api.server.debt.DebtRemediationFunction;
  28
  29 public interface Rule {
  30   String getUuid();
  31
  32   RuleKey getKey();
  33
  34   String getName();
  35
  36   @CheckForNull
  37   String getLanguage();
  38
  39   RuleStatus getStatus();
  40
  41   /**
  42    * Will be null for external rules
  43    */
  44   @CheckForNull
  45   RuleType getType();
  46
  47   boolean isExternal();
  48
  49   boolean isAdHoc();
  50
  51   /**
  52    * Get all tags, whatever system or user tags.
  53    */
  54   Set<String> getTags();
  55
  56   @CheckForNull
  57   DebtRemediationFunction getRemediationFunction();
  58
  59   @CheckForNull
  60   String getPluginKey();
  61 }