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

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2023 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.Map;
  23 import java.util.Set;
  24 import javax.annotation.CheckForNull;
  25 import org.sonar.api.issue.impact.Severity;
  26 import org.sonar.api.issue.impact.SoftwareQuality;
  27 import org.sonar.api.rule.RuleKey;
  28 import org.sonar.api.rule.RuleStatus;
  29 import org.sonar.api.rules.CleanCodeAttribute;
  30 import org.sonar.api.rules.RuleType;
  31 import org.sonar.api.server.debt.DebtRemediationFunction;
  32
  33 public interface Rule {
  34   String getUuid();
  35
  36   RuleKey getKey();
  37
  38   String getName();
  39
  40   @CheckForNull
  41   String getLanguage();
  42
  43   RuleStatus getStatus();
  44
  45   /**
  46    * Will be null for external rules
  47    */
  48   @CheckForNull
  49   RuleType getType();
  50
  51   boolean isExternal();
  52
  53   boolean isAdHoc();
  54
  55   /**
  56    * Get all tags, whatever system or user tags.
  57    */
  58   Set<String> getTags();
  59
  60   @CheckForNull
  61   DebtRemediationFunction getRemediationFunction();
  62
  63   @CheckForNull
  64   String getPluginKey();
  65
  66   String getDefaultRuleDescription();
  67
  68   String getSeverity();
  69
  70   Set<String> getSecurityStandards();
  71
  72   Map<SoftwareQuality, Severity> getDefaultImpacts();
  73
  74   @CheckForNull
  75   CleanCodeAttribute cleanCodeAttribute();
  76 }