org.sonar.api.server.rule
Class RulesDefinitionXmlLoader

java.lang.Object
  extended by org.sonar.api.server.rule.RulesDefinitionXmlLoader
All Implemented Interfaces:
ServerComponent

public class RulesDefinitionXmlLoader
extends Object
implements ServerComponent

Loads definitions of rules from a XML file.

XML Format

 <rules>
   <rule>
     <!-- required fields -->
     <key>the-rule-key</key>
     <name>The purpose of the rule</name>

     <!-- optional fields -->
     <description>
       <![CDATA[The description]]>
     </description>
     <internalKey>Checker/TreeWalker/LocalVariableName</internalKey>
     <severity>BLOCKER</severity>
     <cardinality>MULTIPLE</cardinality>
     <status>BETA</status>
     <param>
       <key>the-param-key</key>
       <tag>style</tag>
       <tag>security</tag>
       <description>
         <![CDATA[the param-description]]>
       </description>
       <defaultValue>42</defaultValue>
     </param>
     <param>
       <key>another-param</key>
     </param>

     <!-- deprecated fields -->
     <configKey>Checker/TreeWalker/LocalVariableName</configKey>
     <priority>BLOCKER</priority>
   </rule>
 </rules>
 

Since:
4.3
See Also:
RulesDefinition

Constructor Summary
RulesDefinitionXmlLoader()
           
 
Method Summary
 void load(RulesDefinition.NewRepository repo, InputStream input, String encoding)
           
 void load(RulesDefinition.NewRepository repo, Reader reader)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RulesDefinitionXmlLoader

public RulesDefinitionXmlLoader()
Method Detail

load

public void load(RulesDefinition.NewRepository repo,
                 InputStream input,
                 String encoding)

load

public void load(RulesDefinition.NewRepository repo,
                 Reader reader)


Copyright © 2009–2016 SonarSource. All rights reserved.