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