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