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