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.batch.rule; 021 022 import org.sonar.api.batch.debt.DebtRemediationFunction; 023 import org.sonar.api.rule.RuleKey; 024 import org.sonar.api.rule.RuleStatus; 025 026 import javax.annotation.CheckForNull; 027 import java.util.Collection; 028 029 /** 030 * @since 4.2 031 */ 032 public interface Rule { 033 034 RuleKey key(); 035 036 String name(); 037 038 @CheckForNull 039 String description(); 040 041 @CheckForNull 042 String internalKey(); 043 044 String severity(); 045 046 @CheckForNull 047 RuleParam param(String paramKey); 048 049 Collection<RuleParam> params(); 050 051 RuleStatus status(); 052 053 /** 054 * Sub characteristic key. 055 * 056 * @since 4.3 057 */ 058 @CheckForNull 059 String debtSubCharacteristic(); 060 061 /** 062 * Remediation function : can by Linear (with a coefficient), Linear with offset (with a coefficient and an offset) or Constant per issue (with an offset) 063 * 064 * @since 4.3 065 */ 066 @CheckForNull 067 DebtRemediationFunction debtRemediationFunction(); 068 069 }