001/* 002 * SonarQube 003 * Copyright (C) 2009-2018 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.Map; 023import javax.annotation.CheckForNull; 024import javax.annotation.concurrent.Immutable; 025 026import org.sonar.api.rule.RuleKey; 027 028/** 029 * Configuration of a rule activated on a Quality profile 030 * @since 4.2 031 */ 032@Immutable 033public interface ActiveRule { 034 035 RuleKey ruleKey(); 036 037 /** 038 * Non-null severity. 039 * @see org.sonar.api.rule.Severity 040 */ 041 String severity(); 042 043 /** 044 * Language of rule, for example <code>java</code> 045 */ 046 String language(); 047 048 /** 049 * Value of given parameter. Returns <code>null</code> if the parameter key does not 050 * exist on the rule or if the parameter has no value nor default value. 051 */ 052 @CheckForNull 053 String param(String key); 054 055 /** 056 * Immutable parameter values. Returns an empty map if no parameters are defined. 057 */ 058 Map<String, String> params(); 059 060 /** 061 * Optional key declared and used by the underlying rule engine. As an example 062 * the key of a Checkstyle rule looks like <code>com.puppycrawl.tools.checkstyle.checks.FooCheck</code> 063 * whereas its internal key can be <code>Checker/TreeWalker/Foo</code>. 064 */ 065 @CheckForNull 066 String internalKey(); 067 068 /** 069 * Optional rule key of the template rule. 070 * @since 4.5.3 071 */ 072 @CheckForNull 073 String templateRuleKey(); 074}