1777 lines
47 KiB
HTML
1777 lines
47 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="Describes when and how rules are deprecated">
|
|
<meta name="keywords" content="devdocs, ">
|
|
<title>Rule deprecation policy | PMD Source Code Analyzer</title>
|
|
<link rel="stylesheet" href="css/syntax.css">
|
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
|
|
<!--<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">-->
|
|
<link rel="stylesheet" href="css/modern-business.css">
|
|
<link rel="stylesheet" href="css/lavish-bootstrap.css">
|
|
<link rel="stylesheet" href="css/customstyles.css">
|
|
<link rel="stylesheet" href="css/theme-blue.css">
|
|
<link rel="stylesheet" href="css/pmd-customstyles.css">
|
|
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js"></script>
|
|
<script src="js/jquery.navgoco.min.js"></script>
|
|
|
|
|
|
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/2.0.0/anchor.min.js"></script>
|
|
<script src="js/toc.js"></script>
|
|
<script src="js/customscripts.js"></script>
|
|
|
|
<link rel="shortcut icon" href="images/favicon.ico" type="image/x-icon">
|
|
<link rel="icon" href="images/favicon.ico" type="image/x-icon">
|
|
|
|
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
|
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
|
|
<!--[if lt IE 9]>
|
|
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
|
|
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
|
|
<![endif]-->
|
|
|
|
<link rel="alternate" type="application/rss+xml" title="" href="https://pmd.github.io/pmd/feed.xml">
|
|
|
|
<script>
|
|
$(document).ready(function() {
|
|
// Initialize navgoco with default options
|
|
$("#mysidebar").navgoco({
|
|
caretHtml: '',
|
|
accordion: true,
|
|
openClass: 'active', // open
|
|
save: false, // leave false or nav highlighting doesn't work right
|
|
cookie: {
|
|
name: 'navgoco',
|
|
expires: false,
|
|
path: '/'
|
|
},
|
|
slide: {
|
|
duration: 400,
|
|
easing: 'swing'
|
|
}
|
|
});
|
|
|
|
$("#collapseAll").click(function(e) {
|
|
e.preventDefault();
|
|
$("#mysidebar").navgoco('toggle', false);
|
|
});
|
|
|
|
$("#expandAll").click(function(e) {
|
|
e.preventDefault();
|
|
$("#mysidebar").navgoco('toggle', true);
|
|
});
|
|
|
|
});
|
|
|
|
</script>
|
|
<script>
|
|
$(function () {
|
|
$('[data-toggle="tooltip"]').tooltip()
|
|
})
|
|
</script>
|
|
<script>
|
|
$(document).ready(function() {
|
|
$("#tg-sb-link").click(function() {
|
|
$("#tg-sb-sidebar").toggle();
|
|
$("#tg-sb-content").toggleClass('col-md-9');
|
|
$("#tg-sb-content").toggleClass('col-md-12');
|
|
$("#tg-sb-icon").toggleClass('fa-toggle-on');
|
|
$("#tg-sb-icon").toggleClass('fa-toggle-off');
|
|
});
|
|
});
|
|
</script>
|
|
|
|
|
|
</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-inverse navbar-fixed-top">
|
|
<div class="container topnavlinks">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
<a class="fa fa-home fa-lg navbar-brand" href="index.html"> <span class="projectTitle"> PMD Source Code Analyzer Project</span></a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
|
|
<ul class="nav navbar-nav navbar-right">
|
|
<!-- toggle sidebar button -->
|
|
<li><a id="tg-sb-link" href="#"><i id="tg-sb-icon" class="fa fa-toggle-on"></i> Nav</a></li>
|
|
<!-- entries without drop-downs appear here -->
|
|
|
|
|
|
|
|
<li><a href="https://github.com/pmd/pmd/releases/latest" target="_blank">Download</a></li>
|
|
|
|
|
|
|
|
<li><a 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.-->
|
|
|
|
|
|
<!--comment out this block if you want to hide search-->
|
|
<li>
|
|
<!--start search-->
|
|
<div id="search-demo-container">
|
|
<input type="text" id="search-input" placeholder="search...">
|
|
<ul id="results-container"></ul>
|
|
</div>
|
|
<script src="js/jekyll-search.js" type="text/javascript"></script>
|
|
<script type="text/javascript">
|
|
SimpleJekyllSearch.init({
|
|
searchInput: document.getElementById('search-input'),
|
|
resultsContainer: document.getElementById('results-container'),
|
|
dataSource: 'search.json',
|
|
searchResultTemplate: '<li><a href="{url}" title="Rule deprecation policy">{title}</a></li>',
|
|
noResultsText: 'No results found.',
|
|
limit: 10,
|
|
fuzzy: true,
|
|
})
|
|
</script>
|
|
<!--end search-->
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- /.container -->
|
|
</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 6.54.0</li>
|
|
<div class="sidebarTitleDate">Release date: 28-January-2023</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_next_major_development.html">PMD 7.0.0 development</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_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_metrics_howto.html">Using and defining code metrics</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>
|
|
|
|
|
|
|
|
</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_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="#">Ecmascript 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="#">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="#">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_vf.html">Index</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_vf_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="#">VM Rules</a>
|
|
<ul>
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_vm.html">Index</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_vm_bestpractices.html">Best Practices</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_vm_design.html">Design</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_rules_vm_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_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_jsp.html">JSP Support</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="subfolders">
|
|
<a href="#">Java Support</a>
|
|
<ul>
|
|
|
|
|
|
|
|
<li><a href="pmd_languages_java.html">Java Versions</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_java_metrics_index.html">Java Code Metrics</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_apex_metrics_index.html">Apex code metrics</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_languages_plsql.html">PLSQL</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_languages_visualforce.html">Visualforce</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_languages_xml.html">XML and XML dialects</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_languages_html.html">HTML</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_languages_gherkin.html">Gherkin</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 class="active"><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.html">Adding a new language</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_devdocs_major_adding_new_cpd_language.html">Adding a new CPD language</a></li>
|
|
|
|
|
|
|
|
|
|
|
|
<li><a href="pmd_devdocs_major_adding_new_metrics_framework.html">Adding metrics support to a language</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
<li class="subfolders">
|
|
<a href="#">Experimental features</a>
|
|
<ul>
|
|
|
|
|
|
|
|
<li><a href="pmd_devdocs_experimental_ast_dump.html">Creating (XML) dump of the AST</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_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>
|
|
|
|
|
|
|
|
<!-- if you aren't using the accordion, uncomment this block:
|
|
<p class="external">
|
|
<a href="#" id="collapseAll">Collapse All</a> | <a href="#" id="expandAll">Expand All</a>
|
|
</p>
|
|
-->
|
|
</ul>
|
|
|
|
<!-- this highlights the active parent class in the navgoco sidebar. this is critical so that the parent expands when you're viewing a page. This must appear below the sidebar code above. Otherwise, if placed inside customscripts.js, the script runs before the sidebar code runs and the class never gets inserted.-->
|
|
<script>$("li.active").parents('li').toggleClass("active");</script>
|
|
|
|
</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>
|
|
» Rule deprecation policy
|
|
<a
|
|
target="_blank"
|
|
href="https://github.com/pmd/pmd/blob/master/docs/pages/pmd/devdocs/rule_deprecation.md"
|
|
class="pull-right"
|
|
role="button"
|
|
><i class="fa fa-github fa-lg"></i> Edit on GitHub</a
|
|
>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<hr />
|
|
</header>
|
|
|
|
|
|
<div class="post-header">
|
|
<h1 class="post-title-main">Rule deprecation policy</h1>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="post-content" data-github-edit-url="https://github.com/pmd/pmd/blob/master/docs/pages/pmd/devdocs/rule_deprecation.md">
|
|
|
|
|
|
<div class="summary">Describes when and how rules are deprecated</div>
|
|
|
|
<div id="inline-toc"><!-- empty, move TOC here when screen size too small --></div>
|
|
|
|
<p>When improving PMD over time, some rules might become obsolete. This could be because the underlying
|
|
technology a specific rule is checking (such as a specific JVM version) is not relevant anymore or a rule
|
|
has been replaced by a better implementation.</p>
|
|
|
|
<p>In order to remove the requirement to maintain such rules forever, these rules can be marked as <strong>deprecated</strong>.
|
|
This means, that such rules can entirely be removed in the future.
|
|
However, the rules must not be removed immediately, since that would break any (custom) ruleset, that
|
|
references this rule.</p>
|
|
|
|
<p>This policy tries to establish some ground rules about how and when rules are deprecated and removed.
|
|
The main goal is, to maintain compatibility of custom rulesets throughout the deprecation process.</p>
|
|
|
|
<h2 id="renaming-rules">Renaming rules</h2>
|
|
|
|
<p>If a rule is enhanced, it might make sense to also rename the rule, to reflect that enhancement. However,
|
|
simply renaming the rule would break existing (custom) ruleset. Therefore the following procedure should be used:</p>
|
|
|
|
<ul>
|
|
<li>Rename the rule to the new name (and also the rule tests and resources)</li>
|
|
<li>
|
|
<p>Add a deprecated rule reference with the old name, that points to the new rule name:</p>
|
|
|
|
<p><code class="language-plaintext highlighter-rouge"><rule name="OldRuleName" ref="NewRuleName" deprecated="true" /></code></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<p><em>Note:</em> When referencing the complete rulesets or categories,
|
|
these deprecated rule references are ignored, so that the rule is not used twice.</p>
|
|
|
|
<h2 id="moving-rules-between-categories">Moving rules between categories</h2>
|
|
|
|
<p>Every rule is in one category. It might happen, that the focus of the rule shifts and it makes more
|
|
sense, if it would be in a different, better fitting category.</p>
|
|
|
|
<ul>
|
|
<li>Move the rule to the new category (and also the rule tests and resources)</li>
|
|
<li>
|
|
<p>Add a deprecated rule reference in the old category, that points to the rule in the new category:</p>
|
|
|
|
<p><code class="language-plaintext highlighter-rouge"><rule name="MyRule" ref="category/java/errorprone.xml/MyRule" deprecated="true" /></code></p>
|
|
</li>
|
|
</ul>
|
|
|
|
<p><em>Note:</em> When referencing the complete rulesets or categories,
|
|
these deprecated rule references are ignored, so that the rule is not used twice, if both categories
|
|
are used.</p>
|
|
|
|
<h2 id="deprecating-rules">Deprecating rules</h2>
|
|
|
|
<p>Before a rule can be removed, it must have been marked as deprecated:</p>
|
|
|
|
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code><rule name="MyRule" class="...." deprecated="true">
|
|
...
|
|
</rule>
|
|
</code></pre></div></div>
|
|
|
|
<p>This has the effect, that it is <strong>automatically disabled</strong> if the complete ruleset or category
|
|
is referenced. The rule can still be used, if it is referenced directly.</p>
|
|
|
|
<p>The reasons for the deprecation should be explained in the rule description. If there is a replacement rule
|
|
available, then this rule should be mentioned in the description as well.</p>
|
|
|
|
<h2 id="removing-rules">Removing rules</h2>
|
|
|
|
<p>Removing rules completely can only be done</p>
|
|
|
|
<ul>
|
|
<li>if the rules have been deprecated before</li>
|
|
<li>for a new <strong>major</strong> release.</li>
|
|
</ul>
|
|
|
|
<p>Removing a rule from a ruleset or category will break any custom ruleset, that references
|
|
this rule directly. Therefore rules can only be removed with the next major release of PMD.</p>
|
|
|
|
<h2 id="rule-property-compatibility">Rule property compatibility</h2>
|
|
|
|
<p>Renaming or removing rule properties is not backwards compatible and can only be done
|
|
with a major release of PMD.</p>
|
|
|
|
<p>In order to prepare for the change, properties can be deprecated as well: If the property description
|
|
starts with the magic string <code class="language-plaintext highlighter-rouge">deprecated!</code>, then this property is rendered in the rule documentation
|
|
as deprecated. However, there is no automatic check done if such a property is used and no
|
|
deprecation warning is issued with the log.</p>
|
|
|
|
<p>Therefore, the process for <strong>renaming a property</strong> looks like this:</p>
|
|
|
|
<ul>
|
|
<li>Create a new property with the same type and new name</li>
|
|
<li>Prefix the description of the old property with <code class="language-plaintext highlighter-rouge">deprecated!</code> and also add a explanation
|
|
either in the property description or in the rule description, which property should be used
|
|
instead of the deprecated property.</li>
|
|
<li>Adjust the rule implementation to first check the old property. If it has a value other than the
|
|
default value, then the old (deprecated) property has been used and a deprecation warning should
|
|
be logged. If the new property is used (it has a value other than the default), then it takes
|
|
preference, but the deprecation warning for the old property should still be issued.</li>
|
|
<li>The deprecated property can be removed with the next major release of PMD.</li>
|
|
</ul>
|
|
|
|
<p><strong>Changing the default value</strong> of a property might have some results, that make the rule
|
|
behavioral incompatible: E.g. it could find many more violations with a different default
|
|
configuration and therefore lead to a sudden increase of violations after a PMD upgrade.
|
|
It should be judged per case, whether the new default can be considered compatible or not.
|
|
If it is not compatible, then the new default value should be configured only with the next
|
|
major release of PMD.</p>
|
|
|
|
|
|
|
|
<div class="tags">
|
|
|
|
<b>Tags: </b>
|
|
|
|
|
|
|
|
<a href="tag_devdocs.html" class="btn btn-default 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/master/docs/pages/pmd/devdocs/rule_deprecation.md"
|
|
role="button"
|
|
><i class="fa fa-github fa-lg"></i> Edit on GitHub</a
|
|
>
|
|
</div>
|
|
|
|
<hr />
|
|
<div class="row">
|
|
<div class="col-lg-12 footer">
|
|
©2023 PMD Open Source Project. All rights
|
|
reserved. <br />
|
|
<span>Page last updated:</span>
|
|
November 15, 2019<br /> Site last generated: Jan 28, 2023 <br />
|
|
<p>
|
|
<img src="images/pmd-logo-small.png" alt="Company
|
|
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>
|
|
</body>
|
|
|
|
</html>
|