<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="Welcome to the documentation site for PMD and CPD! ">
<meta name="keywords" content=" java">
<title>Documentation Index | PMD Source Code Analyzer</title>


<link rel="stylesheet" type="text/css" href="assets/fontawesome-free-5.15.4-web/css/all.min.css">
<link rel="stylesheet" type="text/css" href="assets/bootstrap-4.5.2-dist/css/bootstrap.min.css">

<link rel="stylesheet" type="text/css" href="css/syntax.css">
<link rel="stylesheet" type="text/css" href="css/modern-business.css">
<link rel="stylesheet" type="text/css" href="css/customstyles.css">
<link rel="stylesheet" type="text/css" href="css/theme-green.css">
<link rel="stylesheet" type="text/css" href="css/pmd-customstyles.css">

<link rel="shortcut icon" href="images/logo/favicon.ico" type="image/x-icon">
<link rel="icon" href="images/logo/favicon.ico" type="image/x-icon">

<link rel="alternate" type="application/rss+xml" title="" href="feed.xml">

</head>
<body>
<!-- Content is offset by the height of the topnav bar. -->
<!-- There's already a padding-top rule in modern-business.css, but it apparently doesn't work on Firefox 60 and Chrome 67 -->
<div id="topbar-content-offset">
<!-- Navigation -->
<nav class="navbar navbar-expand-lg fixed-top navbar-dark">
    <div class="container topnavlinks">
        <a class="navbar-brand fas fa-home fa-lg" href="index.html">&nbsp;<span class="projectTitle"> PMD Source Code Analyzer Project</span></a>
        <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
            <span class="navbar-toggler-icon"></span>
        </button>

        <div class="collapse navbar-collapse" id="navbarSupportedContent">
            <ul class="navbar-nav mr-auto mt-2 mt-lg-0"></ul>
            <ul class="navbar-nav">
                <!-- toggle sidebar button -->
                <li class="nav-item"><a id="tg-sb-link" class="nav-link" href="#"><i id="tg-sb-icon" class="fas fa-toggle-on"></i> Nav</a></li>
                <!-- entries without drop-downs appear here -->
                
                    
                        
                            <li class="nav-item"><a class="nav-link" href="https://github.com/pmd/pmd/releases/latest" target="_blank">Download</a></li>
                        
                    
                        
                            <li class="nav-item"><a class="nav-link" href="https://github.com/pmd/pmd" target="_blank">Fork us on github</a></li>
                        
                    
                
                <!-- entries with drop-downs appear here -->
                <!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->
                
            </ul>
            <form class="form-inline my-2 my-lg-0">
                <input class="form-control mr-sm-2" type="search" placeholder="search..." id="search-input">
                <ul id="results-container"></ul>
            </form>
        </div>
    </div>
</nav>

<!-- Page Content -->
<div class="container-toc-wrapper">
    <div class="container">
        <div class="col-lg-12">&nbsp;</div>
        <!-- Content Row -->
        <div class="row">
            
            
            <!-- Sidebar Column -->
            <div class="col-md-3" id="tg-sb-sidebar">
                








<ul id="mysidebar" class="nav">
    <li class="sidebarTitle">PMD 7.0.1-SNAPSHOT</li>
    <div class="sidebarTitleDate">Release date: 26-April-2024</div>
    
    
    
        
    
    <li>
        
        <a href="#">About</a>
        
        <ul>
            
            

            

                
                <li class="active"><a href="index.html">Home</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_release_notes.html">Release notes</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_release_notes_pmd7.html">Release notes (PMD 7)</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_about_help.html">Getting help</a></li>
                

            

            
            
        </ul>
     </li>
       
        
    
    <li>
        
        <a href="#">User Documentation</a>
        
        <ul>
            
            

            

                
                <li><a href="pmd_userdocs_migrating_to_pmd7.html">Migration Guide for PMD 7</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_userdocs_installation.html">Installation and basic CLI usage</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_userdocs_making_rulesets.html">Making rulesets</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_userdocs_configuring_rules.html">Configuring rules</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_userdocs_best_practices.html">Best practices</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_userdocs_suppressing_warnings.html">Suppressing warnings</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_userdocs_incremental_analysis.html">Incremental analysis</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_userdocs_cli_reference.html">PMD CLI reference</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_userdocs_report_formats.html">PMD Report formats</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_userdocs_3rdpartyrulesets.html">3rd party rulesets</a></li>
                

            

            
            
            

            

                
                
                <li class="subfolders">
                    <a href="#">CPD reference</a>
                    <ul>
                        
                        
                        
                        <li><a href="pmd_userdocs_cpd.html">Copy-paste detection</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_userdocs_cpd_report_formats.html">CPD Report formats</a></li>
                        
                        
                        
                    </ul>
                </li>
                
                

            

            
            
            

            

                
                
                <li class="subfolders">
                    <a href="#">Extending PMD</a>
                    <ul>
                        
                        
                        
                        <li><a href="pmd_userdocs_extending_writing_rules_intro.html">Introduction to writing rules</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_userdocs_extending_your_first_rule.html">Your first rule</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_userdocs_extending_writing_xpath_rules.html">XPath rules</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_userdocs_extending_writing_java_rules.html">Java rules</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_userdocs_extending_designer_reference.html">Rule designer reference</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_userdocs_extending_defining_properties.html">Defining rule properties</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_userdocs_extending_rule_guidelines.html">Rule guidelines</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_userdocs_extending_testing.html">Testing your rules</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_userdocs_extending_ast_dump.html">Creating (XML) dump of the AST</a></li>
                        
                        
                        
                    </ul>
                </li>
                
                

            

            
            
            

            

                
                
                <li class="subfolders">
                    <a href="#">Tools / Integrations</a>
                    <ul>
                        
                        
                        
                        <li><a href="pmd_userdocs_tools_maven.html">Maven PMD Plugin</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_userdocs_tools_gradle.html">Gradle</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_userdocs_tools_ant.html">Ant</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_userdocs_tools_java_api.html">PMD Java API</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_userdocs_tools_bld.html">bld PMD Extension</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_userdocs_tools_ci.html">CI integrations</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_userdocs_tools.html">Other Tools / Integrations</a></li>
                        
                        
                        
                    </ul>
                </li>
                
                

            

            
            
        </ul>
     </li>
       
        
    
    <li>
        
        <a href="#">Rule Reference</a>
        
        <ul>
            
            

            

                
                
                <li class="subfolders">
                    <a href="#">Apex Rules</a>
                    <ul>
                        
                        
                        
                        <li><a href="pmd_rules_apex.html">Index</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_apex_bestpractices.html">Best Practices</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_apex_codestyle.html">Code Style</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_apex_design.html">Design</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_apex_documentation.html">Documentation</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_apex_errorprone.html">Error Prone</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_apex_performance.html">Performance</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_apex_security.html">Security</a></li>
                        
                        
                        
                    </ul>
                </li>
                
                

            

            
            
            

            

                
                
                <li class="subfolders">
                    <a href="#">HTML Rules</a>
                    <ul>
                        
                        
                        
                        <li><a href="pmd_rules_html.html">Index</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_html_bestpractices.html">Best Practices</a></li>
                        
                        
                        
                    </ul>
                </li>
                
                

            

            
            
            

            

                
                
                <li class="subfolders">
                    <a href="#">Java Rules</a>
                    <ul>
                        
                        
                        
                        <li><a href="pmd_rules_java.html">Index</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_java_bestpractices.html">Best Practices</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_java_codestyle.html">Code Style</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_java_design.html">Design</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_java_documentation.html">Documentation</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_java_errorprone.html">Error Prone</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_java_multithreading.html">Multithreading</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_java_performance.html">Performance</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_java_security.html">Security</a></li>
                        
                        
                        
                    </ul>
                </li>
                
                

            

            
            
            

            

                
                
                <li class="subfolders">
                    <a href="#">Java Server Pages Rules</a>
                    <ul>
                        
                        
                        
                        <li><a href="pmd_rules_jsp.html">Index</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_jsp_bestpractices.html">Best Practices</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_jsp_codestyle.html">Code Style</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_jsp_design.html">Design</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_jsp_errorprone.html">Error Prone</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_jsp_security.html">Security</a></li>
                        
                        
                        
                    </ul>
                </li>
                
                

            

            
            
            

            

                
                
                <li class="subfolders">
                    <a href="#">JavaScript Rules</a>
                    <ul>
                        
                        
                        
                        <li><a href="pmd_rules_ecmascript.html">Index</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_ecmascript_bestpractices.html">Best Practices</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_ecmascript_codestyle.html">Code Style</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_ecmascript_errorprone.html">Error Prone</a></li>
                        
                        
                        
                    </ul>
                </li>
                
                

            

            
            
            

            

                
                
                <li class="subfolders">
                    <a href="#">Kotlin Rules</a>
                    <ul>
                        
                        
                        
                        <li><a href="pmd_rules_kotlin.html">Index</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_kotlin_bestpractices.html">Best Practices</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_kotlin_errorprone.html">Error Prone</a></li>
                        
                        
                        
                    </ul>
                </li>
                
                

            

            
            
            

            

                
                
                <li class="subfolders">
                    <a href="#">Maven POM Rules</a>
                    <ul>
                        
                        
                        
                        <li><a href="pmd_rules_pom.html">Index</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_pom_errorprone.html">Error Prone</a></li>
                        
                        
                        
                    </ul>
                </li>
                
                

            

            
            
            

            

                
                
                <li class="subfolders">
                    <a href="#">Modelica Rules</a>
                    <ul>
                        
                        
                        
                        <li><a href="pmd_rules_modelica.html">Index</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_modelica_bestpractices.html">Best Practices</a></li>
                        
                        
                        
                    </ul>
                </li>
                
                

            

            
            
            

            

                
                
                <li class="subfolders">
                    <a href="#">PLSQL Rules</a>
                    <ul>
                        
                        
                        
                        <li><a href="pmd_rules_plsql.html">Index</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_plsql_bestpractices.html">Best Practices</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_plsql_codestyle.html">Code Style</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_plsql_design.html">Design</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_plsql_errorprone.html">Error Prone</a></li>
                        
                        
                        
                    </ul>
                </li>
                
                

            

            
            
            

            

                
                
                <li class="subfolders">
                    <a href="#">Salesforce Visualforce Rules</a>
                    <ul>
                        
                        
                        
                        <li><a href="pmd_rules_visualforce.html">Index</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_visualforce_security.html">Security</a></li>
                        
                        
                        
                    </ul>
                </li>
                
                

            

            
            
            

            

                
                
                <li class="subfolders">
                    <a href="#">Scala Rules</a>
                    <ul>
                        
                        
                        
                        <li><a href="pmd_rules_scala.html">Index</a></li>
                        
                        
                        
                    </ul>
                </li>
                
                

            

            
            
            

            

                
                
                <li class="subfolders">
                    <a href="#">Swift Rules</a>
                    <ul>
                        
                        
                        
                        <li><a href="pmd_rules_swift.html">Index</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_swift_bestpractices.html">Best Practices</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_swift_errorprone.html">Error Prone</a></li>
                        
                        
                        
                    </ul>
                </li>
                
                

            

            
            
            

            

                
                
                <li class="subfolders">
                    <a href="#">Velocity Template Language (VTL) Rules</a>
                    <ul>
                        
                        
                        
                        <li><a href="pmd_rules_velocity.html">Index</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_velocity_bestpractices.html">Best Practices</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_velocity_design.html">Design</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_velocity_errorprone.html">Error Prone</a></li>
                        
                        
                        
                    </ul>
                </li>
                
                

            

            
            
            

            

                
                
                <li class="subfolders">
                    <a href="#">WSDL Rules</a>
                    <ul>
                        
                        
                        
                        <li><a href="pmd_rules_wsdl.html">Index</a></li>
                        
                        
                        
                    </ul>
                </li>
                
                

            

            
            
            

            

                
                
                <li class="subfolders">
                    <a href="#">XML Rules</a>
                    <ul>
                        
                        
                        
                        <li><a href="pmd_rules_xml.html">Index</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_xml_bestpractices.html">Best Practices</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_xml_errorprone.html">Error Prone</a></li>
                        
                        
                        
                    </ul>
                </li>
                
                

            

            
            
            

            

                
                
                <li class="subfolders">
                    <a href="#">XSL Rules</a>
                    <ul>
                        
                        
                        
                        <li><a href="pmd_rules_xsl.html">Index</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_xsl_codestyle.html">Code Style</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_rules_xsl_performance.html">Performance</a></li>
                        
                        
                        
                    </ul>
                </li>
                
                

            

            
            
        </ul>
     </li>
       
        
    
    <li>
        
        <a href="#">Language-Specific Documentation</a>
        
        <ul>
            
            

            

                
                <li><a href="pmd_languages_index.html">Overview</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_configuration.html">Language configuration</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_apex.html">Apex</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_cpp.html">C/C++</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_cs.html">C#</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_coco.html">Coco</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_dart.html">Dart</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_fortran.html">Fortran</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_gherkin.html">Gherkin</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_go.html">Go</a></li>
                

            

            
            
            
            
            

            

                
                <li><a href="pmd_languages_html.html">HTML</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_java.html">Java</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_js_ts.html">JavaScript / TypeScript</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_jsp.html">JSP</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_julia.html">Julia</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_kotlin.html">Kotlin</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_lua.html">Lua</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_matlab.html">Matlab</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_modelica.html">Modelica</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_objectivec.html">Objective-C</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_perl.html">Perl</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_php.html">PHP</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_plsql.html">PLSQL</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_python.html">Python</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_ruby.html">Ruby</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_scala.html">Scala</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_swift.html">Swift</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_tsql.html">T-SQL</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_visualforce.html">Visualforce</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_velocity.html">Velocity Template Language (VTL)</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_languages_xml.html">XML and XML dialects</a></li>
                

            

            
            
        </ul>
     </li>
       
        
    
    <li>
        
        <a href="#">Developer Documentation</a>
        
        <ul>
            
            

            

                
                <li><a href="pmd_devdocs_development.html">Developer resources</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_devdocs_building.html">Building PMD from source</a></li>
                

            

            
            
            

            

                
                <li><a href="https://github.com/pmd/pmd/blob/master/CONTRIBUTING.md" target="_blank">Contributing</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_devdocs_writing_documentation.html">Writing documentation</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_devdocs_roadmap.html">Roadmap</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_devdocs_how_pmd_works.html">How PMD works</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_devdocs_pmdtester.html">Pmdtester</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_devdocs_rule_deprecation_policy.html">Rule Deprecation Policy</a></li>
                

            

            
            
            

            

                
                
                <li class="subfolders">
                    <a href="#">Major contributions</a>
                    <ul>
                        
                        
                        
                        <li><a href="pmd_devdocs_major_rule_guidelines.html">Rule Guidelines</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_devdocs_major_adding_new_language_javacc.html">Adding a new language (JavaCC)</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_devdocs_major_adding_new_language_antlr.html">Adding a new language (ANTLR)</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_devdocs_major_adding_new_cpd_language.html">Adding a new CPD language</a></li>
                        
                        
                        
                    </ul>
                </li>
                
                
                
                <li class="subfolders">
                    <a href="#">Experimental features</a>
                    <ul>
                        
                        
                        
                        <li><a href="tag_experimental.html">List of experimental Features</a></li>
                        
                        
                        
                    </ul>
                </li>
                
                

            

            
            
        </ul>
     </li>
       
        
    
    <li>
        
        <a href="#">Project documentation</a>
        
        <ul>
            
            

            

                
                
                <li class="subfolders">
                    <a href="#">Trivia about PMD</a>
                    <ul>
                        
                        
                        
                        <li><a href="pmd_projectdocs_trivia_news.html">PMD in the press</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_projectdocs_trivia_products.html">Products & books related to PMD</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_projectdocs_trivia_similarprojects.html">Similar projects</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_projectdocs_trivia_meaning.html">What does 'PMD' mean?</a></li>
                        
                        
                        
                    </ul>
                </li>
                
                

            

            
            
            

            

                
                <li><a href="pmd_projectdocs_logo.html">Logo</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_projectdocs_faq.html">FAQ</a></li>
                

            

            
            
            

            

                
                <li><a href="license.html">License</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_projectdocs_credits.html">Credits</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_release_notes_old.html">Old release notes</a></li>
                

            

            
            
            

            

                
                <li><a href="pmd_projectdocs_decisions.html">Decisions</a></li>
                

            

            
            
            

            

                
                
                <li class="subfolders">
                    <a href="#">Project management</a>
                    <ul>
                        
                        
                        
                        <li><a href="pmd_projectdocs_committers_infrastructure.html">Infrastructure</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_projectdocs_committers_releasing.html">Release process</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_projectdocs_committers_merging_pull_requests.html">Merging pull requests</a></li>
                        
                        
                        
                        
                        
                        <li><a href="pmd_projectdocs_committers_main_landing_page.html">Main Landing page</a></li>
                        
                        
                        
                    </ul>
                </li>
                
                

            

            
            
        </ul>
     </li>
       
        
        
</ul>

            </div>
            
            

            <!-- Content Column -->
            <div class="col-md-9" id="tg-sb-content">
                <header>
    <div class="row">
        <div class="col-lg-12">
            <a href="./" role="button"
                ><i class="fa fa-home fa-lg"></i
            ></a>
            » Documentation Index   
            <a
                target="_blank"
                href="https://github.com/pmd/pmd/blob/master/docs/index.md"
                class="float-right"
                role="button"
                ><i class="fab fa-github fa-lg"></i> Edit on GitHub</a
            >
             
        </div>
    </div>

    <hr />
</header>


<div class="post-header">
   <h1 class="post-title-main">Documentation Index</h1>
</div>

<div class="post-content" data-github-edit-url="https://github.com/pmd/pmd/blob/master/docs/index.md">

   
    <div class="summary">Welcome to the documentation site for PMD and CPD! <br/><br/>
</div>
   
    <details id="inline-toc-details">
        <summary>Table of Contents</summary>
        <div id="inline-toc"><!-- empty, move TOC here when screen size too small --></div>
    </details>

  <h2 id="-overview">💡 Overview</h2>

<!--  You can link to an individual panel, the id is determined from the title of the panel -->
<!--  See custom/shuffle_panel.html for the details -->

<p><strong>PMD</strong> is a static source code analyzer. It finds common programming flaws like
unused variables, empty catch blocks, unnecessary object creation, and
so forth. It’s mainly concerned with <strong>Java and Apex</strong>, but <strong>supports 16 other
languages</strong>.</p>

<p>PMD features many <strong>built-in checks</strong> (in PMD lingo, <em>rules</em>), which are documented
for each language in our <a href="#shuffle-panel-rule-references">Rule references</a>. We
also support an extensive API to <a href="#shuffle-panel-writing-rules"><strong>write your own rules</strong></a>,
which you can do either in Java or as a self-contained XPath query.</p>

<p>PMD is most useful when <strong>integrated into your build process</strong>. It can then be
used as a quality gate, to enforce a coding standard for your codebase. Among other
things, PMD can be run:</p>
<ul>
  <li>As a <a href="pmd_userdocs_tools_maven.html">Maven goal</a></li>
  <li>As an <a href="pmd_userdocs_tools_ant.html">Ant task</a></li>
  <li>As a <a href="pmd_userdocs_tools_gradle.html">Gradle task</a></li>
  <li>As a <a href="pmd_userdocs_tools_bld.html">bld operation</a></li>
  <li>From <a href="pmd_userdocs_installation.html#running-pmd-via-command-line">command-line</a></li>
</ul>

<p><strong>CPD</strong>, the <strong>copy-paste detector</strong>, is also distributed with PMD. You can also use it
in a variety of ways, which are <a href="pmd_userdocs_cpd.html">documented here</a>.</p>

<h2 id="-download">💾 Download</h2>

<p>The latest release of PMD can be downloaded from our <a href="https://github.com/pmd/pmd/releases/latest">Github releases page</a>.</p>

<p>The Logo is available from the <a href="pmd_projectdocs_logo.html">Logo Project Page</a>.</p>

<h2 id="-documentation">📖 Documentation</h2>

<p>The rest of this page exposes the contents of the documentation site thematically,
which you can further scope down using the blue filter buttons. To navigate the site,
you may also use the search bar in the top right, or the sidebar on the left.</p>

<h2 id="-contributors">✨ Contributors</h2>

<p>This project follows the <a href="https://github.com/all-contributors/all-contributors">all-contributors</a> specification.
Contributions of any kind welcome!</p>

<p>See <a href="pmd_projectdocs_credits.html">credits</a> for the complete list.</p>

<p><br /></p>

<div class="filter-options" id="grid-rule">
      <button class="btn btn-primary" data-group="all">All</button>
      <button class="btn btn-primary" data-group="getting_started">Getting Started</button>
      <button class="btn btn-primary" data-group="userdocs">User documentation</button>
      <button class="btn btn-primary" data-group="extending">Extending PMD</button>
      <button class="btn btn-primary" data-group="contributing">Contributing</button>
</div>

<div id="grid" class="row">

<!--  TODO the "getting started" panel is not that useful. It would be better to make a page series. -->
    








<div class="col-xs-6 col-sm-4 col-md-4" data-groups="[&quot;getting_started&quot;]" id="shuffle-panel-getting-started">
    <div class="card">
        
        <div class="card-header text-center">
            Getting started
        </div>

        <div class="card-body">
            <p class="landing-page cat-description">
                These pages summarize the gist of PMD usage to get you started quickly.
            </p>
            <ul>
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_installation.html">Installation and basic CLI usage</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_making_rulesets.html">Making rulesets</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_configuring_rules.html">Configuring rules</a></li>
                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_extending_writing_rules_intro.html">Introduction to writing PMD rules</a></li>
                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
            </ul>
        </div>
    </div>
</div>



    








<div class="col-xs-6 col-sm-4 col-md-4" data-groups="[&quot;userdocs&quot;]" id="shuffle-panel-rule-references">
    <div class="card">
        
            <div class="card-header text-center">
                <p class="fa-stack fa-5x">
                    <i class="fas fa-circle fa-stack-2x text-secondary"></i>
                    <i class="fas fa-database fa-stack-1x fa-inverse"></i>
                </p>
            </div>
        
        <div class="card-header text-center">
            Rule references
        </div>

        <div class="card-body">
            <p class="landing-page cat-description">
                Pick your language to find out about the rule it supports.
            </p>
            <ul>
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_3rdpartyrulesets.html">3rd party rulesets</a></li>
                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                        <li><a href="pmd_rules_apex.html">Apex</a></li>
                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                        <li><a href="pmd_rules_html.html">HTML</a></li>
                    
                
                    
                    

                    
                
                    
                    

                    
                        <li><a href="pmd_rules_java.html">Java</a></li>
                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                        <li><a href="pmd_rules_jsp.html">Java Server Pages</a></li>
                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                        <li><a href="pmd_rules_ecmascript.html">JavaScript</a></li>
                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                        <li><a href="pmd_rules_kotlin.html">Kotlin</a></li>
                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                        <li><a href="pmd_rules_pom.html">Maven POM</a></li>
                    
                
                    
                    

                    
                
                    
                    

                    
                        <li><a href="pmd_rules_modelica.html">Modelica</a></li>
                    
                
                    
                    

                    
                
                    
                    

                    
                        <li><a href="pmd_rules_plsql.html">PLSQL</a></li>
                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                        <li><a href="pmd_rules_visualforce.html">Salesforce Visualforce</a></li>
                    
                
                    
                    

                    
                
                    
                    

                    
                        <li><a href="pmd_rules_scala.html">Scala</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_rules_swift.html">Swift</a></li>
                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                        <li><a href="pmd_rules_velocity.html">Velocity Template Language (VTL)</a></li>
                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                        <li><a href="pmd_rules_xml.html">XML</a></li>
                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                        <li><a href="pmd_rules_xsl.html">XSL</a></li>
                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
            </ul>
        </div>
    </div>
</div>


    








<div class="col-xs-6 col-sm-4 col-md-4" data-groups="[&quot;userdocs&quot;, &quot;extending&quot;, &quot;contributing&quot;]" id="shuffle-panel-writing-rules">
    <div class="card">
        
        <div class="card-header text-center">
            Writing rules
        </div>

        <div class="card-body">
            <p class="landing-page cat-description">
                These pages document the process of writing and testing custom rules and metrics for PMD.
            </p>
            <ul>
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_extending_writing_rules_intro.html">Introduction to writing PMD rules</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_extending_your_first_rule.html">Your first rule</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_extending_writing_xpath_rules.html">Writing XPath rules</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_extending_writing_java_rules.html">Writing a custom rule</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_extending_designer_reference.html">The rule designer</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_extending_defining_properties.html">Defining rule properties</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_extending_rule_guidelines.html">Rule guidelines</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_extending_testing.html">Testing your rules</a></li>
                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_extending_writing_pmd_rules.html">Writing a custom rule</a></li>
                    
                
            </ul>
        </div>
    </div>
</div>


    








<div class="col-xs-6 col-sm-4 col-md-4" data-groups="[&quot;userdocs&quot;]" id="shuffle-panel-usage-and-configuration">
    <div class="card">
        
            <div class="card-header text-center">
                <p class="fa-stack fa-5x">
                    <i class="fas fa-circle fa-stack-2x text-secondary"></i>
                    <i class="fas fa-cog fa-stack-1x fa-inverse"></i>
                </p>
            </div>
        
        <div class="card-header text-center">
            Usage and configuration
        </div>

        <div class="card-body">
            <p class="landing-page cat-description">
                Learn how to build effective and versatile rulesets.
            </p>
            <ul>
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_migrating_to_pmd7.html">Migration Guide for PMD 7</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_installation.html">Installation and basic CLI usage</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_making_rulesets.html">Making rulesets</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_configuring_rules.html">Configuring rules</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_best_practices.html">Best Practices</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_suppressing_warnings.html">Suppressing warnings</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_incremental_analysis.html">Incremental Analysis</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_cli_reference.html">PMD CLI reference</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_report_formats.html">Report formats for PMD</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_3rdpartyrulesets.html">3rd party rulesets</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_cpd.html">Finding duplicated code with CPD</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_cpd_report_formats.html">Report formats for CPD</a></li>
                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_extending_ast_dump.html">Creating XML dump of the AST</a></li>
                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
            </ul>
        </div>
    </div>
</div>



    








<div class="col-xs-6 col-sm-4 col-md-4" data-groups="[&quot;contributing&quot;]" id="shuffle-panel-contributing">
    <div class="card">
        
            <div class="card-header text-center">
                <p class="fa-stack fa-5x">
                    <i class="fas fa-circle fa-stack-2x text-secondary"></i>
                    <i class="fab fa-github fa-stack-1x fa-inverse"></i>
                </p>
            </div>
        
        <div class="card-header text-center">
            Contributing
        </div>

        <div class="card-body">
            <p class="landing-page cat-description">
                If you'd like to help us build PMD, these topics may interest you. See you around!
            </p>
            <ul>
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                        <li><a href="pmd_devdocs_development.html">Developer Resources</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_devdocs_building.html">Building PMD from source</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_devdocs_writing_documentation.html">Writing documentation</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_devdocs_roadmap.html">Roadmap</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_devdocs_how_pmd_works.html">How PMD Works</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_devdocs_pmdtester.html">Pmdtester</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_devdocs_rule_deprecation_policy.html">Rule deprecation policy</a></li>
                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                        <li><a href="pmd_devdocs_logging.html">Logging</a></li>
                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
            </ul>
        </div>
    </div>
</div>




    








<div class="col-xs-6 col-sm-4 col-md-4" data-groups="[&quot;userdocs&quot;]" id="shuffle-panel-tools-and-integrations">
    <div class="card">
        
        <div class="card-header text-center">
            Tools and integrations
        </div>

        <div class="card-body">
            <p class="landing-page cat-description">
                These pages describe solutions that integrate PMD within your build process.
            </p>
            <ul>
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_tools_maven.html">Maven PMD Plugin</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_tools_gradle.html">Gradle</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_tools_ant.html">Ant Task Usage</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_tools_java_api.html">PMD Java API</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_tools_bld.html">bld PMD Extension</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_tools_ci.html">Continuous Integrations plugins</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_userdocs_tools.html">Tools / Integrations</a></li>
                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
            </ul>
        </div>
    </div>
</div>


    








<div class="col-xs-6 col-sm-4 col-md-4" data-groups="[&quot;contributing&quot;,&quot;extending&quot;]" id="shuffle-panel-major-contributions">
    <div class="card">
        
        <div class="card-header text-center">
            Major contributions
        </div>

        <div class="card-body">
            <p class="landing-page cat-description">
                
            </p>
            <ul>
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                        <li><a href="pmd_devdocs_major_rule_guidelines.html">Guidelines for standard rules</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_devdocs_major_adding_new_language_javacc.html">Adding PMD support for a new JavaCC grammar based language</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_devdocs_major_adding_new_language_antlr.html">Adding PMD support for a new ANTLR grammar based language</a></li>
                    
                
                    
                    

                    
                        <li><a href="pmd_devdocs_major_adding_new_cpd_language.html">How to add a new CPD language</a></li>
                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
                    
                    

                    
                
            </ul>
        </div>
    </div>
</div>


    <!-- sizer -->
    <div class="col-xs-6 col-sm-4 col-md-1 shuffle_sizer"></div>
</div>

<!-- <figure><img class="docimage" src="images/pmd-logo-big.png" alt="PMD Logo"  /></figure>
 -->



    <div class="tags">
        
    </div>

</div>


<footer>
    
    <hr />
    <div>
        This documentation is written in markdown. <br />
        If there is something missing or can be improved, edit this page on
        github and create a PR:
        <a
            target="_blank"
            href="https://github.com/pmd/pmd/blob/master/docs/index.md"
            role="button"
            ><i class="fab fa-github fa-lg"></i> Edit on GitHub</a
        >
    </div>
    
    <hr />
    <div class="row">
        <div class="col-lg-12 footer">
            &copy;2024 PMD Open Source Project. All rights
            reserved. <br />
            <span>Page last updated:</span>
            October 2022<br /> Site last generated: Apr 4, 2024 <br />
            <p>
                <img src="images/logo/pmd-logo-70px.png" alt="PMD
                logo"/>
            </p>
        </div>
    </div>
</footer>


            </div>

            <!-- /.row -->
        </div>
        <!-- /.container -->
    </div>

    
    <!-- /.toc-container-wrapper -->
</div>
</div>

<script type="application/javascript" src="assets/jquery-3.5.1/jquery-3.5.1.min.js"></script>
<script type="application/javascript" src="assets/anchorjs-4.2.2/anchor.min.js"></script>
<script type="application/javascript" src="assets/navgoco-0.2.1/src/jquery.navgoco.min.js"></script>
<script type="application/javascript" src="assets/bootstrap-4.5.2-dist/js/bootstrap.bundle.min.js"></script>
<script type="application/javascript" src="assets/Simple-Jekyll-Search-1.0.8/dest/jekyll-search.js"></script>
<script type="application/javascript" src="assets/jekyll-table-of-contents/toc.js"></script>
<script type="application/javascript" src="js/tabstate.js"></script>
<script type="application/javascript" src="js/customscripts.js"></script>



<script type="application/javascript" src="assets/Shuffle-5.2.3/dist/shuffle.min.js"></script>

<script type="application/javascript" src="assets/jquery-ui-1.12.1/jquery-ui.min.js"></script>

<script type="application/javascript" src="js/shuffle.js"></script>



</body>
</html>