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.batch.rule;
021
022import java.util.Collection;
023import javax.annotation.CheckForNull;
024import org.sonar.api.batch.debt.DebtRemediationFunction;
025import org.sonar.api.rule.RuleKey;
026import org.sonar.api.rule.RuleStatus;
027
028/**
029 * @since 4.2
030 */
031public interface Rule {
032
033  RuleKey key();
034
035  String name();
036
037  @CheckForNull
038  String description();
039
040  @CheckForNull
041  String internalKey();
042
043  String severity();
044
045  @CheckForNull
046  RuleParam param(String paramKey);
047
048  Collection<RuleParam> params();
049
050  RuleStatus status();
051
052  /**
053   * @since 4.3
054   * @deprecated since 5.2 as any computation of data are moved to server's Compute Engine. Calling this method throws an exception.
055   */
056  @CheckForNull
057  @Deprecated
058  String debtSubCharacteristic();
059
060  /**
061   * @since 4.3
062   * @deprecated since 5.2 as any computation of data are moved to server's Compute Engine. Calling this method throws an exception.
063   */
064  @CheckForNull
065  @Deprecated
066  DebtRemediationFunction debtRemediationFunction();
067
068}