2064 lines
		
	
	
		
			50 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			2064 lines
		
	
	
		
			50 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
| <!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="">
 | ||
| <meta name="keywords" content="devdocs,  ">
 | ||
| <title>Building PMD from source | 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"> <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"> </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.7.0-SNAPSHOT</li>
 | ||
|     <div class="sidebarTitleDate">Release date: 25-October-2024</div>
 | ||
|     
 | ||
|     
 | ||
|     
 | ||
|         
 | ||
|     
 | ||
|     <li>
 | ||
|         
 | ||
|         <a href="#">About</a>
 | ||
|         
 | ||
|         <ul>
 | ||
|             
 | ||
|             
 | ||
| 
 | ||
|             
 | ||
| 
 | ||
|                 
 | ||
|                 <li><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>
 | ||
|                 
 | ||
| 
 | ||
|             
 | ||
| 
 | ||
|             
 | ||
|             
 | ||
|             
 | ||
| 
 | ||
|             
 | ||
| 
 | ||
|                 
 | ||
|                 <li><a href="pmd_about_release_policies.html">Release policies</a></li>
 | ||
|                 
 | ||
| 
 | ||
|             
 | ||
| 
 | ||
|             
 | ||
|             
 | ||
|             
 | ||
| 
 | ||
|             
 | ||
| 
 | ||
|                 
 | ||
|                 <li><a href="pmd_about_support_lifecycle.html">Support lifecycle</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>
 | ||
|                         
 | ||
|                         
 | ||
|                         
 | ||
|                         
 | ||
|                         
 | ||
|                         <li><a href="pmd_rules_ecmascript_performance.html">Performance</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 class="active"><a href="pmd_devdocs_building.html">Building PMD from source</a></li>
 | ||
|                 
 | ||
| 
 | ||
|             
 | ||
| 
 | ||
|             
 | ||
|             
 | ||
|             
 | ||
| 
 | ||
|             
 | ||
| 
 | ||
|                 
 | ||
|                 <li><a href="https://github.com/pmd/pmd/blob/main/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>
 | ||
|             » Building PMD from source   
 | ||
|             <a
 | ||
|                 target="_blank"
 | ||
|                 href="https://github.com/pmd/pmd/blob/main/docs/pages/pmd/devdocs/building.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">Building PMD from source</h1>
 | ||
| </div>
 | ||
| 
 | ||
| <div class="post-content" data-github-edit-url="https://github.com/pmd/pmd/blob/main/docs/pages/pmd/devdocs/building.md">
 | ||
| 
 | ||
|    
 | ||
|     <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>
 | ||
| 
 | ||
|   <!-- Gives visibility -->
 | ||
| <div class="alert alert-info" role="alert"><i class="fas fa-info-circle"></i> <b>Note:</b> TODO add IDE specific indications</div>
 | ||
| 
 | ||
| <h1 id="compiling-pmd">Compiling PMD</h1>
 | ||
| 
 | ||
| <ul>
 | ||
|   <li>JDK 11 or higher</li>
 | ||
| </ul>
 | ||
| 
 | ||
| <div class="alert alert-info" role="alert"><i class="fas fa-info-circle"></i> <b>Note:</b> While Java 11 is required for building, running PMD only requires Java 7
 | ||
| (or Java 8 for Apex, JavaScript, Scala, Visualforce, and the Designer).</div>
 | ||
| 
 | ||
| <p>You’ll need to either check out the source code or download the latest source release. Assuming you’ve got the latest source release, unzip it to a directory:</p>
 | ||
| 
 | ||
| <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>[tom@hal building]$ ls -l
 | ||
| total 5716
 | ||
| -rw-rw-r--    1 tom      tom       5837216 Jul 17 13:09 pmd-src-7.7.0-SNAPSHOT.zip
 | ||
| [tom@hal building]$ unzip -q pmd-src-7.7.0-SNAPSHOT.zip
 | ||
| [tom@hal building]$
 | ||
| </code></pre></div></div>
 | ||
| 
 | ||
| <p>Now cd down into the <code class="language-plaintext highlighter-rouge">pmd</code> directory:</p>
 | ||
| 
 | ||
| <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>[tom@hal building]$ cd pmd-src-7.7.0-SNAPSHOT
 | ||
| [tom@hal pmd-src-7.7.0-SNAPSHOT]$ ls -l | grep pom.xml
 | ||
| -rw-rw-r--    1 tom      tom          36482 14\. Nov 17:36 pom.xml
 | ||
| [tom@hal pmd-src-7.7.0-SNAPSHOT]$
 | ||
| </code></pre></div></div>
 | ||
| 
 | ||
| <p>That’s the project configuration for maven… let’s compile!</p>
 | ||
| 
 | ||
| <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>[tom@hal pmd-src-7.7.0-SNAPSHOT]$ ./mvnw clean verify
 | ||
| [INFO] Scanning for projects...
 | ||
| [INFO] ------------------------------------------------------------------------
 | ||
| [INFO] Reactor Build Order:
 | ||
| [INFO]
 | ||
| [INFO] PMD
 | ||
| [INFO] PMD Core
 | ||
| ...
 | ||
| ... after a few minutes ...
 | ||
| [INFO] ------------------------------------------------------------------------
 | ||
| [INFO] Reactor Summary:
 | ||
| [INFO]
 | ||
| [INFO] PMD ................................................ SUCCESS [  3.061 s]
 | ||
| [INFO] PMD Core ........................................... SUCCESS [ 25.675 s]
 | ||
| [INFO] PMD Test Framework ................................. SUCCESS [  0.457 s]
 | ||
| [INFO] PMD C++ ............................................ SUCCESS [  1.893 s]
 | ||
| [INFO] PMD C# ............................................. SUCCESS [  0.619 s]
 | ||
| [INFO] PMD Fortran ........................................ SUCCESS [  0.609 s]
 | ||
| [INFO] PMD Go ............................................. SUCCESS [  0.103 s]
 | ||
| [INFO] PMD Java ........................................... SUCCESS [01:08 min]
 | ||
| [INFO] PMD JavaScript ..................................... SUCCESS [  3.279 s]
 | ||
| [INFO] PMD JSP ............................................ SUCCESS [  3.944 s]
 | ||
| [INFO] PMD Matlab ......................................... SUCCESS [  1.342 s]
 | ||
| [INFO] PMD Objective-C .................................... SUCCESS [  2.281 s]
 | ||
| [INFO] PMD PHP ............................................ SUCCESS [  0.536 s]
 | ||
| [INFO] PMD PL/SQL ......................................... SUCCESS [ 10.973 s]
 | ||
| [INFO] PMD Python ......................................... SUCCESS [  1.758 s]
 | ||
| [INFO] PMD Ruby ........................................... SUCCESS [  0.438 s]
 | ||
| [INFO] PMD Velocity ....................................... SUCCESS [  3.941 s]
 | ||
| [INFO] PMD XML and XSL .................................... SUCCESS [  2.174 s]
 | ||
| [INFO] PMD Scala .......................................... SUCCESS [ 11.901 s]
 | ||
| [INFO] PMD Distribution Packages .......................... SUCCESS [ 11.366 s]
 | ||
| [INFO] PMD Java 8 Integration ............................. SUCCESS [  0.560 s]
 | ||
| [INFO] ------------------------------------------------------------------------
 | ||
| [INFO] BUILD SUCCESS
 | ||
| [INFO] ------------------------------------------------------------------------
 | ||
| [INFO] Total time: 02:36 min
 | ||
| [INFO] Finished at: 2015-11-14T17:46:06+01:00
 | ||
| [INFO] Final Memory: 63M/765M
 | ||
| [INFO] ------------------------------------------------------------------------
 | ||
| [tom@hal pmd-src-7.7.0-SNAPSHOT]$
 | ||
| </code></pre></div></div>
 | ||
| 
 | ||
| <p>Now the source and binary distribution zip files can be found in the folder <code class="language-plaintext highlighter-rouge">pmd-dist/target</code>.</p>
 | ||
| 
 | ||
| <p><strong>Notes:</strong></p>
 | ||
| 
 | ||
| <ul>
 | ||
|   <li>The rules that have already been written are specified in the <code class="language-plaintext highlighter-rouge">src/main/resources/category/</code> directories of
 | ||
| the specific languages, e.g. <code class="language-plaintext highlighter-rouge">pmd-java/src/main/resources/category</code>.
 | ||
| They’re also in the jar file that’s included with both the source and binary distributions.</li>
 | ||
| </ul>
 | ||
| 
 | ||
| 
 | ||
|     <div class="tags">
 | ||
|         
 | ||
|         <b>Tags: </b>
 | ||
|         
 | ||
|         
 | ||
|         
 | ||
|         <a href="tag_devdocs.html" class="btn btn-outline-secondary navbar-btn cursorNorm" role="button">devdocs</a>
 | ||
|         
 | ||
|         
 | ||
|         
 | ||
|     </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/main/docs/pages/pmd/devdocs/building.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">
 | ||
|             ©2024 PMD Open Source Project. All rights
 | ||
|             reserved. <br />
 | ||
|              Site last generated: Oct 18, 2024 <br />
 | ||
|             <p>
 | ||
|                 <img src="images/logo/pmd-logo-70px.png" alt="PMD
 | ||
|                 logo"/>
 | ||
|             </p>
 | ||
|         </div>
 | ||
|     </div>
 | ||
| </footer>
 | ||
| 
 | ||
| 
 | ||
|             </div>
 | ||
| 
 | ||
|             <!-- /.row -->
 | ||
|         </div>
 | ||
|         <!-- /.container -->
 | ||
|     </div>
 | ||
| 
 | ||
|     
 | ||
|     <!-- Sticky TOC column -->
 | ||
|     <div class="toc-col">
 | ||
|         <div id="toc"></div>
 | ||
|     </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>
 | ||
| 
 | ||
| 
 | ||
| 
 | ||
| </body>
 | ||
| </html>
 | 
