{{ include.options | split: ',' | mappend: arg | join: ""Â }}{{Â include.default }}
+
diff --git a/docs/_includes/custom/panel_scroll.html b/docs/_includes/custom/panel_scroll.html
new file mode 100644
index 00000000000..8dc89de9819
--- /dev/null
+++ b/docs/_includes/custom/panel_scroll.html
@@ -0,0 +1,27 @@
+
+
+
\ No newline at end of file
diff --git a/docs/_includes/custom/shuffle_panel.html b/docs/_includes/custom/shuffle_panel.html
new file mode 100644
index 00000000000..ffe3b4adb0d
--- /dev/null
+++ b/docs/_includes/custom/shuffle_panel.html
@@ -0,0 +1,55 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+{% assign titlemaker = include.titlemaker | default: "page.title" %}
+{% assign include_tags = include.tags | split: "," %}
+{% assign exclude_tags = include.except_tags | split: "," %}
+{% assign sorted_pages = site.pages | sort_using: site.data.sidebars.pmd_sidebar %}
+
+{% assign panel_id = include.title | downcase | strip | replace: ' ', '-'Â | prepend: "shuffle-panel-" %}
+
+
+
+
+
+
+
+
+
+
+
+ {{ include.title }}
+{{ include.description }}
+ +
+
diff --git a/docs/_includes/head.html b/docs/_includes/head.html
index f5ca45688a5..8e115b3fa0b 100644
--- a/docs/_includes/head.html
+++ b/docs/_includes/head.html
@@ -13,6 +13,7 @@
+
diff --git a/docs/_includes/initialize_shuffle.html b/docs/_includes/initialize_shuffle.html
index 9a0f048dd11..73354870b7e 100644
--- a/docs/_includes/initialize_shuffle.html
+++ b/docs/_includes/initialize_shuffle.html
@@ -30,21 +30,30 @@
// Set up button clicks
setupFilters = function() {
- var $btns = $filterOptions.children();
+ var $btns = $filterOptions.children().add('.topical-filter');
$btns.on('click', function() {
var $this = $(this),
isActive = $this.hasClass( 'active' ),
+ isMainTopicButton = $this.hasClass('topical-filter'),
group = isActive ? 'all' : $this.data('group');
// Hide current label, show current label in title
if ( !isActive ) {
- $('.filter-options .active').removeClass('active');
+ $('.filter-options .active').add('.topical-filter.active').removeClass('active');
}
$this.toggleClass('active');
// Filter elements
$grid.shuffle( 'shuffle', group );
+
+ // scroll to the grid
+ if ( isMainTopicButton && !isActive ) {
+ $('html, body').animate({
+ scrollTop: $("#grid-rule").offset().top
+ }, 500);
+ }
+
});
$btns = null;
@@ -98,9 +107,9 @@
-
+
-
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
index eeeb4d56150..84e0c2cefe4 100644
--- a/docs/_layouts/default.html
+++ b/docs/_layouts/default.html
@@ -73,6 +73,9 @@
+
+
+
+
+
+ {% if include.image != "" and include.image != nil %}
+
+
+
+
+
+
+
+ {% endif %}
+
+ {{ include.title }}
+
+
+
+ + {{ include.description }} +
+-
+ {% for page in sorted_pages %}
+ {% capture included %}{{ page.tags | intersect: include_tags | equals: include_tags }}{% endcapture %}
+ {% capture excluded %}{{ page.tags | intersect: exclude_tags | empty }}{% endcapture %}
+
+ {% if included contains "true" and excluded contains "true" %}
+
- {% eval titlemaker %} + {% endif %} + {% endfor %} +
{% include topnav.html %}
+
{% if site.google_analytics %}
{% include google_analytics.html %}
diff --git a/docs/_plugins/custom_filters.rb b/docs/_plugins/custom_filters.rb
new file mode 100644
index 00000000000..42ca4b0fefa
--- /dev/null
+++ b/docs/_plugins/custom_filters.rb
@@ -0,0 +1,121 @@
+module CustomFilters
+
+ # set intersection
+ def intersect(xs, ys)
+ if !xs || !ys
+ []
+ else
+ Array(xs) & Array(ys)
+ end
+ end
+
+ # set equality between two arrays
+ def equals(xs, ys)
+ a = Array(xs)
+ b = Array(ys)
+
+ ((a | b) - (a & b)).empty?
+ end
+
+ def empty(xs)
+ Array(xs).empty?
+ end
+
+
+ # print & pass
+ def pp(any)
+ puts "#{any}"
+ any
+ end
+
+ # sorts an array using the order defined by the given sidebar
+ def sort_using(xs, sidebar)
+ # caching is possible but doesn't improve significantly the build times
+
+ rank_lookup = rank_lookup_from_sidebar(sidebar)
+
+ xs.sort {|x, y|
+ # The default rank is very high so that pages that don't appear in the sidebar are put at the end
+ rx = rank_lookup[x.url] || 10000
+ ry = rank_lookup[y.url] || 10000
+
+ rx <=> ry
+ }
+
+ end
+
+ def regex_replace(str, regex, subst)
+ if str && regex
+ str.gsub(Regexp::new(regex), subst || "")
+ end
+ end
+
+ def regex_split(str, regex = nil)
+ if str
+ str.split(regex && Regexp::new(regex))
+ end
+ end
+
+ # Takes an array of strings and maps every element x to {{ x | append: suffix }}
+ def mappend(xs, suffix)
+ Array(xs).map {|x| "#{x}#{suffix}" }
+ end
+
+ # Returns the initial argument only if the second argument is truthy
+ def keep_if(any, test)
+ if test
+ any
+ end
+ end
+
+ # Append the suffix only if the condition argument is truthy
+ def append_if(str, condition, suffix)
+ if condition
+ str + suffix
+ else
+ str
+ end
+ end
+
+ def append_unless(str, condition, suffix)
+ append_if(str, !condition, suffix)
+ end
+
+ def render_markdown(input)
+ if input
+ res = input
+ res = res.gsub(/`(.*?)`/, '
@@ -81,22 +84,22 @@
-
+
+
{% assign content_col_size = "col-md-12" %}
{% unless page.hide_sidebar %}
-
-
-
+
- {% include sidebar.html %}
-
- {% assign content_col_size = "col-md-9" %}
+
+
+ {% include sidebar.html %}
+
+ {% assign content_col_size = "col-md-9" %}
{% endunless %}
{{content}}
-
-\1')
+ res = res.gsub(/\*\*(.*?)\*\*/, '\1')
+ res = res.gsub(/\*(.*?)\*/, '\1')
+ res.gsub(/\[(.*?)\]\((.*?)\)/, '\1')
+ end
+ end
+
+
+ private
+
+ def flatten_rec(seq)
+ seq.map {|h|
+ if (subs = h["folderitems"] || h["subfolderitems"] || h["subfolders"])
+ flatten_rec(subs).flatten
+ elsif (page = h["url"])
+ page
+ end
+ }.flatten
+ end
+
+ def rank_lookup_from_sidebar(sidebar)
+
+ folders = sidebar["entries"][0]["folders"]
+
+ ordered = flatten_rec(folders).select {|url|
+ url && url.end_with?(".html")
+ }
+
+ Hash[ordered.zip (0...ordered.size)]
+
+ end
+
+end
+
+Liquid::Template.register_filter(CustomFilters)
diff --git a/docs/_plugins/eval_tag.rb b/docs/_plugins/eval_tag.rb
new file mode 100644
index 00000000000..6c2318329ae
--- /dev/null
+++ b/docs/_plugins/eval_tag.rb
@@ -0,0 +1,29 @@
+
+# This tag takes a variable name as an input, and evaluates its value twice (dereferences it once)
+# E.g. if the symbol table is E = {"foo" => "bar", "bar" => "baz"},
+# then {% eval foo %} ~> E[E["foo"]] ~> E["bar"] ~> "baz"
+
+class EvalTag < Liquid::Tag
+
+ def initialize(tag_name, name_expression, tokens)
+ super
+ @name_expression = name_expression.strip
+ end
+
+
+ # Lookup allows access to the page/post variables through the tag context
+ def lookup(context, name)
+ lookup = context
+ name.strip.split(".").each {|value|
+ lookup = lookup[value]
+ }
+ lookup
+ end
+
+ def render(context)
+ lookup(context, lookup(context, @name_expression))
+ end
+end
+
+
+Liquid::Template.register_tag('eval', EvalTag)
diff --git a/docs/_plugins/rule_tag.rb b/docs/_plugins/rule_tag.rb
new file mode 100644
index 00000000000..0e81e64bdd6
--- /dev/null
+++ b/docs/_plugins/rule_tag.rb
@@ -0,0 +1,73 @@
+
+
+# Tag to reference a rule
+#
+# Usage:
+# {% rule "java/codestyle/LinguisticNaming" %} works from anywhere
+# If inside the doc page of a ruleset/category, the language and
+# category segment can be dropped, they're taken to be the same.
+#
+# That means rule descriptions can also reference rules e.g. by simply
+# saying {% rule AvoidFinalLocalVars %} if they're in the same category
+# This could allow deprecated rule notices to link to the replacement rule
+
+class RuleTag < Liquid::Tag
+ def initialize(tag_name, rule_ref, tokens)
+ super
+
+ if %r!(?:(?:(\w+)/)?(\w+)/)?(\w+)! =~ rule_ref
+
+ @lang_name = $1
+ @category_name = $2
+ @rule_name = $3
+
+ else
+ fail "Invalid rule reference format"
+ end
+
+ end
+
+ def render(context)
+
+
+
+ if /pmd_rules_(\w+)_(\w+)\.html/ =~ context["page.permalink"]
+ # If we're in a page describing a ruleset,
+ # omitted language or category are taken to be that of this page
+ @lang_name = @lang_name || $1
+ @category_name = @category_name || $2
+ end
+
+
+ unless @category_name
+ fail "no category for rule reference, and no implicit category name available"
+ end
+
+ unless @lang_name
+ fail "no language for rule reference, and no implicit language name available"
+ end
+
+
+ url_prefix = ""
+ # This is passed from the release notes processing script
+ # When generating links for the release notes, the links should be absolute
+ if context["is_release_notes_processor"]
+ url_prefix = "https://pmd.github.io/pmd-#{context["site.pmd.version"]}/"
+ end
+
+ markup_link(@rule_name, url_prefix + relativelink(@lang_name, @category_name, @rule_name))
+ end
+
+ private
+
+ def relativelink(lang, cat, rname)
+ "pmd_rules_#{lang}_#{cat}.html##{rname.downcase}"
+ end
+
+ def markup_link(rname, link)
+ "[`#{rname}`](#{link})"
+ end
+
+end
+
+Liquid::Template.register_tag('rule', RuleTag)
diff --git a/docs/_plugins/tocmaker_block.rb b/docs/_plugins/tocmaker_block.rb
new file mode 100644
index 00000000000..990d02e7a89
--- /dev/null
+++ b/docs/_plugins/tocmaker_block.rb
@@ -0,0 +1,60 @@
+# Generates a table of contents based on markdown headers in the body
+#
+# The block has 2 optional args:
+# * A variable name. If provided, the toc will only be generated if the var is true
+# * An integer, describing the maximum depth at which headers are added to the toc
+
+class TocMakerBlock < Liquid::Block
+
+ def initialize(tag_name, arg, tokens)
+ super
+
+ condition, depth = arg.split
+
+ @max_depth = depth.to_s.empty? ? 100 : depth.to_i
+ @condition_var = condition.strip unless condition.to_s.empty?
+
+ @body = tokens
+ end
+
+ def to_internal_link(header)
+ url = header.downcase.gsub(/\s+/, "-")
+
+ "[#{header}](##{url})"
+ end
+
+ def render(context)
+
+ contents = @body.render(context)
+
+ if @condition_var && !context[@condition_var]
+ # If the condition is false, the toc is not generated
+ return contents
+ end
+
+ headers = contents.lines.map {|l|
+ if /^(#+)\s+(\S.*)$/ =~ l
+ [$1.length, $2]
+ end
+ }.compact
+
+ min_indent = headers.map {|t| t[0]}.min
+
+ headers = headers.map {|t|
+ actual_depth = t[0] - min_indent
+ if actual_depth < @max_depth then
+
+ indent = " " * actual_depth
+
+ "#{indent}* #{to_internal_link(t[1])}"
+ end
+ }.compact
+
+ headers.unshift("### Table Of Contents\n")
+
+ headers.join("\n") + contents
+ end
+end
+
+
+Liquid::Template.register_tag('tocmaker', TocMakerBlock)
diff --git a/docs/_plugins/xpath_lexer.rb b/docs/_plugins/xpath_lexer.rb
new file mode 100644
index 00000000000..53b5a569fc5
--- /dev/null
+++ b/docs/_plugins/xpath_lexer.rb
@@ -0,0 +1,69 @@
+# -*- coding: utf-8 -*- #
+
+require 'rouge'
+
+module Rouge
+ module Lexers
+ class XPath < RegexLexer
+
+ title "XPath"
+ desc "The XPath query language (http://en.wikipedia.org/wiki/XPath)"
+ tag 'xpath'
+ aliases 'xpath'
+ filenames '*.xpath'
+ mimetypes 'text/x-xpath'
+
+ state :root do
+ mixin :basic
+ mixin :operators
+ mixin :names
+ end
+
+ state :basic do
+ rule /\s+/, Text::Whitespace
+ rule /[(]:(?![)])/, Comment, :nested_comment
+
+ rule /[\[\](){}|.,;!]/, Punctuation
+
+ rule /"([^"]|"")*+"/, Str::Double
+ rule /'([^']|'')*+'/, Str::Single
+
+ rule /\.\d++\b/, Num
+ rule /\b\d++\./, Num
+ rule /\b\d++(\.\d*+)?([eE][+-]?\d+)?\b/, Num
+ end
+
+ state :operators do
+ rule /(<|>|=<|>=|==|:=|\/\/|[|\/*+-])(?=\s|[a-zA-Z0-9\[])/, Operator
+ # operators
+ rule /(or|and|not|mod|ne|eq|lt|le|gt|ge)/, Operator::Word
+ # keywords
+ rule /some|in|satisfies|as|is|for|every|cast|castable|treat|instance|of|to|if|then|else|return|let|intersect|except|union|div|idiv/, Keyword::Reserved
+ # axes
+ rule /(self|child|attribute|descendant|descendant-or-self|ancestor|ancestor-or-self|following|following-sibling|namespace|parent|preceding-sibling)::/, Keyword::Namespace
+ # kind tests
+ rule /(node|document-node|text|comment|namespace-node|processing-instruction|attribute|schema-attribute|element|schema-element|function)\(\)/, Keyword::Reserved
+ end
+
+ state :names do
+ # Function or node namespace
+ rule /[a-zA-Z\-]+:/, Name::Namespace
+ # Attributes
+ rule /@[a-zA-Z][_\-a-zA-Z0-9]*/, Name::Attribute
+ # XPath variables
+ rule /\$\s*[a-zA-Z][_\-a-zA-Z0-9]*/, Name::Variable
+ # Functions
+ rule /[a-zA-Z\-]+(?=\s*+\()/, Name::Function
+ # Node names
+ rule /[a-zA-Z]+/, Name::Tag
+ end
+
+ state :nested_comment do
+ rule /[^(:)]+/, Comment
+ rule /\(:/, Comment, :push
+ rule /:\)/, Comment, :pop!
+ rule /[(:)]/, Comment
+ end
+ end
+ end
+end
diff --git a/docs/build-docs.sh b/docs/build-docs.sh
new file mode 100644
index 00000000000..b1056030750
--- /dev/null
+++ b/docs/build-docs.sh
@@ -0,0 +1,3 @@
+bundle install --path vendor/bundle
+bundle update
+bundle exec jekyll build
diff --git a/docs/css/customstyles.css b/docs/css/customstyles.css
index 452b23bf121..d505dbd8de9 100644
--- a/docs/css/customstyles.css
+++ b/docs/css/customstyles.css
@@ -79,8 +79,8 @@ h4[id],
h5[id],
h6[id],
dt[id]{
-padding-top: 60px;
-margin-top: -40px
+padding-top: 20px;
+margin-top: 0px
}
body h1 {margin-top:40px;}
diff --git a/docs/css/pmd-customstyles.css b/docs/css/pmd-customstyles.css
new file mode 100644
index 00000000000..e9de59c7135
--- /dev/null
+++ b/docs/css/pmd-customstyles.css
@@ -0,0 +1,22 @@
+
+.panel-body {
+ padding-top: 0cm;
+}
+
+.landing-page.cat-title {
+ margin-bottom: .5cm;
+ margin-top: .5cm;
+}
+
+.landing-page.cat-description {
+ margin-top: .4cm;
+}
+
+/* Offsets contents by the height of the nav bar */
+#topbar-content-offset {
+ overflow: scroll;
+ position: absolute;
+ top: 50px; /* height of the nav bar */
+ bottom: 0px;
+ width: 100%;
+}
\ No newline at end of file
diff --git a/docs/images/credits/MD_logo4c_120x120.png b/docs/images/credits/MD_logo4c_120x120.png
new file mode 100644
index 00000000000..c641799fa9d
Binary files /dev/null and b/docs/images/credits/MD_logo4c_120x120.png differ
diff --git a/docs/index.md b/docs/index.md
index 2f63d0f86d9..55e9c9e5cd6 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,97 +1,155 @@
---
-title: PMD Introduction
+title: Documentation Index
keywords: java
-tags: [getting_started]
permalink: index.html
toc: false
summary: >
- Welcome to PMD, an extensible cross-language static code analyzer.
- It finds common programming flaws like unused variables, empty catch blocks, unnecessary object creation,
- and so forth. Additionally it includes CPD, the copy-paste-detector. CPD finds duplicated code.
+ Welcome to the documentation site for PMD and CPD! + + last_updated: August 2017 -author: Jeff Jensen
-**PMD** scans source code in Java and other languages and looks for potential problems like: +{% unless site.output == "pdf" %} + + + +{% include custom/panel_scroll.html %} +{% endunless %} + + +## Overview + + + + +**PMD** is a static source code analyzer. It finds common programming flaws like +unused variables, empty catch blocks, unnecessary object creation, and +so forth. It's mainly concerned with **Java and Apex**, but **supports six other +languages**. + +PMD features many **built-in checks** (in PMD lingo, *rules*), which are documented +for each language in our [Rule references](#shuffle-panel-rule-references). We +also support an extensive API to [**write your own rules**](#shuffle-panel-writing-rules), +which you can do either in Java or as a self-contained XPath query. + +PMD is most useful when **integrated into your build process**. It can then be +used as a quality gate, to enforce a coding standard for your codebase. Among other +things, PMD can be run: +* As a [Maven goal](pmd_userdocs_tools_maven.html) +* As an [Ant task](pmd_userdocs_tools_ant.html) +* As a [Gradle task](https://docs.gradle.org/current/userguide/pmd_plugin.html) +* From [command-line](pmd_userdocs_installation.html#running-pmd-via-command-line) + +**CPD**, the **copy-paste detector**, is also distributed with PMD. You can also use it +in a variety of ways, which are [documented here](pmd_userdocs_cpd.html). + +## Download + +The latest release of PMD can be downloaded from our [Github releases page](https://github.com/pmd/pmd/releases/latest). + + +## Documentation + +The rest of this page exposes the contents of the documentation site thematically, +which you can further scope down using the blue filter buttons. To navigate the site, +you may also use the search bar in the top right, or the sidebar on the left. + + +
+ + + + + + + -* Possible bugs - empty try/catch/finally/switch statements -* Dead code - unused local variables, parameters and private methods -* Suboptimal code - wasteful String/StringBuffer usage -* Overcomplicated expressions - unnecessary if statements, for loops that could be while loops +
+
+
-## Download PMD {{ site.pmd.version }}
+{% unless site.output == "pdf" %}
-Latest Version: {{ site.pmd.version }} ({{ site.pmd.date }})
+{% include initialize_shuffle.html %}
-* [Release Notes](pmd_release_notes.html)
-* [Download](https://github.com/pmd/pmd/releases)
+{% endunless %}
diff --git a/docs/js/jquery-ui.min.js b/docs/js/jquery-ui.min.js
new file mode 100644
index 00000000000..db0af4c4d59
--- /dev/null
+++ b/docs/js/jquery-ui.min.js
@@ -0,0 +1,6 @@
+/*! jQuery UI - v1.12.1 - 2018-05-27
+* http://jqueryui.com
+* Includes: effect.js, effects/effect-blind.js, effects/effect-bounce.js, effects/effect-clip.js, effects/effect-drop.js, effects/effect-explode.js, effects/effect-fade.js, effects/effect-fold.js, effects/effect-highlight.js, effects/effect-puff.js, effects/effect-pulsate.js, effects/effect-scale.js, effects/effect-shake.js, effects/effect-size.js, effects/effect-slide.js, effects/effect-transfer.js
+* Copyright jQuery Foundation and other contributors; Licensed MIT */
+
+(function(t){"function"==typeof define&&define.amd?define(["jquery"],t):t(jQuery)})(function(t){t.ui=t.ui||{},t.ui.version="1.12.1";var e="ui-effects-",i="ui-effects-style",s="ui-effects-animated",n=t;t.effects={effect:{}},function(t,e){function i(t,e,i){var s=u[e.type]||{};return null==t?i||!e.def?null:e.def:(t=s.floor?~~t:parseFloat(t),isNaN(t)?e.def:s.mod?(t+s.mod)%s.mod:0>t?0:t>s.max?s.max:t)}function s(i){var s=h(),n=s._rgba=[];return i=i.toLowerCase(),f(l,function(t,o){var a,r=o.re.exec(i),l=r&&o.parse(r),h=o.space||"rgba";return l?(a=s[h](l),s[c[h].cache]=a[c[h].cache],n=s._rgba=a._rgba,!1):e}),n.length?("0,0,0,0"===n.join()&&t.extend(n,o.transparent),s):o[i]}function n(t,e,i){return i=(i+1)%1,1>6*i?t+6*(e-t)*i:1>2*i?e:2>3*i?t+6*(e-t)*(2/3-i):t}var o,a="backgroundColor borderBottomColor borderLeftColor borderRightColor borderTopColor color columnRuleColor outlineColor textDecorationColor textEmphasisColor",r=/^([\-+])=\s*(\d+\.?\d*)/,l=[{re:/rgba?\(\s*(\d{1,3})\s*,\s*(\d{1,3})\s*,\s*(\d{1,3})\s*(?:,\s*(\d?(?:\.\d+)?)\s*)?\)/,parse:function(t){return[t[1],t[2],t[3],t[4]]}},{re:/rgba?\(\s*(\d+(?:\.\d+)?)\%\s*,\s*(\d+(?:\.\d+)?)\%\s*,\s*(\d+(?:\.\d+)?)\%\s*(?:,\s*(\d?(?:\.\d+)?)\s*)?\)/,parse:function(t){return[2.55*t[1],2.55*t[2],2.55*t[3],t[4]]}},{re:/#([a-f0-9]{2})([a-f0-9]{2})([a-f0-9]{2})/,parse:function(t){return[parseInt(t[1],16),parseInt(t[2],16),parseInt(t[3],16)]}},{re:/#([a-f0-9])([a-f0-9])([a-f0-9])/,parse:function(t){return[parseInt(t[1]+t[1],16),parseInt(t[2]+t[2],16),parseInt(t[3]+t[3],16)]}},{re:/hsla?\(\s*(\d+(?:\.\d+)?)\s*,\s*(\d+(?:\.\d+)?)\%\s*,\s*(\d+(?:\.\d+)?)\%\s*(?:,\s*(\d?(?:\.\d+)?)\s*)?\)/,space:"hsla",parse:function(t){return[t[1],t[2]/100,t[3]/100,t[4]]}}],h=t.Color=function(e,i,s,n){return new t.Color.fn.parse(e,i,s,n)},c={rgba:{props:{red:{idx:0,type:"byte"},green:{idx:1,type:"byte"},blue:{idx:2,type:"byte"}}},hsla:{props:{hue:{idx:0,type:"degrees"},saturation:{idx:1,type:"percent"},lightness:{idx:2,type:"percent"}}}},u={"byte":{floor:!0,max:255},percent:{max:1},degrees:{mod:360,floor:!0}},d=h.support={},p=t("
-**CPD**, the copy-paste-detector, finds duplicated code in many languages:
+
+ {% include custom/shuffle_panel.html
+ title="Getting started"
+ tags="getting_started"
+ datagroups='["getting_started"]'
+ description="These pages summarize the gist of PMD usage to get you started quickly." %}
-* Duplicate code is often just copied and pasted. This means, the bugs are also copied and pasted. Fixing
- them means, fix all duplicated code locations.
-## Features
+ {% include custom/shuffle_panel.html
+ title="Rule references"
+ tags="rule_references"
+ datagroups='["userdocs"]'
+ description="Pick your language to find out about the rule it supports."
+ image="fa-database"
+ titlemaker="page.language_name" %}
-{::options parse_block_html="true" /}
+ {% include custom/shuffle_panel.html
+ title="Writing rules"
+ tags="userdocs,extending"
+ datagroups='["userdocs", "extending", "contributing"]'
+ description="These pages document the process of writing and testing custom rules and metrics for PMD."
+ %}
-
-
-### PMD
+ {% include custom/shuffle_panel.html
+ title="Usage and configuration"
+ tags="userdocs"
+ except_tags="extending,tools"
+ datagroups='["userdocs"]'
+ image="fa-cog"
+ description="Learn how to build effective and versatile rulesets."
+ %}
-Features:
-* Supporting 8 languages
-* Many ready-to-use built-in rules.
-* Custom rules can be written in Java
-* Custom rules can be written using XPath expression that query the AST of the sources
-* Many output formats
-* Many integrations into IDEs, build tools
+ {% include custom/shuffle_panel.html
+ title="Contributing"
+ tags="devdocs"
+ except_tags="extending"
+ datagroups='["contributing"]'
+ image="fa-github"
+ description="If you'd like to help us build PMD, these topics may interest you. See you around!"
+ %}
-Supported Languages:
-* [Java](pmd_rules_java.html)
-* [JavaScript](pmd_rules_ecmascript.html)
-* [Salesforce.com Apex](pmd_rules_apex.html) and [Visualforce](pmd_rules_vf.html)
-* [PLSQL](pmd_rules_plsql.html)
-* [Apache Velocity](pmd_rules_vm.html)
-* [XML](pmd_rules_xml.html) and [Maven POM](pmd_rules_pom.html)
-* [XSL](pmd_rules_xsl.html)
-
-### CPD
+ {% include custom/shuffle_panel.html
+ title="Tools and integrations"
+ tags="tools"
+ datagroups='["userdocs"]'
+ description="These pages describe solutions that integrate PMD within your build process."
+ %}
-Features:
+ {% include custom/shuffle_panel.html
+ title="Major contributions"
+ tags="devdocs,extending"
+ datagroups='["contributing","extending"]'
+ description=""
+ %}
-* Supporting 19 languages
-* Simple GUI
-* Fast
-* Many integrations
-Supported Languages:
+
+
-* Java
-* C, C++
-* C#
-* Groovy
-* PHP
-* Ruby
-* Fortran
-* JavaScript
-* PLSQL
-* Apache Velocity
-* Scala
-* Objective C
-* Matlab
-* Python
-* Go
-* Swift
-* Salesforce.com Apex and Visualforce
+
+")[0],f=t.each;p.style.cssText="background-color:rgba(1,1,1,.5)",d.rgba=p.style.backgroundColor.indexOf("rgba")>-1,f(c,function(t,e){e.cache="_"+t,e.props.alpha={idx:3,type:"percent",def:1}}),h.fn=t.extend(h.prototype,{parse:function(n,a,r,l){if(n===e)return this._rgba=[null,null,null,null],this;(n.jquery||n.nodeType)&&(n=t(n).css(a),a=e);var u=this,d=t.type(n),p=this._rgba=[];return a!==e&&(n=[n,a,r,l],d="array"),"string"===d?this.parse(s(n)||o._default):"array"===d?(f(c.rgba.props,function(t,e){p[e.idx]=i(n[e.idx],e)}),this):"object"===d?(n instanceof h?f(c,function(t,e){n[e.cache]&&(u[e.cache]=n[e.cache].slice())}):f(c,function(e,s){var o=s.cache;f(s.props,function(t,e){if(!u[o]&&s.to){if("alpha"===t||null==n[t])return;u[o]=s.to(u._rgba)}u[o][e.idx]=i(n[t],e,!0)}),u[o]&&0>t.inArray(null,u[o].slice(0,3))&&(u[o][3]=1,s.from&&(u._rgba=s.from(u[o])))}),this):e},is:function(t){var i=h(t),s=!0,n=this;return f(c,function(t,o){var a,r=i[o.cache];return r&&(a=n[o.cache]||o.to&&o.to(n._rgba)||[],f(o.props,function(t,i){return null!=r[i.idx]?s=r[i.idx]===a[i.idx]:e})),s}),s},_space:function(){var t=[],e=this;return f(c,function(i,s){e[s.cache]&&t.push(i)}),t.pop()},transition:function(t,e){var s=h(t),n=s._space(),o=c[n],a=0===this.alpha()?h("transparent"):this,r=a[o.cache]||o.to(a._rgba),l=r.slice();return s=s[o.cache],f(o.props,function(t,n){var o=n.idx,a=r[o],h=s[o],c=u[n.type]||{};null!==h&&(null===a?l[o]=h:(c.mod&&(h-a>c.mod/2?a+=c.mod:a-h>c.mod/2&&(a-=c.mod)),l[o]=i((h-a)*e+a,n)))}),this[n](l)},blend:function(e){if(1===this._rgba[3])return this;var i=this._rgba.slice(),s=i.pop(),n=h(e)._rgba;return h(t.map(i,function(t,e){return(1-s)*n[e]+s*t}))},toRgbaString:function(){var e="rgba(",i=t.map(this._rgba,function(t,e){return null==t?e>2?1:0:t});return 1===i[3]&&(i.pop(),e="rgb("),e+i.join()+")"},toHslaString:function(){var e="hsla(",i=t.map(this.hsla(),function(t,e){return null==t&&(t=e>2?1:0),e&&3>e&&(t=Math.round(100*t)+"%"),t});return 1===i[3]&&(i.pop(),e="hsl("),e+i.join()+")"},toHexString:function(e){var i=this._rgba.slice(),s=i.pop();return e&&i.push(~~(255*s)),"#"+t.map(i,function(t){return t=(t||0).toString(16),1===t.length?"0"+t:t}).join("")},toString:function(){return 0===this._rgba[3]?"transparent":this.toRgbaString()}}),h.fn.parse.prototype=h.fn,c.hsla.to=function(t){if(null==t[0]||null==t[1]||null==t[2])return[null,null,null,t[3]];var e,i,s=t[0]/255,n=t[1]/255,o=t[2]/255,a=t[3],r=Math.max(s,n,o),l=Math.min(s,n,o),h=r-l,c=r+l,u=.5*c;return e=l===r?0:s===r?60*(n-o)/h+360:n===r?60*(o-s)/h+120:60*(s-n)/h+240,i=0===h?0:.5>=u?h/c:h/(2-c),[Math.round(e)%360,i,u,null==a?1:a]},c.hsla.from=function(t){if(null==t[0]||null==t[1]||null==t[2])return[null,null,null,t[3]];var e=t[0]/360,i=t[1],s=t[2],o=t[3],a=.5>=s?s*(1+i):s+i-s*i,r=2*s-a;return[Math.round(255*n(r,a,e+1/3)),Math.round(255*n(r,a,e)),Math.round(255*n(r,a,e-1/3)),o]},f(c,function(s,n){var o=n.props,a=n.cache,l=n.to,c=n.from;h.fn[s]=function(s){if(l&&!this[a]&&(this[a]=l(this._rgba)),s===e)return this[a].slice();var n,r=t.type(s),u="array"===r||"object"===r?s:arguments,d=this[a].slice();return f(o,function(t,e){var s=u["object"===r?t:e.idx];null==s&&(s=d[e.idx]),d[e.idx]=i(s,e)}),c?(n=h(c(d)),n[a]=d,n):h(d)},f(o,function(e,i){h.fn[e]||(h.fn[e]=function(n){var o,a=t.type(n),l="alpha"===e?this._hsla?"hsla":"rgba":s,h=this[l](),c=h[i.idx];return"undefined"===a?c:("function"===a&&(n=n.call(this,c),a=t.type(n)),null==n&&i.empty?this:("string"===a&&(o=r.exec(n),o&&(n=c+parseFloat(o[2])*("+"===o[1]?1:-1))),h[i.idx]=n,this[l](h)))})})}),h.hook=function(e){var i=e.split(" ");f(i,function(e,i){t.cssHooks[i]={set:function(e,n){var o,a,r="";if("transparent"!==n&&("string"!==t.type(n)||(o=s(n)))){if(n=h(o||n),!d.rgba&&1!==n._rgba[3]){for(a="backgroundColor"===i?e.parentNode:e;(""===r||"transparent"===r)&&a&&a.style;)try{r=t.css(a,"backgroundColor"),a=a.parentNode}catch(l){}n=n.blend(r&&"transparent"!==r?r:"_default")}n=n.toRgbaString()}try{e.style[i]=n}catch(l){}}},t.fx.step[i]=function(e){e.colorInit||(e.start=h(e.elem,i),e.end=h(e.end),e.colorInit=!0),t.cssHooks[i].set(e.elem,e.start.transition(e.end,e.pos))}})},h.hook(a),t.cssHooks.borderColor={expand:function(t){var e={};return f(["Top","Right","Bottom","Left"],function(i,s){e["border"+s+"Color"]=t}),e}},o=t.Color.names={aqua:"#00ffff",black:"#000000",blue:"#0000ff",fuchsia:"#ff00ff",gray:"#808080",green:"#008000",lime:"#00ff00",maroon:"#800000",navy:"#000080",olive:"#808000",purple:"#800080",red:"#ff0000",silver:"#c0c0c0",teal:"#008080",white:"#ffffff",yellow:"#ffff00",transparent:[null,null,null,0],_default:"#ffffff"}}(n),function(){function e(e){var i,s,n=e.ownerDocument.defaultView?e.ownerDocument.defaultView.getComputedStyle(e,null):e.currentStyle,o={};if(n&&n.length&&n[0]&&n[n[0]])for(s=n.length;s--;)i=n[s],"string"==typeof n[i]&&(o[t.camelCase(i)]=n[i]);else for(i in n)"string"==typeof n[i]&&(o[i]=n[i]);return o}function i(e,i){var s,n,a={};for(s in i)n=i[s],e[s]!==n&&(o[s]||(t.fx.step[s]||!isNaN(parseFloat(n)))&&(a[s]=n));return a}var s=["add","remove","toggle"],o={border:1,borderBottom:1,borderColor:1,borderLeft:1,borderRight:1,borderTop:1,borderWidth:1,margin:1,padding:1};t.each(["borderLeftStyle","borderRightStyle","borderBottomStyle","borderTopStyle"],function(e,i){t.fx.step[i]=function(t){("none"!==t.end&&!t.setAttr||1===t.pos&&!t.setAttr)&&(n.style(t.elem,i,t.end),t.setAttr=!0)}}),t.fn.addBack||(t.fn.addBack=function(t){return this.add(null==t?this.prevObject:this.prevObject.filter(t))}),t.effects.animateClass=function(n,o,a,r){var l=t.speed(o,a,r);return this.queue(function(){var o,a=t(this),r=a.attr("class")||"",h=l.children?a.find("*").addBack():a;h=h.map(function(){var i=t(this);return{el:i,start:e(this)}}),o=function(){t.each(s,function(t,e){n[e]&&a[e+"Class"](n[e])})},o(),h=h.map(function(){return this.end=e(this.el[0]),this.diff=i(this.start,this.end),this}),a.attr("class",r),h=h.map(function(){var e=this,i=t.Deferred(),s=t.extend({},l,{queue:!1,complete:function(){i.resolve(e)}});return this.el.animate(this.diff,s),i.promise()}),t.when.apply(t,h.get()).done(function(){o(),t.each(arguments,function(){var e=this.el;t.each(this.diff,function(t){e.css(t,"")})}),l.complete.call(a[0])})})},t.fn.extend({addClass:function(e){return function(i,s,n,o){return s?t.effects.animateClass.call(this,{add:i},s,n,o):e.apply(this,arguments)}}(t.fn.addClass),removeClass:function(e){return function(i,s,n,o){return arguments.length>1?t.effects.animateClass.call(this,{remove:i},s,n,o):e.apply(this,arguments)}}(t.fn.removeClass),toggleClass:function(e){return function(i,s,n,o,a){return"boolean"==typeof s||void 0===s?n?t.effects.animateClass.call(this,s?{add:i}:{remove:i},n,o,a):e.apply(this,arguments):t.effects.animateClass.call(this,{toggle:i},s,n,o)}}(t.fn.toggleClass),switchClass:function(e,i,s,n,o){return t.effects.animateClass.call(this,{add:i,remove:e},s,n,o)}})}(),function(){function n(e,i,s,n){return t.isPlainObject(e)&&(i=e,e=e.effect),e={effect:e},null==i&&(i={}),t.isFunction(i)&&(n=i,s=null,i={}),("number"==typeof i||t.fx.speeds[i])&&(n=s,s=i,i={}),t.isFunction(s)&&(n=s,s=null),i&&t.extend(e,i),s=s||i.duration,e.duration=t.fx.off?0:"number"==typeof s?s:s in t.fx.speeds?t.fx.speeds[s]:t.fx.speeds._default,e.complete=n||i.complete,e}function o(e){return!e||"number"==typeof e||t.fx.speeds[e]?!0:"string"!=typeof e||t.effects.effect[e]?t.isFunction(e)?!0:"object"!=typeof e||e.effect?!1:!0:!0}function a(t,e){var i=e.outerWidth(),s=e.outerHeight(),n=/^rect\((-?\d*\.?\d*px|-?\d+%|auto),?\s*(-?\d*\.?\d*px|-?\d+%|auto),?\s*(-?\d*\.?\d*px|-?\d+%|auto),?\s*(-?\d*\.?\d*px|-?\d+%|auto)\)$/,o=n.exec(t)||["",0,i,s,0];return{top:parseFloat(o[1])||0,right:"auto"===o[2]?i:parseFloat(o[2]),bottom:"auto"===o[3]?s:parseFloat(o[3]),left:parseFloat(o[4])||0}}t.expr&&t.expr.filters&&t.expr.filters.animated&&(t.expr.filters.animated=function(e){return function(i){return!!t(i).data(s)||e(i)}}(t.expr.filters.animated)),t.uiBackCompat!==!1&&t.extend(t.effects,{save:function(t,i){for(var s=0,n=i.length;n>s;s++)null!==i[s]&&t.data(e+i[s],t[0].style[i[s]])},restore:function(t,i){for(var s,n=0,o=i.length;o>n;n++)null!==i[n]&&(s=t.data(e+i[n]),t.css(i[n],s))},setMode:function(t,e){return"toggle"===e&&(e=t.is(":hidden")?"show":"hide"),e},createWrapper:function(e){if(e.parent().is(".ui-effects-wrapper"))return e.parent();var i={width:e.outerWidth(!0),height:e.outerHeight(!0),"float":e.css("float")},s=t("
").addClass("ui-effects-wrapper").css({fontSize:"100%",background:"transparent",border:"none",margin:0,padding:0}),n={width:e.width(),height:e.height()},o=document.activeElement;try{o.id}catch(a){o=document.body}return e.wrap(s),(e[0]===o||t.contains(e[0],o))&&t(o).trigger("focus"),s=e.parent(),"static"===e.css("position")?(s.css({position:"relative"}),e.css({position:"relative"})):(t.extend(i,{position:e.css("position"),zIndex:e.css("z-index")}),t.each(["top","left","bottom","right"],function(t,s){i[s]=e.css(s),isNaN(parseInt(i[s],10))&&(i[s]="auto")}),e.css({position:"relative",top:0,left:0,right:"auto",bottom:"auto"})),e.css(n),s.css(i).show()},removeWrapper:function(e){var i=document.activeElement;return e.parent().is(".ui-effects-wrapper")&&(e.parent().replaceWith(e),(e[0]===i||t.contains(e[0],i))&&t(i).trigger("focus")),e}}),t.extend(t.effects,{version:"1.12.1",define:function(e,i,s){return s||(s=i,i="effect"),t.effects.effect[e]=s,t.effects.effect[e].mode=i,s},scaledDimensions:function(t,e,i){if(0===e)return{height:0,width:0,outerHeight:0,outerWidth:0};var s="horizontal"!==i?(e||100)/100:1,n="vertical"!==i?(e||100)/100:1;return{height:t.height()*n,width:t.width()*s,outerHeight:t.outerHeight()*n,outerWidth:t.outerWidth()*s}},clipToBox:function(t){return{width:t.clip.right-t.clip.left,height:t.clip.bottom-t.clip.top,left:t.clip.left,top:t.clip.top}},unshift:function(t,e,i){var s=t.queue();e>1&&s.splice.apply(s,[1,0].concat(s.splice(e,i))),t.dequeue()},saveStyle:function(t){t.data(i,t[0].style.cssText)},restoreStyle:function(t){t[0].style.cssText=t.data(i)||"",t.removeData(i)},mode:function(t,e){var i=t.is(":hidden");return"toggle"===e&&(e=i?"show":"hide"),(i?"hide"===e:"show"===e)&&(e="none"),e},getBaseline:function(t,e){var i,s;switch(t[0]){case"top":i=0;break;case"middle":i=.5;break;case"bottom":i=1;break;default:i=t[0]/e.height}switch(t[1]){case"left":s=0;break;case"center":s=.5;break;case"right":s=1;break;default:s=t[1]/e.width}return{x:s,y:i}},createPlaceholder:function(i){var s,n=i.css("position"),o=i.position();return i.css({marginTop:i.css("marginTop"),marginBottom:i.css("marginBottom"),marginLeft:i.css("marginLeft"),marginRight:i.css("marginRight")}).outerWidth(i.outerWidth()).outerHeight(i.outerHeight()),/^(static|relative)/.test(n)&&(n="absolute",s=t("<"+i[0].nodeName+">").insertAfter(i).css({display:/^(inline|ruby)/.test(i.css("display"))?"inline-block":"block",visibility:"hidden",marginTop:i.css("marginTop"),marginBottom:i.css("marginBottom"),marginLeft:i.css("marginLeft"),marginRight:i.css("marginRight"),"float":i.css("float")}).outerWidth(i.outerWidth()).outerHeight(i.outerHeight()).addClass("ui-effects-placeholder"),i.data(e+"placeholder",s)),i.css({position:n,left:o.left,top:o.top}),s},removePlaceholder:function(t){var i=e+"placeholder",s=t.data(i);s&&(s.remove(),t.removeData(i))},cleanUp:function(e){t.effects.restoreStyle(e),t.effects.removePlaceholder(e)},setTransition:function(e,i,s,n){return n=n||{},t.each(i,function(t,i){var o=e.cssUnit(i);o[0]>0&&(n[i]=o[0]*s+o[1])}),n}}),t.fn.extend({effect:function(){function e(e){function n(){l.removeData(s),t.effects.cleanUp(l),"hide"===i.mode&&l.hide(),r()}function r(){t.isFunction(h)&&h.call(l[0]),t.isFunction(e)&&e()}var l=t(this);i.mode=u.shift(),t.uiBackCompat===!1||a?"none"===i.mode?(l[c](),r()):o.call(l[0],i,n):(l.is(":hidden")?"hide"===c:"show"===c)?(l[c](),r()):o.call(l[0],i,r)}var i=n.apply(this,arguments),o=t.effects.effect[i.effect],a=o.mode,r=i.queue,l=r||"fx",h=i.complete,c=i.mode,u=[],d=function(e){var i=t(this),n=t.effects.mode(i,c)||a;i.data(s,!0),u.push(n),a&&("show"===n||n===a&&"hide"===n)&&i.show(),a&&"none"===n||t.effects.saveStyle(i),t.isFunction(e)&&e()};return t.fx.off||!o?c?this[c](i.duration,h):this.each(function(){h&&h.call(this)}):r===!1?this.each(d).each(e):this.queue(l,d).queue(l,e)},show:function(t){return function(e){if(o(e))return t.apply(this,arguments);var i=n.apply(this,arguments);return i.mode="show",this.effect.call(this,i)}}(t.fn.show),hide:function(t){return function(e){if(o(e))return t.apply(this,arguments);var i=n.apply(this,arguments);return i.mode="hide",this.effect.call(this,i)}}(t.fn.hide),toggle:function(t){return function(e){if(o(e)||"boolean"==typeof e)return t.apply(this,arguments);var i=n.apply(this,arguments);return i.mode="toggle",this.effect.call(this,i)}}(t.fn.toggle),cssUnit:function(e){var i=this.css(e),s=[];return t.each(["em","px","%","pt"],function(t,e){i.indexOf(e)>0&&(s=[parseFloat(i),e])}),s},cssClip:function(t){return t?this.css("clip","rect("+t.top+"px "+t.right+"px "+t.bottom+"px "+t.left+"px)"):a(this.css("clip"),this)},transfer:function(e,i){var s=t(this),n=t(e.to),o="fixed"===n.css("position"),a=t("body"),r=o?a.scrollTop():0,l=o?a.scrollLeft():0,h=n.offset(),c={top:h.top-r,left:h.left-l,height:n.innerHeight(),width:n.innerWidth()},u=s.offset(),d=t("").appendTo("body").addClass(e.className).css({top:u.top-r,left:u.left-l,height:s.innerHeight(),width:s.innerWidth(),position:o?"fixed":"absolute"}).animate(c,e.duration,e.easing,function(){d.remove(),t.isFunction(i)&&i()})}}),t.fx.step.clip=function(e){e.clipInit||(e.start=t(e.elem).cssClip(),"string"==typeof e.end&&(e.end=a(e.end,e.elem)),e.clipInit=!0),t(e.elem).cssClip({top:e.pos*(e.end.top-e.start.top)+e.start.top,right:e.pos*(e.end.right-e.start.right)+e.start.right,bottom:e.pos*(e.end.bottom-e.start.bottom)+e.start.bottom,left:e.pos*(e.end.left-e.start.left)+e.start.left})}}(),function(){var e={};t.each(["Quad","Cubic","Quart","Quint","Expo"],function(t,i){e[i]=function(e){return Math.pow(e,t+2)}}),t.extend(e,{Sine:function(t){return 1-Math.cos(t*Math.PI/2)},Circ:function(t){return 1-Math.sqrt(1-t*t)},Elastic:function(t){return 0===t||1===t?t:-Math.pow(2,8*(t-1))*Math.sin((80*(t-1)-7.5)*Math.PI/15)},Back:function(t){return t*t*(3*t-2)},Bounce:function(t){for(var e,i=4;((e=Math.pow(2,--i))-1)/11>t;);return 1/Math.pow(4,3-i)-7.5625*Math.pow((3*e-2)/22-t,2)}}),t.each(e,function(e,i){t.easing["easeIn"+e]=i,t.easing["easeOut"+e]=function(t){return 1-i(1-t)},t.easing["easeInOut"+e]=function(t){return.5>t?i(2*t)/2:1-i(-2*t+2)/2}})}();var o=t.effects;t.effects.define("blind","hide",function(e,i){var s={up:["bottom","top"],vertical:["bottom","top"],down:["top","bottom"],left:["right","left"],horizontal:["right","left"],right:["left","right"]},n=t(this),o=e.direction||"up",a=n.cssClip(),r={clip:t.extend({},a)},l=t.effects.createPlaceholder(n);r.clip[s[o][0]]=r.clip[s[o][1]],"show"===e.mode&&(n.cssClip(r.clip),l&&l.css(t.effects.clipToBox(r)),r.clip=a),l&&l.animate(t.effects.clipToBox(r),e.duration,e.easing),n.animate(r,{queue:!1,duration:e.duration,easing:e.easing,complete:i})}),t.effects.define("bounce",function(e,i){var s,n,o,a=t(this),r=e.mode,l="hide"===r,h="show"===r,c=e.direction||"up",u=e.distance,d=e.times||5,p=2*d+(h||l?1:0),f=e.duration/p,m=e.easing,g="up"===c||"down"===c?"top":"left",_="up"===c||"left"===c,v=0,b=a.queue().length;for(t.effects.createPlaceholder(a),o=a.css(g),u||(u=a["top"===g?"outerHeight":"outerWidth"]()/3),h&&(n={opacity:1},n[g]=o,a.css("opacity",0).css(g,_?2*-u:2*u).animate(n,f,m)),l&&(u/=Math.pow(2,d-1)),n={},n[g]=o;d>v;v++)s={},s[g]=(_?"-=":"+=")+u,a.animate(s,f,m).animate(n,f,m),u=l?2*u:u/2;l&&(s={opacity:0},s[g]=(_?"-=":"+=")+u,a.animate(s,f,m)),a.queue(i),t.effects.unshift(a,b,p+1)}),t.effects.define("clip","hide",function(e,i){var s,n={},o=t(this),a=e.direction||"vertical",r="both"===a,l=r||"horizontal"===a,h=r||"vertical"===a;s=o.cssClip(),n.clip={top:h?(s.bottom-s.top)/2:s.top,right:l?(s.right-s.left)/2:s.right,bottom:h?(s.bottom-s.top)/2:s.bottom,left:l?(s.right-s.left)/2:s.left},t.effects.createPlaceholder(o),"show"===e.mode&&(o.cssClip(n.clip),n.clip=s),o.animate(n,{queue:!1,duration:e.duration,easing:e.easing,complete:i})}),t.effects.define("drop","hide",function(e,i){var s,n=t(this),o=e.mode,a="show"===o,r=e.direction||"left",l="up"===r||"down"===r?"top":"left",h="up"===r||"left"===r?"-=":"+=",c="+="===h?"-=":"+=",u={opacity:0};t.effects.createPlaceholder(n),s=e.distance||n["top"===l?"outerHeight":"outerWidth"](!0)/2,u[l]=h+s,a&&(n.css(u),u[l]=c+s,u.opacity=1),n.animate(u,{queue:!1,duration:e.duration,easing:e.easing,complete:i})}),t.effects.define("explode","hide",function(e,i){function s(){b.push(this),b.length===u*d&&n()}function n(){p.css({visibility:"visible"}),t(b).remove(),i()}var o,a,r,l,h,c,u=e.pieces?Math.round(Math.sqrt(e.pieces)):3,d=u,p=t(this),f=e.mode,m="show"===f,g=p.show().css("visibility","hidden").offset(),_=Math.ceil(p.outerWidth()/d),v=Math.ceil(p.outerHeight()/u),b=[];for(o=0;u>o;o++)for(l=g.top+o*v,c=o-(u-1)/2,a=0;d>a;a++)r=g.left+a*_,h=a-(d-1)/2,p.clone().appendTo("body").wrap("").css({position:"absolute",visibility:"visible",left:-a*_,top:-o*v}).parent().addClass("ui-effects-explode").css({position:"absolute",overflow:"hidden",width:_,height:v,left:r+(m?h*_:0),top:l+(m?c*v:0),opacity:m?0:1}).animate({left:r+(m?0:h*_),top:l+(m?0:c*v),opacity:m?1:0},e.duration||500,e.easing,s)}),t.effects.define("fade","toggle",function(e,i){var s="show"===e.mode;t(this).css("opacity",s?0:1).animate({opacity:s?1:0},{queue:!1,duration:e.duration,easing:e.easing,complete:i})}),t.effects.define("fold","hide",function(e,i){var s=t(this),n=e.mode,o="show"===n,a="hide"===n,r=e.size||15,l=/([0-9]+)%/.exec(r),h=!!e.horizFirst,c=h?["right","bottom"]:["bottom","right"],u=e.duration/2,d=t.effects.createPlaceholder(s),p=s.cssClip(),f={clip:t.extend({},p)},m={clip:t.extend({},p)},g=[p[c[0]],p[c[1]]],_=s.queue().length;l&&(r=parseInt(l[1],10)/100*g[a?0:1]),f.clip[c[0]]=r,m.clip[c[0]]=r,m.clip[c[1]]=0,o&&(s.cssClip(m.clip),d&&d.css(t.effects.clipToBox(m)),m.clip=p),s.queue(function(i){d&&d.animate(t.effects.clipToBox(f),u,e.easing).animate(t.effects.clipToBox(m),u,e.easing),i()}).animate(f,u,e.easing).animate(m,u,e.easing).queue(i),t.effects.unshift(s,_,4)}),t.effects.define("highlight","show",function(e,i){var s=t(this),n={backgroundColor:s.css("backgroundColor")};"hide"===e.mode&&(n.opacity=0),t.effects.saveStyle(s),s.css({backgroundImage:"none",backgroundColor:e.color||"#ffff99"}).animate(n,{queue:!1,duration:e.duration,easing:e.easing,complete:i})}),t.effects.define("size",function(e,i){var s,n,o,a=t(this),r=["fontSize"],l=["borderTopWidth","borderBottomWidth","paddingTop","paddingBottom"],h=["borderLeftWidth","borderRightWidth","paddingLeft","paddingRight"],c=e.mode,u="effect"!==c,d=e.scale||"both",p=e.origin||["middle","center"],f=a.css("position"),m=a.position(),g=t.effects.scaledDimensions(a),_=e.from||g,v=e.to||t.effects.scaledDimensions(a,0);t.effects.createPlaceholder(a),"show"===c&&(o=_,_=v,v=o),n={from:{y:_.height/g.height,x:_.width/g.width},to:{y:v.height/g.height,x:v.width/g.width}},("box"===d||"both"===d)&&(n.from.y!==n.to.y&&(_=t.effects.setTransition(a,l,n.from.y,_),v=t.effects.setTransition(a,l,n.to.y,v)),n.from.x!==n.to.x&&(_=t.effects.setTransition(a,h,n.from.x,_),v=t.effects.setTransition(a,h,n.to.x,v))),("content"===d||"both"===d)&&n.from.y!==n.to.y&&(_=t.effects.setTransition(a,r,n.from.y,_),v=t.effects.setTransition(a,r,n.to.y,v)),p&&(s=t.effects.getBaseline(p,g),_.top=(g.outerHeight-_.outerHeight)*s.y+m.top,_.left=(g.outerWidth-_.outerWidth)*s.x+m.left,v.top=(g.outerHeight-v.outerHeight)*s.y+m.top,v.left=(g.outerWidth-v.outerWidth)*s.x+m.left),a.css(_),("content"===d||"both"===d)&&(l=l.concat(["marginTop","marginBottom"]).concat(r),h=h.concat(["marginLeft","marginRight"]),a.find("*[width]").each(function(){var i=t(this),s=t.effects.scaledDimensions(i),o={height:s.height*n.from.y,width:s.width*n.from.x,outerHeight:s.outerHeight*n.from.y,outerWidth:s.outerWidth*n.from.x},a={height:s.height*n.to.y,width:s.width*n.to.x,outerHeight:s.height*n.to.y,outerWidth:s.width*n.to.x};n.from.y!==n.to.y&&(o=t.effects.setTransition(i,l,n.from.y,o),a=t.effects.setTransition(i,l,n.to.y,a)),n.from.x!==n.to.x&&(o=t.effects.setTransition(i,h,n.from.x,o),a=t.effects.setTransition(i,h,n.to.x,a)),u&&t.effects.saveStyle(i),i.css(o),i.animate(a,e.duration,e.easing,function(){u&&t.effects.restoreStyle(i)})})),a.animate(v,{queue:!1,duration:e.duration,easing:e.easing,complete:function(){var e=a.offset();0===v.opacity&&a.css("opacity",_.opacity),u||(a.css("position","static"===f?"relative":f).offset(e),t.effects.saveStyle(a)),i()}})}),t.effects.define("scale",function(e,i){var s=t(this),n=e.mode,o=parseInt(e.percent,10)||(0===parseInt(e.percent,10)?0:"effect"!==n?0:100),a=t.extend(!0,{from:t.effects.scaledDimensions(s),to:t.effects.scaledDimensions(s,o,e.direction||"both"),origin:e.origin||["middle","center"]},e);e.fade&&(a.from.opacity=1,a.to.opacity=0),t.effects.effect.size.call(this,a,i)}),t.effects.define("puff","hide",function(e,i){var s=t.extend(!0,{},e,{fade:!0,percent:parseInt(e.percent,10)||150});t.effects.effect.scale.call(this,s,i)}),t.effects.define("pulsate","show",function(e,i){var s=t(this),n=e.mode,o="show"===n,a="hide"===n,r=o||a,l=2*(e.times||5)+(r?1:0),h=e.duration/l,c=0,u=1,d=s.queue().length;for((o||!s.is(":visible"))&&(s.css("opacity",0).show(),c=1);l>u;u++)s.animate({opacity:c},h,e.easing),c=1-c;s.animate({opacity:c},h,e.easing),s.queue(i),t.effects.unshift(s,d,l+1)}),t.effects.define("shake",function(e,i){var s=1,n=t(this),o=e.direction||"left",a=e.distance||20,r=e.times||3,l=2*r+1,h=Math.round(e.duration/l),c="up"===o||"down"===o?"top":"left",u="up"===o||"left"===o,d={},p={},f={},m=n.queue().length;for(t.effects.createPlaceholder(n),d[c]=(u?"-=":"+=")+a,p[c]=(u?"+=":"-=")+2*a,f[c]=(u?"-=":"+=")+2*a,n.animate(d,h,e.easing);r>s;s++)n.animate(p,h,e.easing).animate(f,h,e.easing);n.animate(p,h,e.easing).animate(d,h/2,e.easing).queue(i),t.effects.unshift(n,m,l+1)}),t.effects.define("slide","show",function(e,i){var s,n,o=t(this),a={up:["bottom","top"],down:["top","bottom"],left:["right","left"],right:["left","right"]},r=e.mode,l=e.direction||"left",h="up"===l||"down"===l?"top":"left",c="up"===l||"left"===l,u=e.distance||o["top"===h?"outerHeight":"outerWidth"](!0),d={};t.effects.createPlaceholder(o),s=o.cssClip(),n=o.position()[h],d[h]=(c?-1:1)*u+n,d.clip=o.cssClip(),d.clip[a[l][1]]=d.clip[a[l][0]],"show"===r&&(o.cssClip(d.clip),o.css(h,d[h]),d.clip=s,d[h]=n),o.animate(d,{queue:!1,duration:e.duration,easing:e.easing,complete:i})});var o;t.uiBackCompat!==!1&&(o=t.effects.define("transfer",function(e,i){t(this).transfer(e,i)}))}); \ No newline at end of file diff --git a/docs/pages/next_major_development.md b/docs/pages/next_major_development.md new file mode 100644 index 00000000000..c7abcaa68c1 --- /dev/null +++ b/docs/pages/next_major_development.md @@ -0,0 +1,206 @@ +--- +title: PMD 7.0.0 development +permalink: pmd_next_major_development.html +keywords: changelog, release notes, deprecation, api changes +--- + +We're excited to bring you the next major version of PMD! Here are the major features and changes we're working on. +To give us feedback or to suggest a new feature, drop us a line on [Gitter](https://gitter.im/pmd/pmd)! + +## New Features + +TODO + +## Java grammar changes + +{% include note.html content="Current plans are listed [here](https://github.com/pmd/pmd/labels/in%3Aast) and in particular [here](https://github.com/pmd/pmd/issues/1019)" %} + + + +## New API support guidelines + +### What's new + +Until now, all released public members and types were implicitly considered part +of PMD's public API, including inheritance-specific members (protected members, abstract methods). +We have maintained those APIs with the goal to preserve full binary compatibility between minor releases, +only breaking those APIs infrequently, for major releases. + +In order to allow PMD to move forward at a faster pace, this implicit contract will +be invalidated with PMD 7.0.0. We now introduce more fine-grained distinctions between +the type of compatibility support we guarantee for our libraries, and ways to make +them explicit to clients of PMD. + +#### `.internal` packages and `@InternalApi` annotation + +*Internal API* is meant for use *only* by the main PMD codebase. Internal types and methods +may be modified in any way, or even removed, at any time. + +Any API in a package that contains an `.internal` segment is considered internal. +The `@InternalApi` annotation will be used for APIs that have to live outside of +these packages, e.g. methods of a public type that shouldn't be used outside of PMD (again, +these can be removed anytime). + +#### `@ReservedSubclassing` + +Types marked with the `@ReservedSubclassing` annotation are only meant to be subclassed +by classes within PMD. As such, we may add new abstract methods, or remove protected methods, +at any time. All published public members remain supported. The annotation is *not* inherited, which +means a reserved interface doesn't prevent its implementors to be subclassed. + +#### `@Experimental` + +APIs marked with the `@Experimental` annotation at the class or method level are subject to change. +They can be modified in any way, or even removed, at any time. You should not use or rely + on them in any production code. They are purely to allow broad testing and feedback. + +#### `@Deprecated` + +APIs marked with the `@Deprecated` annotation at the class or method level will remain supported +until the next major release but it is recommended to stop using them. + +### The transition + +*All currently supported APIs will remain so until 7.0.0*. All APIs that are to be moved to +`.internal` packages or hidden will be tagged `@InternalApi` before that major release, and +the breaking API changes will be performed in 7.0.0. + +## Planned API removals + +### List of currently deprecated APIs + +{% include warning.html content="This list is not exhaustive. The ultimate reference is whether +an API is tagged as `@Deprecated` or not in the latest minor release. During the development of 7.0.0, +we may decide to remove some APIs that were not tagged as deprecated, though we'll try to avoid it." %} + +#### 6.8.0 + +* A couple of methods and fields in `net.sourceforge.pmd.properties.AbstractPropertySource` have been + deprecated, as they are replaced by already existing functionality or expose internal implementation + details: `propertyDescriptors`, `propertyValuesByDescriptor`, + `copyPropertyDescriptors()`, `copyPropertyValues()`, `ignoredProperties()`, `usesDefaultValues()`, + `useDefaultValueFor()`. + +* Some methods in `net.sourceforge.pmd.properties.PropertySource` have been deprecated as well: + `usesDefaultValues()`, `useDefaultValueFor()`, `ignoredProperties()`. + +* The class `net.sourceforge.pmd.lang.rule.AbstractDelegateRule` has been deprecated and will + be removed with PMD 7.0.0. It is internally only in use by RuleReference. + +* The default constructor of `net.sourceforge.pmd.lang.rule.RuleReference` has been deprecated + and will be removed with PMD 7.0.0. RuleReferences should only be created by providing a Rule and + a RuleSetReference. Furthermore the following methods are deprecated: `setRuleReference()`, + `hasOverriddenProperty()`, `usesDefaultValues()`, `useDefaultValueFor()`. + +#### 6.7.0 + +* All classes in the package `net.sourceforge.pmd.lang.dfa.report` have been deprecated and will be removed + with PMD 7.0.0. This includes the class `net.sourceforge.pmd.lang.dfa.report.ReportTree`. The reason is, + that this class is very specific to Java and not suitable for other languages. It has only been used for + `YAHTMLRenderer`, which has been rewritten to work without these classes. + +* The nodes RUNSIGNEDSHIFT and RSIGNEDSHIFT are deprecated and will be removed from the AST with PMD 7.0.0. + These represented the operator of ShiftExpression in two cases out of three, but they're not needed and + make ShiftExpression inconsistent. The operator of a ShiftExpression is now accessible through + ShiftExpression#getOperator. + +#### 6.5.0 + +* The utility class `net.sourceforge.pmd.lang.java.ast.CommentUtil` has been deprecated and will be removed + with PMD 7.0.0. Its methods have been intended to parse javadoc tags. A more useful solution will be added + around the AST node `FormalComment`, which contains as children `JavadocElement` nodes, which in + turn provide access to the `JavadocTag`. + + All comment AST nodes (`FormalComment`, `MultiLineComment`, `SingleLineComment`) have a new method + `getFilteredComment()` which provide access to the comment text without the leading `/*` markers. + +* The method `AbstractCommentRule.tagsIndicesIn()` has been deprecated and will be removed with + PMD 7.0.0. It is not very useful, since it doesn't extract the information + in a useful way. You would still need check, which tags have been found, and with which + data they might be accompanied. + +#### 6.4.0 + +* The following classes in package `net.sourceforge.pmd.benchmark` have been deprecated: `Benchmark`, `Benchmarker`, + `BenchmarkReport`, `BenchmarkResult`, `RuleDuration`, `StringBuilderCR` and `TextReport`. Their API is not supported anymore + and is disconnected from the internals of PMD. Use the newer API based around `TimeTracker` instead, which can be found + in the same package. +* The class `net.sourceforge.pmd.lang.java.xpath.TypeOfFunction` has been deprecated. Use the newer `TypeIsFunction` in the same package. +* The `typeof` methods in `net.sourceforge.pmd.lang.java.xpath.JavaFunctions` have been deprecated. + Use the newer `typeIs` method in the same class instead.. +* The methods `isA`, `isEither` and `isNeither` of `net.sourceforge.pmd.lang.java.typeresolution.TypeHelper`. + Use the new `isExactlyAny` and `isExactlyNone` methods in the same class instead. + +#### 6.2.0 + +* The static method `PMDParameters.transformParametersIntoConfiguration(PMDParameters)` is now deprecated, + for removal in 7.0.0. The new instance method `PMDParameters.toConfiguration()` replaces it. + +* The method `ASTConstructorDeclaration.getParameters()` has been deprecated in favor of the new method + `getFormalParameters()`. This method is available for both `ASTConstructorDeclaration` and + `ASTMethodDeclaration`. + +#### 6.1.0 + +* The method `getXPathNodeName` is added to the `Node` interface, which removes the +use of the `toString` of a node to get its XPath element name (see [#569](https://github.com/pmd/pmd/issues/569)). + * The default implementation provided in `AbstractNode`, will + be removed with 7.0.0 + * With 7.0.0, the `Node.toString` method will not necessarily provide its XPath node + name anymore. + +* The interface `net.sourceforge.pmd.cpd.Renderer` has been deprecated. A new interface +`net.sourceforge.pmd.cpd.renderer.CPDRenderer` has been introduced to replace it. The main +difference is that the new interface is meant to render directly to a `java.io.Writer` +rather than to a String. This allows to greatly reduce the memory footprint of CPD, as on +large projects, with many duplications, it was causing `OutOfMemoryError`s (see [#795](https://github.com/pmd/pmd/issues/795)). + + `net.sourceforge.pmd.cpd.FileReporter` has also been deprecated as part of this change, as it's no longer needed. + +#### 6.0.1 + +* The constant `net.sourceforge.pmd.PMD.VERSION` has been deprecated and will be removed with PMD 7.0.0. + Please use `net.sourceforge.pmd.PMDVersion.VERSION` instead. + +### List of currently deprecated rules + +* The Java rules {% rule java/codestyle/VariableNamingConventions %}, {% rule java/codestyle/MIsLeadingVariableName %}, + {% rule java/codestyle/SuspiciousConstantFieldName %}, and {% rule java/codestyle/AvoidPrefixingMethodParameters %} are + now deprecated, and will be removed with version 7.0.0. They are replaced by the more general + {% rule java/codestyle/FieldNamingConventions %}, {% rule java/codestyle/FormalParameterNamingConventions %}, and + {% rule java/codestyle/LocalVariableNamingConventions %}. + +* The Java rule {% rule java/codestyle/AbstractNaming %} is deprecated + in favour of {% rule java/codestyle/ClassNamingConventions %}. + +* The Java rules {% rule java/codestyle/WhileLoopsMustUseBraces %}, {% rule java/codestyle/ForLoopMustUseBraces %}, {% rule java/codestyle/IfStmtMustUseBraces %}, and {% rule java/codestyle/IfElseStmtMustUseBraces %} + are deprecated. They will be replaced by the new rule {% rule java/codestyle/ControlStatementBraces %} + +* The Java rules {% rule java/codestyle/NcssConstructorCount %}, {% rule java/codestyle/NcssMethodCount %}, and {% rule java/codestyle/NcssTypeCount %} have been + deprecated. They will be replaced by the new rule {% rule java/design/NcssCount %} in the category `design`. + +* The Java rule `LooseCoupling` in ruleset `java-typeresolution` is deprecated. Use the rule with the same name from category `bestpractices` instead. + +* The Java rule `CloneMethodMustImplementCloneable` in ruleset `java-typeresolution` is deprecated. Use the rule with the same name from category `errorprone` instead. + +* The Java rule `UnusedImports` in ruleset `java-typeresolution` is deprecated. Use the rule with + the same name from category `bestpractices` instead. + +* The Java rule `SignatureDeclareThrowsException` in ruleset `java-typeresolution` is deprecated. Use the rule with the same name from category `design` instead. + +* The Java rule `EmptyStaticInitializer` in ruleset `java-empty` is deprecated. Use the rule {% rule java/errorprone/EmptyInitializer %}, which covers both static and non-static empty initializers.` + +* The Java rules `GuardDebugLogging` (ruleset `java-logging-jakarta-commons`) and `GuardLogStatementJavaUtil` + (ruleset `java-logging-java`) have been deprecated. Use the rule {% rule java/bestpractices/GuardLogStatement %}, which covers all cases regardless of the logging framework. + + + + + + + + + + + + diff --git a/docs/pages/pmd/about/help.md b/docs/pages/pmd/about/help.md new file mode 100644 index 00000000000..9460394cdb5 --- /dev/null +++ b/docs/pages/pmd/about/help.md @@ -0,0 +1,21 @@ +--- +title: Getting Help +permalink: pmd_about_help.html +author: Andreas Dangel-The downside is however, that there are inevitable merge conflicts for the maven `pom.xml` files, since -every branch changed the version number differently.
-We could avoid this by merging only the temporary branch \"pr-124\" into each maintenance branch and -eventually into master, with the risk of missing single commits in a maintenance branch, that have been -done outside the temporary branch." %} - -#### Merging vs. Cherry-Picking - -We are not using cherry-picking, so that each fix is represented by a single commit. -Cherry-picking would duplicate the commit and you can't see in the log, on which branches the fix has been -integrated (e.g. gitk and github show the branches, from which the specific commit is reachable). - -The downside is a more complex history - the maintenance branches and master branch are "connected" and not separate. diff --git a/docs/pages/pmd/devdocs/roadmap.md b/docs/pages/pmd/devdocs/roadmap.md index ee08fcc41a2..362dffddf96 100644 --- a/docs/pages/pmd/devdocs/roadmap.md +++ b/docs/pages/pmd/devdocs/roadmap.md @@ -1,12 +1,15 @@ --- title: Roadmap +tags: [devdocs] permalink: pmd_devdocs_roadmap.html author: > Tom Copeland
`**: Either the `` element or the `` element is required. It provides the actual code
- snippet on which the rule is executed. The code itself is usually wrapped in a "CDATA" section, so that no
- further XML escapes (entity references such as <) are necessary.
-
-* **``**: Alternative to ``. References a `` defined earlier in the file.
- This allows you to share the same code snippet with several test cases. The attribute `id` must match the
- id of the references code fragment.
-
-* **``**: Optional element that specifies the source code language. This defines the parser that
- is used for parsing the code snippet. If not given, **java** is used as default.
-
-### ``
-
-The code fragment has just one required attribute: **id**. This is used to reference it via a `` element
-inside a ``. Similar like the `` element, the content of `` is usually wrapped
-in a "CDATA" section, so that no further XML escapes (entity references such as <) are necessary.
-
-### Complete XML example
-
-``` xml
-
-
-
- Just a description, will be used as the test name for JUnit in the reports
- propValue
- 2
- 5,14
-
- Violation message 1
- Violation message 2
-
- apex
-
-
-
- test case using a code fragment
- 0
-
-
-```
-
-## Using the test framework externally
-
-It is also possible to use the test framework for custom rules developed outside the PMD source base.
-Therefore you just need to reference the dependency `net.sourceforge.pmd:pmd-test`.
-
-For maven, you can use this snippet:
-
-
- net.sourceforge.pmd
- pmd-test
- {{site.pmd.version}}
- test
-
-
-Then proceed as described earlier: create your test class, create your test cases and run the unit test.
-
-## How the test framework is implemented
-
-The framework uses a custom JUnit test runner under the hood, among a couple of utility classes:
-
-* `SimpleAggregatorTst`: This is the base class for the test classes and defines the custom JUnit test runner.
- It itself is a subclass of `RuleTst`.
-
-* `RuleTst`: contains the logic to parse the XML files and provide a list of `TestDescriptor`s. Each test descriptor
- describes a single test case. It also contains the logic to execute such a test descriptor and assert the results.
-
-* `PMDTestRunner`: A custom JUnit test runner, that combines two separate test runners: The custom `RuleTestRunner`
- and the standard `JUnit4` test runner. This combination allows you to add additional standard unit test methods
- annotated with `@Test` to your test class.
-
- *Note:* Since the test class is executed through two test runners, it is actually instantiated twice. Be aware
- of this, if you do any initialization in the constructor. Also, the static hooks `@BeforeClass` and `@AfterClass`
- will be executed twice.
-
-* `RuleTestRunner`: This test runner executes the test descriptors with the help of `RuleTst`.
diff --git a/docs/pages/pmd/devdocs/writing_documentation.md b/docs/pages/pmd/devdocs/writing_documentation.md
index 078477f2789..1a02a2a8a32 100644
--- a/docs/pages/pmd/devdocs/writing_documentation.md
+++ b/docs/pages/pmd/devdocs/writing_documentation.md
@@ -1,5 +1,6 @@
---
-title: Writing Documentation
+title: Writing documentation
+tags: [devdocs]
last_update: August 2017
permalink: pmd_devdocs_writing_documentation.html
keywords: documentation, jekyll, markdown
@@ -17,13 +18,48 @@ The pages are in general in [Github Flavored Markdown](https://kramdown.gettalon
## Structure
-All documentation is stored in the folder `docs/`. This is the folder, that github and the travis-ci scripts
-use to render the site.
+The documentation sources can be found in two places based on how they are generated:
+- the ones that are manually written (like the one you are reading);
+- and the ones that are generated automatically from the category files. All the rule documentation
+pages are generated that way.
-New pages are stored in the different subfolders under `pages`. The folder structure resembles the sidebar structure.
+### Handwritten documentation
+
+All handwritten documentation is stored in the subfolders under `docs/pages`. The folder structure resembles the sidebar structure.
Since all pages use a simple *permalink*, in the rendered html pages, all pages are flattened in one directory.
This makes it easy to view the documentation also offline.
+### Rule documentation
+
+The categories for a language `%lang%` are located in
+`pmd-%lang%/src/main/resources/category/%lang% `. So for Java the categories
+can be found under [pmd-java/src/main/resources/category/java](https://github.com/pmd/pmd/tree/master/pmd-java/src/main/resources/category/java).
+The XML category files in this directory are transformed during build into markdown pages
+describing the rules they contain. These pages are placed under `docs/` like the handwritten
+documentation, and are then rendered with Jekyll like the rest of them. The rule documentation
+generator is the separate submodule `pmd-doc`.
+
+Modifying the documentation of a rule should thus not be done on the markdown page,
+but directly on the XML `rule` tag corresponding to the rule, in the relevant
+category file.
+
+The XML documentation of rules can contain GitHub flavoured markdown.
+Just wrap the markdown inside CDATA section in the xml. CDATA sections preserve
+all formatting inside the delimiters, and allow to write code samples without
+ escaping special xml characters. For example:
+```
+
+
+
+
+ ...
+
+```
+
## Building
There are two ways, to execute jekyll:
diff --git a/docs/pages/pmd/languages/apex_metrics_index.md b/docs/pages/pmd/languages/apex_metrics_index.md
index 7c909b27baa..6b0b62bf7b4 100644
--- a/docs/pages/pmd/languages/apex_metrics_index.md
+++ b/docs/pages/pmd/languages/apex_metrics_index.md
@@ -1,6 +1,6 @@
---
title: Index of Apex code metrics
-tags: [customizing]
+tags: [extending, metrics]
summary: "Index of the code metrics available out of the box to Apex rule developers."
last_updated: July 20, 2017
permalink: pmd_apex_metrics_index.html
diff --git a/docs/pages/pmd/languages/java_metrics_index.md b/docs/pages/pmd/languages/java_metrics_index.md
index 6a18564e367..cc5d28e5d06 100644
--- a/docs/pages/pmd/languages/java_metrics_index.md
+++ b/docs/pages/pmd/languages/java_metrics_index.md
@@ -1,6 +1,6 @@
---
title: Index of Java code metrics
-tags: [customizing]
+tags: [extending, metrics]
summary: "Index of the code metrics available out of the box to Java rule developers."
last_updated: July 20, 2017
permalink: pmd_java_metrics_index.html
diff --git a/docs/pages/pmd/projectdocs/committers/merging_pull_requests.md b/docs/pages/pmd/projectdocs/committers/merging_pull_requests.md
new file mode 100644
index 00000000000..73df32671e4
--- /dev/null
+++ b/docs/pages/pmd/projectdocs/committers/merging_pull_requests.md
@@ -0,0 +1,157 @@
+---
+title: Merging pull requests
+permalink: pmd_projectdocs_committers_merging_pull_requests.html
+last_updated: August 2017
+author: Andreas Dangel
+---
+
+## Example 1: Merging PR #123 into master
+
+1. Review the pull request
+
+ * Compilation and checkstyle is verified already by travis build: PRs are automatically checked.
+ * If it is a bug fix, a new unit test, that reproduces the bug, is mandatory. Without such a test, we might accidentally reintroduce the bug again.
+ * Add the appropriate labels on the github issue: If the PR fixes a bug, the label "a:bug" should be used.
+ * Make sure, the PR is added to the appropriate milestone. If the PR fixes a bug, make sure, that the bug issue is added to the same milestone.
+
+2. The actual merge commands:
+
+ We assume, that the PR has been created from the master branch. If this is not the case,
+ then we'll either need to rebase or ask for rebasing before merging.
+
+ ```
+ git checkout master && git pull origin master # make sure, you have the latest code
+ git fetch origin pull/123/head:pr-123 && git checkout pr-123 # creates a new temporary branch
+ ```
+
+3. Update the [release notes](https://github.com/pmd/pmd/blob/master/docs/pages/release_notes.md):
+
+ * Are there any API changes, that need to be documented? (Section "API Changes")
+ * Are there any significant changes to existing rules, that should be mentioned?
+ (Section "Modified Rules" / "New Rules" / "Removed Rules")
+ * If the PR fixes a bug, make sure, it is listed under the section "Fixed Issues".
+ * In any case, add the PR to the section "External Contributions"
+ * Commit these changes with the message:
+
+ git add docs/pages/release_notes.md
+ git commit -m "Update release notes, refs #123"
+
+ {% include note.html content="If the PR fixes a bug, verify, that we have a commit with the message
+ \"Fixes #issue-number\". If this doesn't exist, you can add it to the commit message when
+ updating the release notes: `Update release notes, refs #123, fixes #issue-number`.
+ This will automatically close the github issue." %}
+
+4. Now merge the pull request into the master branch:
+
+ ```
+ git checkout master
+ git merge --no-ff pr-123
+ ```
+
+ {%include note.html content="If there are merge conflicts, you'll need to deal with them here." %}
+
+5. Run the complete build: `./mvnw clean verify`
+
+ {% include note.html content="This will execute all the unit tests and the checkstyle tests. It ensures,
+ that the complete project can be build and is functioning on top of the current master." %}
+
+6. If the build was successful, you are ready to push:
+
+ ```
+ git push origin master
+ ```
+
+ Since the temporary branch is now not needed anymore, you can delete it:
+ `git branch -d pr-123`.
+
+
+## Example 2: Merging PR #124 into a maintenance branch
+
+We ask, to create every pull request against master, to make it easier to contribute.
+But if a pull request is intended to fix a bug in an older version of PMD, then we need to backport this pull request.
+
+### Creating a maintenance branch
+
+For older versions, we use maintenance branches, like `pmd/5.8.x`. If there is no maintenance branch for
+the specific version, then we'll have to create it first. Let's say, we want a maintenance branch for
+PMD version 5.8.0, so that we can create a bugfix release 5.8.1.
+
+1. We'll simply create a new branch off of the release tag:
+
+ ```
+ git branch pmd/5.8.x pmd_releases/5.8.0 && git checkout pmd/5.8.x
+ ```
+
+2. Now we'll need to adjust the version, since it's currently the same as the release version.
+ We'll change the version to the next patch version: "5.8.1-SNAPSHOT".
+
+ ```
+ ./mvnw versions:set -DnewVersion=5.8.1-SNAPSHOT
+ git add pom.xml \*/pom.xml
+ git commit -m "prepare next version 5.8.1-SNAPSHOT"
+ ```
+
+### Merging the PR
+
+1. As above: Review the PR
+
+2. Fetch the PR and rebase it onto the maintenance branch:
+
+ ```
+ git fetch origin pull/124/head:pr-124 && git checkout pr-124 # creates a new temporary branch
+ git rebase master --onto pmd/5.8.x
+ ./mvnw clean verify # make sure, everything works after the rebase
+ ```
+
+ {%include note.html content="You might need to fix conflicts / backport the commits for the older
+ PMD version." %}
+
+3. Update the release notes. See above for details.
+
+4. Now merge the pull request into the maintenance branch:
+
+ ```
+ git checkout pmd/5.8.x
+ git merge --no-ff pr-124
+ ```
+
+5. Just to be sure, run the complete build again: `./mvnw clean verify`.
+
+6. If the build was successful, you are ready to push:
+
+ ```
+ git push origin pmd/5.8.x
+ ```
+
+7. Since we have rebased the pull request, it won't appear as merged on github.
+ You need to manually close the pull request. Leave a comment, that it has been
+ rebased onto the maintenance branch.
+
+### Merging into master
+
+Now the PR has been merged into the maintenance branch, but it is missing in any later version of PMD.
+Therefore, we merge first into the next minor version maintenance branch (if existing):
+
+ git checkout pmd/5.9.x
+ git merge pmd/5.8.x
+
+After that, we merge the changes into the master branch:
+
+ git checkout master
+ git merge pmd/5.9.x
+
+{%include note.html content="This ensures, that every change on the maintenance branch eventually ends
+up in the master branch and therefore in any future version of PMD.
+The downside is however, that there are inevitable merge conflicts for the maven `pom.xml` files, since
+every branch changed the version number differently.
+We could avoid this by merging only the temporary branch \"pr-124\" into each maintenance branch and
+eventually into master, with the risk of missing single commits in a maintenance branch, that have been
+done outside the temporary branch." %}
+
+### Merging vs. Cherry-Picking
+
+We are not using cherry-picking, so that each fix is represented by a single commit.
+Cherry-picking would duplicate the commit and you can't see in the log, on which branches the fix has been
+integrated (e.g. gitk and github show the branches, from which the specific commit is reachable).
+
+The downside is a more complex history - the maintenance branches and master branch are "connected" and not separate.
diff --git a/docs/pages/pmd/devdocs/releasing.md b/docs/pages/pmd/projectdocs/committers/releasing.md
similarity index 83%
rename from docs/pages/pmd/devdocs/releasing.md
rename to docs/pages/pmd/projectdocs/committers/releasing.md
index cf911cc79da..4aeeb7e1a2c 100644
--- a/docs/pages/pmd/devdocs/releasing.md
+++ b/docs/pages/pmd/projectdocs/committers/releasing.md
@@ -1,6 +1,6 @@
---
title: Releasing
-permalink: pmd_devdocs_releasing.html
+permalink: pmd_projectdocs_committers_releasing.html
author: Romain Pelisse , Andreas Dangel
---
@@ -17,23 +17,32 @@ through the release process.
Make sure code is up to date and everything is committed and pushed with git:
- $ mvn clean
+ $ ./mvnw clean
$ git pull
$ git status
-### The Release Notes
-
-At a very minimum, the current date must be noted in the release notes. Also, the version
-must be adjusted. E.g. by removing "-SNAPSHOT".
+### The Release Notes and docs
You can find the release notes here: `docs/pages/release_notes.md`.
+The date and the version must be updated in `docs/_config.yml`, e.g.
+
+```
+pmd:
+ version: 6.0.0
+ date: 2017-12-15
+```
+
+
The release notes usual mention any new rules that have been added since the last release.
Please double check the file `pmd-core/src/main/resources/rulesets/releases/.xml`, so
that all new rules are listed.
+We maintain a documentation for the [next major release](pmd_next_major_development.html). Copy the API
+changes from the current release notes to this document: `docs/pages/next_major_development.md`.
+
Check in all (version) changes to branch master or any other branch, from which the release takes place:
$ git commit -a -m "Prepare pmd release "
@@ -43,12 +52,19 @@ Check in all (version) changes to branch master or any other branch, from which
### The Homepage
The github repo `pmd.github.io` hosts the homepage for [https://pmd.github.io](https://pmd.github.io).
-The `index.html` page needes to be updated to display the new release. The new release is mentioned
-* on the start page
-* in the announcements
-* and in the previous releases section
+The new version needs to be entered into `_config.yml`, e.g.:
+```
+pmd:
+ latestVersion: 6.0.0
+ latestVersionDate: 15th December 2017
+```
+
+Also move the previous version down into the "downloads" section.
+
+Then create a new page for the new release, e.g. `_posts/2017-12-15-PMD-6.0.0.md` and copy
+the release notes into this page. This will appear under the news section.
Check in all (version) changes to branch master:
@@ -120,9 +136,11 @@ the following template:
### Prepare the new release notes
+* Update version in **docs/_config.yml**
* Move version/release info from **docs/pages/release_notes.md** to **docs/pages/release_notes_old.md**.
* Update version/release info in **docs/pages/release_notes.md**. Use the following template:
+{%raw%}
```
---
title: PMD Release Notes
@@ -130,18 +148,13 @@ permalink: pmd_release_notes.html
keywords: changelog, release notes
---
-## ????? - ${DEVELOPMENT_VERSION}
+## {{ site.pmd.date }} - {{ site.pmd.version }}
-The PMD team is pleased to announce PMD ${DEVELOPMENT_VERSION%-SNAPSHOT}.
+The PMD team is pleased to announce PMD {{ site.pmd.version }}.
-This is a bug fixing release.
+This is a {{ site.pmd.release_type }} release.
-### Table Of Contents
-
-* [New and noteworthy](#new-and-noteworthy)
-* [Fixed Issues](#fixed-issues)
-* [API Changes](#api-changes)
-* [External Contributions](#external-contributions)
+{% tocmaker %}
### New and noteworthy
@@ -151,7 +164,11 @@ This is a bug fixing release.
### External Contributions
+{% endtocmaker %}
+
```
+{%endraw%}
+
Commit and push
@@ -191,6 +208,6 @@ At some point, it might be time for a new maintenance branch. Such a branch is u
the `master` branch. Here are the steps:
* Create a new branch: `git branch pmd/5.6.x master`
-* Update the version in both the new branch and master, e.g. `mvn versions:set -Dversion=5.6.0-SNAPSHOT`
- and `mvn versions:set -Dversion=5.7.0-SNAPSHOT`.
+* Update the version in both the new branch and master, e.g. `mvn versions:set -DnewVersion=5.6.1-SNAPSHOT`
+ and `mvn versions:set -DnewVersion=5.7.0-SNAPSHOT`.
* Update the release notes on both the new branch and master
diff --git a/docs/pages/pmd/userdocs/credits.md b/docs/pages/pmd/projectdocs/credits.md
similarity index 98%
rename from docs/pages/pmd/userdocs/credits.md
rename to docs/pages/pmd/projectdocs/credits.md
index d53b833e7e0..25002640654 100644
--- a/docs/pages/pmd/userdocs/credits.md
+++ b/docs/pages/pmd/projectdocs/credits.md
@@ -1,6 +1,6 @@
---
title: Credits
-permalink: pmd_userdocs_credits.html
+permalink: pmd_projectdocs_credits.html
author: Tom Copeland
---
@@ -436,6 +436,16 @@ author: Tom Copeland
## Organizations
+
+ 
+ MicroDoc for sponsoring PMD development.
+ MicroDoc is a software business serving an international customer base. Since 1991 MicroDoc
+ has grown into a technology oriented software engineering and professional services company.
+ Our focus on complex software technology and software infrastructure made us a well
+ respected partner for large corporations and even for other software businesses.
+
+
diff --git a/docs/pages/pmd/userdocs/faq.md b/docs/pages/pmd/projectdocs/faq.md
similarity index 97%
rename from docs/pages/pmd/userdocs/faq.md
rename to docs/pages/pmd/projectdocs/faq.md
index 3290de321d9..030e0b92f22 100644
--- a/docs/pages/pmd/userdocs/faq.md
+++ b/docs/pages/pmd/projectdocs/faq.md
@@ -1,7 +1,7 @@
---
title: FAQ
sidebar: pmd_sidebar
-permalink: pmd_userdocs_faq.html
+permalink: pmd_projectdocs_faq.html
folder: pmd/userdocs
---
diff --git a/docs/pages/pmd/userdocs/meaning.md b/docs/pages/pmd/projectdocs/trivia/meaning.md
similarity index 93%
rename from docs/pages/pmd/userdocs/meaning.md
rename to docs/pages/pmd/projectdocs/trivia/meaning.md
index b2bd1bc71f3..1c033dab4f1 100644
--- a/docs/pages/pmd/userdocs/meaning.md
+++ b/docs/pages/pmd/projectdocs/trivia/meaning.md
@@ -1,6 +1,6 @@
---
title: What does 'PMD' mean?
-permalink: pmd_userdocs_meaning.html
+permalink: pmd_projectdocs_trivia_meaning.html
author: David Dixon-Peugh
---
diff --git a/docs/pages/pmd/userdocs/news.md b/docs/pages/pmd/projectdocs/trivia/news.md
similarity index 99%
rename from docs/pages/pmd/userdocs/news.md
rename to docs/pages/pmd/projectdocs/trivia/news.md
index 937c1bbcf4b..42eab2a3461 100644
--- a/docs/pages/pmd/userdocs/news.md
+++ b/docs/pages/pmd/projectdocs/trivia/news.md
@@ -1,6 +1,6 @@
---
title: PMD in the press
-permalink: pmd_userdocs_news.html
+permalink: pmd_projectdocs_trivia_news.html
author: Tom Copeland
---
diff --git a/docs/pages/pmd/userdocs/products.md b/docs/pages/pmd/projectdocs/trivia/products.md
similarity index 98%
rename from docs/pages/pmd/userdocs/products.md
rename to docs/pages/pmd/projectdocs/trivia/products.md
index ffba09cb9f6..54175793a47 100644
--- a/docs/pages/pmd/userdocs/products.md
+++ b/docs/pages/pmd/projectdocs/trivia/products.md
@@ -1,6 +1,6 @@
---
title: Products/books related to PMD
-permalink: pmd_userdocs_products.html
+permalink: pmd_projectdocs_trivia_products.html
author: Tom Copeland
---
diff --git a/docs/pages/pmd/userdocs/similarprojects.md b/docs/pages/pmd/projectdocs/trivia/similarprojects.md
similarity index 95%
rename from docs/pages/pmd/userdocs/similarprojects.md
rename to docs/pages/pmd/projectdocs/trivia/similarprojects.md
index 60f574aaf35..e076052416f 100644
--- a/docs/pages/pmd/userdocs/similarprojects.md
+++ b/docs/pages/pmd/projectdocs/trivia/similarprojects.md
@@ -1,6 +1,6 @@
---
title: Similar projects
-permalink: pmd_userdocs_similarprojects.html
+permalink: pmd_projectdocs_trivia_similarprojects.html
author: Tom Copeland , David Dixon-Peugh
---
@@ -16,6 +16,7 @@ author: Tom Copeland , David Dixon-Peugh
Uses Java Modeling Language annotations.
* FindBugs - works on bytecode, uses BCEL. Source code uses
templates, nifty stuff!
+* SpotBugs - SpotBugs is the spiritual successor of FindBugs, carrying on from the point where it left off with support of its community.
* Hammurapi -
Uses ANTLR, excellent documentation, lots of rules
* Jamit - bytecode analyzer, nice graphs
diff --git a/docs/pages/pmd/rules/apex.md b/docs/pages/pmd/rules/apex.md
index 6c4a2ae36e1..682964277be 100644
--- a/docs/pages/pmd/rules/apex.md
+++ b/docs/pages/pmd/rules/apex.md
@@ -1,43 +1,74 @@
---
title: Apex Rules
+tags: [rule_references, apex]
+summary: Index of all built-in rules available for Apex
+language_name: Apex
permalink: pmd_rules_apex.html
folder: pmd/rules
---
-List of rulesets and rules contained in each ruleset.
-
-* [ApexUnit](pmd_rules_apex_apexunit.html): These rules deal with different problems that can occur with Apex unit tests.
-* [Braces](pmd_rules_apex_braces.html): The Braces ruleset contains rules regarding the use and placement of braces.
-* [Complexity](pmd_rules_apex_complexity.html): The Complexity ruleset contains rules that find problems related to code size or complexity.
-* [Performance](pmd_rules_apex_performance.html): The Performance ruleset contains a collection of good practices which should be followed.
-* [Security](pmd_rules_apex_security.html): These rules deal with different security problems that can occur within Apex.
-* [Style](pmd_rules_apex_style.html): The Style Ruleset contains rules regarding preferred usage of names and identifiers.
-
-## ApexUnit
-* [ApexUnitTestClassShouldHaveAsserts](pmd_rules_apex_apexunit.html#apexunittestclassshouldhaveasserts): Apex unit tests should include at least one assertion. This makes the tests more robust, and usi...
-* [ApexUnitTestShouldNotUseSeeAllDataTrue](pmd_rules_apex_apexunit.html#apexunittestshouldnotuseseealldatatrue): Apex unit tests should not use @isTest(seeAllData=true) because it opens up the existing database...
-
-## Braces
-* [ForLoopsMustUseBraces](pmd_rules_apex_braces.html#forloopsmustusebraces): Avoid using 'for' statements without using surrounding braces. If the code formatting orindentati...
-* [IfElseStmtsMustUseBraces](pmd_rules_apex_braces.html#ifelsestmtsmustusebraces): Avoid using if..else statements without using surrounding braces. If the code formattingor indent...
-* [IfStmtsMustUseBraces](pmd_rules_apex_braces.html#ifstmtsmustusebraces): Avoid using if statements without using braces to surround the code block. If the codeformatting ...
-* [WhileLoopsMustUseBraces](pmd_rules_apex_braces.html#whileloopsmustusebraces): Avoid using 'while' statements without using braces to surround the code block. If the codeformat...
-
-## Complexity
-* [AvoidDeeplyNestedIfStmts](pmd_rules_apex_complexity.html#avoiddeeplynestedifstmts): Avoid creating deeply nested if-then statements since they are harder to read and error-prone to ...
-* [ExcessiveClassLength](pmd_rules_apex_complexity.html#excessiveclasslength): Excessive class file lengths are usually indications that the class may be burdened with excessiv...
-* [ExcessiveParameterList](pmd_rules_apex_complexity.html#excessiveparameterlist): Methods with numerous parameters are a challenge to maintain, especially if most of them share th...
-* [ExcessivePublicCount](pmd_rules_apex_complexity.html#excessivepubliccount): Classes with large numbers of public methods and attributes require disproportionate testing effo...
-* [NcssConstructorCount](pmd_rules_apex_complexity.html#ncssconstructorcount): This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of l...
-* [NcssMethodCount](pmd_rules_apex_complexity.html#ncssmethodcount): This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of l...
-* [NcssTypeCount](pmd_rules_apex_complexity.html#ncsstypecount): This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of l...
-* [StdCyclomaticComplexity](pmd_rules_apex_complexity.html#stdcyclomaticcomplexity): Complexity directly affects maintenance costs is determined by the number of decision points in a...
-* [TooManyFields](pmd_rules_apex_complexity.html#toomanyfields): Classes that have too many fields can become unwieldy and could be redesigned to have fewer field...
+## Best Practices
+
+{% include callout.html content="Rules which enforce generally accepted best practices." %}
+
+* [ApexUnitTestClassShouldHaveAsserts](pmd_rules_apex_bestpractices.html#apexunittestclassshouldhaveasserts): Apex unit tests should include at least one assertion. This makes the tests more robust, and usi...
+* [ApexUnitTestShouldNotUseSeeAllDataTrue](pmd_rules_apex_bestpractices.html#apexunittestshouldnotuseseealldatatrue): Apex unit tests should not use @isTest(seeAllData=true) because it opens up the existing database...
+* [AvoidGlobalModifier](pmd_rules_apex_bestpractices.html#avoidglobalmodifier): Global classes should be avoided (especially in managed packages) as they can never be deleted or...
+* [AvoidLogicInTrigger](pmd_rules_apex_bestpractices.html#avoidlogicintrigger): As triggers do not allow methods like regular classes they are less flexible and suited to apply ...
+
+## Code Style
+
+{% include callout.html content="Rules which enforce a specific coding style." %}
+
+* [ClassNamingConventions](pmd_rules_apex_codestyle.html#classnamingconventions): Class names should always begin with an upper case character.
+* [ForLoopsMustUseBraces](pmd_rules_apex_codestyle.html#forloopsmustusebraces): Avoid using 'for' statements without using surrounding braces. If the code formatting orindentati...
+* [IfElseStmtsMustUseBraces](pmd_rules_apex_codestyle.html#ifelsestmtsmustusebraces): Avoid using if..else statements without using surrounding braces. If the code formattingor indent...
+* [IfStmtsMustUseBraces](pmd_rules_apex_codestyle.html#ifstmtsmustusebraces): Avoid using if statements without using braces to surround the code block. If the codeformatting ...
+* [MethodNamingConventions](pmd_rules_apex_codestyle.html#methodnamingconventions): Method names should always begin with a lower case character, and should not contain underscores.
+* [OneDeclarationPerLine](pmd_rules_apex_codestyle.html#onedeclarationperline): Apex allows the use of several variables declaration of the same type on one line. However, itcan...
+* [VariableNamingConventions](pmd_rules_apex_codestyle.html#variablenamingconventions): A variable naming conventions rule - customize this to your liking. Currently, itchecks for fina...
+* [WhileLoopsMustUseBraces](pmd_rules_apex_codestyle.html#whileloopsmustusebraces): Avoid using 'while' statements without using braces to surround the code block. If the codeformat...
+
+## Design
+
+{% include callout.html content="Rules that help you discover design issues." %}
+
+* [AvoidDeeplyNestedIfStmts](pmd_rules_apex_design.html#avoiddeeplynestedifstmts): Avoid creating deeply nested if-then statements since they are harder to read and error-prone to ...
+* [CyclomaticComplexity](pmd_rules_apex_design.html#cyclomaticcomplexity): The complexity of methods directly affects maintenance costs and readability. Concentrating too m...
+* [ExcessiveClassLength](pmd_rules_apex_design.html#excessiveclasslength): Excessive class file lengths are usually indications that the class may be burdened with excessiv...
+* [ExcessiveParameterList](pmd_rules_apex_design.html#excessiveparameterlist): Methods with numerous parameters are a challenge to maintain, especially if most of them share th...
+* [ExcessivePublicCount](pmd_rules_apex_design.html#excessivepubliccount): Classes with large numbers of public methods and attributes require disproportionate testing effo...
+* [NcssConstructorCount](pmd_rules_apex_design.html#ncssconstructorcount): This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of l...
+* [NcssMethodCount](pmd_rules_apex_design.html#ncssmethodcount): This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of l...
+* [NcssTypeCount](pmd_rules_apex_design.html#ncsstypecount): This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of l...
+* [StdCyclomaticComplexity](pmd_rules_apex_design.html#stdcyclomaticcomplexity): Complexity directly affects maintenance costs is determined by the number of decision points in a...
+* [TooManyFields](pmd_rules_apex_design.html#toomanyfields): Classes that have too many fields can become unwieldy and could be redesigned to have fewer field...
+
+## Error Prone
+
+{% include callout.html content="Rules to detect constructs that are either broken, extremely confusing or prone to runtime errors." %}
+
+* [AvoidDirectAccessTriggerMap](pmd_rules_apex_errorprone.html#avoiddirectaccesstriggermap): Avoid directly accessing Trigger.old and Trigger.new as it can lead to a bug. Triggers should be ...
+* [AvoidHardcodingId](pmd_rules_apex_errorprone.html#avoidhardcodingid): When deploying Apex code between sandbox and production environments, or installing Force.com App...
+* [AvoidNonExistentAnnotations](pmd_rules_apex_errorprone.html#avoidnonexistentannotations): Apex supported non existent annotations for legacy reasons. In the future, use of such...
+* [EmptyCatchBlock](pmd_rules_apex_errorprone.html#emptycatchblock): Empty Catch Block finds instances where an exception is caught, but nothing is done. In most cir...
+* [EmptyIfStmt](pmd_rules_apex_errorprone.html#emptyifstmt): Empty If Statement finds instances where a condition is checked but nothing is done about it.
+* [EmptyStatementBlock](pmd_rules_apex_errorprone.html#emptystatementblock): Empty block statements serve no purpose and should be removed.
+* [EmptyTryOrFinallyBlock](pmd_rules_apex_errorprone.html#emptytryorfinallyblock): Avoid empty try or finally blocks - what's the point?
+* [EmptyWhileStmt](pmd_rules_apex_errorprone.html#emptywhilestmt): Empty While Statement finds all instances where a while statement does nothing. If it is a timin...
+* [MethodWithSameNameAsEnclosingClass](pmd_rules_apex_errorprone.html#methodwithsamenameasenclosingclass): Non-constructor methods should not have the same name as the enclosing class.
## Performance
+
+{% include callout.html content="Rules that flag suboptimal code." %}
+
* [AvoidDmlStatementsInLoops](pmd_rules_apex_performance.html#avoiddmlstatementsinloops): Avoid DML statements inside loops to avoid hitting the DML governor limit. Instead, try to batch ...
* [AvoidSoqlInLoops](pmd_rules_apex_performance.html#avoidsoqlinloops): New objects created within loops should be checked to see if they can created outside them and re...
+* [AvoidSoslInLoops](pmd_rules_apex_performance.html#avoidsoslinloops): Sosl calls within loops can cause governor limit exceptions.
## Security
+
+{% include callout.html content="Rules that flag potential security flaws." %}
+
* [ApexBadCrypto](pmd_rules_apex_security.html#apexbadcrypto): The rule makes sure you are using randomly generated IVs and keys for 'Crypto' calls.Hard-wiring ...
* [ApexCRUDViolation](pmd_rules_apex_security.html#apexcrudviolation): The rule validates you are checking for access permissions before a SOQL/SOSL/DML operation.Since...
* [ApexCSRF](pmd_rules_apex_security.html#apexcsrf): Check to avoid making DML operations in Apex class constructor/init method. This preventsmodifica...
@@ -50,11 +81,78 @@ List of rulesets and rules contained in each ruleset.
* [ApexXSSFromEscapeFalse](pmd_rules_apex_security.html#apexxssfromescapefalse): Reports on calls to 'addError' with disabled escaping. The message passed to 'addError'will be di...
* [ApexXSSFromURLParam](pmd_rules_apex_security.html#apexxssfromurlparam): Makes sure that all values obtained from URL parameters are properly escaped / sanitizedto avoid ...
-## Style
-* [AvoidGlobalModifier](pmd_rules_apex_style.html#avoidglobalmodifier): Global classes should be avoided (especially in managed packages) as they can never be deleted or...
-* [AvoidLogicInTrigger](pmd_rules_apex_style.html#avoidlogicintrigger): As triggers do not allow methods like regular classes they are less flexible and suited to apply ...
-* [ClassNamingConventions](pmd_rules_apex_style.html#classnamingconventions): Class names should always begin with an upper case character.
-* [MethodNamingConventions](pmd_rules_apex_style.html#methodnamingconventions): Method names should always begin with a lower case character, and should not contain underscores.
-* [MethodWithSameNameAsEnclosingClass](pmd_rules_apex_style.html#methodwithsamenameasenclosingclass): Non-constructor methods should not have the same name as the enclosing class.
-* [VariableNamingConventions](pmd_rules_apex_style.html#variablenamingconventions): A variable naming conventions rule - customize this to your liking. Currently, itchecks for fina...
+## Additional rulesets
+
+* ApexUnit (`rulesets/apex/apexunit.xml`):
+
+ Deprecated This ruleset is for backwards compatibility.
+
+ It contains the following rules:
+
+ [ApexUnitTestClassShouldHaveAsserts](pmd_rules_apex_bestpractices.html#apexunittestclassshouldhaveasserts), [ApexUnitTestShouldNotUseSeeAllDataTrue](pmd_rules_apex_bestpractices.html#apexunittestshouldnotuseseealldatatrue)
+
+* Braces (`rulesets/apex/braces.xml`):
+
+ Deprecated This ruleset is for backwards compatibility.
+
+ It contains the following rules:
+
+ [ForLoopsMustUseBraces](pmd_rules_apex_codestyle.html#forloopsmustusebraces), [IfElseStmtsMustUseBraces](pmd_rules_apex_codestyle.html#ifelsestmtsmustusebraces), [IfStmtsMustUseBraces](pmd_rules_apex_codestyle.html#ifstmtsmustusebraces), [WhileLoopsMustUseBraces](pmd_rules_apex_codestyle.html#whileloopsmustusebraces)
+
+* Complexity (`rulesets/apex/complexity.xml`):
+
+ Deprecated This ruleset is for backwards compatibility.
+
+ It contains the following rules:
+
+ [AvoidDeeplyNestedIfStmts](pmd_rules_apex_design.html#avoiddeeplynestedifstmts), [ExcessiveClassLength](pmd_rules_apex_design.html#excessiveclasslength), [ExcessiveParameterList](pmd_rules_apex_design.html#excessiveparameterlist), [ExcessivePublicCount](pmd_rules_apex_design.html#excessivepubliccount), [NcssConstructorCount](pmd_rules_apex_design.html#ncssconstructorcount), [NcssMethodCount](pmd_rules_apex_design.html#ncssmethodcount), [NcssTypeCount](pmd_rules_apex_design.html#ncsstypecount), [StdCyclomaticComplexity](pmd_rules_apex_design.html#stdcyclomaticcomplexity), [TooManyFields](pmd_rules_apex_design.html#toomanyfields)
+
+* Default ruleset used by the CodeClimate Engine for Salesforce.com Apex (`rulesets/apex/ruleset.xml`):
+
+ Default ruleset used by the Code Climate Engine for Salesforce.com Apex
+
+ It contains the following rules:
+
+ [ApexBadCrypto](pmd_rules_apex_security.html#apexbadcrypto), [ApexCRUDViolation](pmd_rules_apex_security.html#apexcrudviolation), [ApexCSRF](pmd_rules_apex_security.html#apexcsrf), [ApexDangerousMethods](pmd_rules_apex_security.html#apexdangerousmethods), [ApexDoc](pmd_rules_apex_documentation.html#apexdoc), [ApexInsecureEndpoint](pmd_rules_apex_security.html#apexinsecureendpoint), [ApexOpenRedirect](pmd_rules_apex_security.html#apexopenredirect), [ApexSharingViolations](pmd_rules_apex_security.html#apexsharingviolations), [ApexSOQLInjection](pmd_rules_apex_security.html#apexsoqlinjection), [ApexSuggestUsingNamedCred](pmd_rules_apex_security.html#apexsuggestusingnamedcred), [ApexUnitTestClassShouldHaveAsserts](pmd_rules_apex_bestpractices.html#apexunittestclassshouldhaveasserts), [ApexUnitTestShouldNotUseSeeAllDataTrue](pmd_rules_apex_bestpractices.html#apexunittestshouldnotuseseealldatatrue), [ApexXSSFromEscapeFalse](pmd_rules_apex_security.html#apexxssfromescapefalse), [ApexXSSFromURLParam](pmd_rules_apex_security.html#apexxssfromurlparam), [AvoidDeeplyNestedIfStmts](pmd_rules_apex_design.html#avoiddeeplynestedifstmts), [AvoidDirectAccessTriggerMap](pmd_rules_apex_errorprone.html#avoiddirectaccesstriggermap), [AvoidDmlStatementsInLoops](pmd_rules_apex_performance.html#avoiddmlstatementsinloops), [AvoidGlobalModifier](pmd_rules_apex_bestpractices.html#avoidglobalmodifier), [AvoidHardcodingId](pmd_rules_apex_errorprone.html#avoidhardcodingid), [AvoidLogicInTrigger](pmd_rules_apex_bestpractices.html#avoidlogicintrigger), [AvoidNonExistentAnnotations](pmd_rules_apex_errorprone.html#avoidnonexistentannotations), [AvoidSoqlInLoops](pmd_rules_apex_performance.html#avoidsoqlinloops), [AvoidSoslInLoops](pmd_rules_apex_performance.html#avoidsoslinloops), [ClassNamingConventions](pmd_rules_apex_codestyle.html#classnamingconventions), [CyclomaticComplexity](pmd_rules_apex_design.html#cyclomaticcomplexity), [EmptyCatchBlock](pmd_rules_apex_errorprone.html#emptycatchblock), [EmptyIfStmt](pmd_rules_apex_errorprone.html#emptyifstmt), [EmptyStatementBlock](pmd_rules_apex_errorprone.html#emptystatementblock), [EmptyTryOrFinallyBlock](pmd_rules_apex_errorprone.html#emptytryorfinallyblock), [EmptyWhileStmt](pmd_rules_apex_errorprone.html#emptywhilestmt), [ExcessiveClassLength](pmd_rules_apex_design.html#excessiveclasslength), [ExcessiveParameterList](pmd_rules_apex_design.html#excessiveparameterlist), [ExcessivePublicCount](pmd_rules_apex_design.html#excessivepubliccount), [ForLoopsMustUseBraces](pmd_rules_apex_codestyle.html#forloopsmustusebraces), [IfElseStmtsMustUseBraces](pmd_rules_apex_codestyle.html#ifelsestmtsmustusebraces), [IfStmtsMustUseBraces](pmd_rules_apex_codestyle.html#ifstmtsmustusebraces), [MethodNamingConventions](pmd_rules_apex_codestyle.html#methodnamingconventions), [MethodWithSameNameAsEnclosingClass](pmd_rules_apex_errorprone.html#methodwithsamenameasenclosingclass), [NcssConstructorCount](pmd_rules_apex_design.html#ncssconstructorcount), [NcssMethodCount](pmd_rules_apex_design.html#ncssmethodcount), [NcssTypeCount](pmd_rules_apex_design.html#ncsstypecount), [OneDeclarationPerLine](pmd_rules_apex_codestyle.html#onedeclarationperline), [StdCyclomaticComplexity](pmd_rules_apex_design.html#stdcyclomaticcomplexity), [TooManyFields](pmd_rules_apex_design.html#toomanyfields), [VariableNamingConventions](pmd_rules_apex_codestyle.html#variablenamingconventions), [WhileLoopsMustUseBraces](pmd_rules_apex_codestyle.html#whileloopsmustusebraces)
+
+* Empty Code (`rulesets/apex/empty.xml`):
+
+ Deprecated This ruleset is for backwards compatibility.
+
+ It contains the following rules:
+
+ [EmptyCatchBlock](pmd_rules_apex_errorprone.html#emptycatchblock), [EmptyIfStmt](pmd_rules_apex_errorprone.html#emptyifstmt), [EmptyStatementBlock](pmd_rules_apex_errorprone.html#emptystatementblock), [EmptyTryOrFinallyBlock](pmd_rules_apex_errorprone.html#emptytryorfinallyblock), [EmptyWhileStmt](pmd_rules_apex_errorprone.html#emptywhilestmt)
+
+* Metrics temporary ruleset (`rulesets/apex/metrics.xml`):
+
+ Deprecated This ruleset is for backwards compatibility.
+
+ It contains the following rules:
+
+ [CyclomaticComplexity](pmd_rules_apex_design.html#cyclomaticcomplexity)
+
+* Performance (`rulesets/apex/performance.xml`):
+
+ Deprecated This ruleset is for backwards compatibility.
+
+ It contains the following rules:
+
+ [AvoidDmlStatementsInLoops](pmd_rules_apex_performance.html#avoiddmlstatementsinloops), [AvoidSoqlInLoops](pmd_rules_apex_performance.html#avoidsoqlinloops), [AvoidSoslInLoops](pmd_rules_apex_performance.html#avoidsoslinloops)
+
+* Security (`rulesets/apex/security.xml`):
+
+ Deprecated This ruleset is for backwards compatibility.
+
+ It contains the following rules:
+
+ [ApexBadCrypto](pmd_rules_apex_security.html#apexbadcrypto), [ApexCRUDViolation](pmd_rules_apex_security.html#apexcrudviolation), [ApexCSRF](pmd_rules_apex_security.html#apexcsrf), [ApexDangerousMethods](pmd_rules_apex_security.html#apexdangerousmethods), [ApexInsecureEndpoint](pmd_rules_apex_security.html#apexinsecureendpoint), [ApexOpenRedirect](pmd_rules_apex_security.html#apexopenredirect), [ApexSharingViolations](pmd_rules_apex_security.html#apexsharingviolations), [ApexSOQLInjection](pmd_rules_apex_security.html#apexsoqlinjection), [ApexSuggestUsingNamedCred](pmd_rules_apex_security.html#apexsuggestusingnamedcred), [ApexXSSFromEscapeFalse](pmd_rules_apex_security.html#apexxssfromescapefalse), [ApexXSSFromURLParam](pmd_rules_apex_security.html#apexxssfromurlparam)
+
+* Style (`rulesets/apex/style.xml`):
+
+ Deprecated This ruleset is for backwards compatibility.
+
+ It contains the following rules:
+
+ [AvoidDirectAccessTriggerMap](pmd_rules_apex_errorprone.html#avoiddirectaccesstriggermap), [AvoidGlobalModifier](pmd_rules_apex_bestpractices.html#avoidglobalmodifier), [AvoidHardcodingId](pmd_rules_apex_errorprone.html#avoidhardcodingid), [AvoidLogicInTrigger](pmd_rules_apex_bestpractices.html#avoidlogicintrigger), [ClassNamingConventions](pmd_rules_apex_codestyle.html#classnamingconventions), [MethodNamingConventions](pmd_rules_apex_codestyle.html#methodnamingconventions), [MethodWithSameNameAsEnclosingClass](pmd_rules_apex_errorprone.html#methodwithsamenameasenclosingclass), [VariableNamingConventions](pmd_rules_apex_codestyle.html#variablenamingconventions)
+
diff --git a/docs/pages/pmd/rules/apex/apexunit.md b/docs/pages/pmd/rules/apex/apexunit.md
deleted file mode 100644
index b6b26fda984..00000000000
--- a/docs/pages/pmd/rules/apex/apexunit.md
+++ /dev/null
@@ -1,84 +0,0 @@
----
-title: ApexUnit
-summary: These rules deal with different problems that can occur with Apex unit tests.
-permalink: pmd_rules_apex_apexunit.html
-folder: pmd/rules/apex
-sidebaractiveurl: /pmd_rules_apex.html
-editmepath: ../pmd-apex/src/main/resources/rulesets/apex/apexunit.xml
-keywords: ApexUnit, ApexUnitTestClassShouldHaveAsserts, ApexUnitTestShouldNotUseSeeAllDataTrue
----
-## ApexUnitTestClassShouldHaveAsserts
-
-**Since:** PMD 5.5.1
-
-**Priority:** Medium (3)
-
-Apex unit tests should include at least one assertion. This makes the tests more robust, and using assert
- with messages provide the developer a clearer idea of what the test does.
-
-**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.apex.rule.apexunit.ApexUnitTestClassShouldHaveAssertsRule](https://github.com/pmd/pmd/blob/master/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/apexunit/ApexUnitTestClassShouldHaveAssertsRule.java)
-
-**Example(s):**
-
-``` java
-@isTest
-public class Foo {
- public static testMethod void testSomething() {
- Account a = null;
- // This is better than having a NullPointerException
- // System.assertNotEquals(a, null, 'account not found');
- a.toString();
- }
-}
-```
-
-**This rule has the following properties:**
-
-|Name|Default Value|Description|
-|----|-------------|-----------|
-|cc_categories|[Style]|Code Climate Categories|
-|cc_remediation_points_multiplier|1|Code Climate Remediation Points multiplier|
-|cc_block_highlighting|false|Code Climate Block Highlighting|
-
-**Use this rule by referencing it:**
-``` xml
-> searchList = [FIND 'map*' IN ALL FIELDS RETURNING Account (Id, Name), Contact, Opportunity, Lead];
+ }
+ }
+}
+```
+
+**This rule has the following properties:**
+
+|Name|Default Value|Description|Multivalued|
+|----|-------------|-----------|-----------|
+|cc_categories|Style|Code Climate Categories|yes. Delimiter is '\|'.|
+|cc_remediation_points_multiplier|1|Code Climate Remediation Points multiplier|no|
+|cc_block_highlighting|false|Code Climate Block Highlighting|no|
+
+**Use this rule by referencing it:**
+``` xml
+
+
+**This rule is defined by the following XPath expression:**
+``` xpath
+//IfStatement[@Else="true"][Scope[1]/ReturnStatement]
+```
+
+**Example(s):**
+
+``` javascript
+// Bad:
+if (x) {
+ return y;
+} else {
+ return z;
+}
+
+// Good:
+if (x) {
+ return y;
+}
+return z;
+```
+
+**Use this rule by referencing it:**
+``` xml
+
-
-```
-//IfStatement[@Else="true"][Scope[1]/ReturnStatement]
-```
-
-**Example(s):**
-
-``` javascript
-// Bad:
-if (x) {
- return y;
-} else {
- return z;
-}
-
-// Good:
-if (x) {
- return y;
-}
-return z;
-```
-
-**Use this rule by referencing it:**
-``` xml
-
-or
-
-**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.java.rule.basic.DoubleCheckedLockingRule](https://github.com/pmd/pmd/blob/master/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/basic/DoubleCheckedLockingRule.java)
-
-**Example(s):**
-
-``` java
-public class Foo {
- /*volatile */ Object baz = null; // fix for Java5 and later: volatile
- Object bar() {
- if (baz == null) { // baz may be non-null yet not fully created
- synchronized(this) {
- if (baz == null) {
- baz = new Object();
- }
- }
- }
- return baz;
- }
-}
-```
-
-**Use this rule by referencing it:**
-``` xml
- l) {
+ for (int i = 0; i < l.size(); i++) { // pre Java 1.5
+ System.out.println(l.get(i));
+ }
+
+ for (String s : l) { // post Java 1.5
+ System.out.println(s);
+ }
+ }
+}
+```
+
+**Use this rule by referencing it:**
+``` xml
+ list = new ArrayList<>();
+
+ public HashSet getFoo() {
+ return new HashSet();
+ }
+
+ // preferred approach
+ private List list = new ArrayList<>();
+
+ public Set getFoo() {
+ return new HashSet();
+ }
+}
+```
+
+**Use this rule by referencing it:**
+``` xml
+ lambda1 = s_str -> { };
+
+ // lambda parameters with an explicit type can be configured separately
+ Consumer lambda1 = (String str) -> { };
+
+ }
+
+ }
+```
+
+**This rule has the following properties:**
+
+|Name|Default Value|Description|Multivalued|
+|----|-------------|-----------|-----------|
+|methodParameterPattern|\[a-z\]\[a-zA-Z0-9\]\*|Regex which applies to formal parameter names|no|
+|finalMethodParameterPattern|\[a-z\]\[a-zA-Z0-9\]\*|Regex which applies to final formal parameter names|no|
+|lambdaParameterPattern|\[a-z\]\[a-zA-Z0-9\]\*|Regex which applies to inferred-type lambda parameter names|no|
+|explicitLambdaParameterPattern|\[a-z\]\[a-zA-Z0-9\]\*|Regex which applies to explicitly-typed lambda parameter names|no|
+
+**Use this rule by referencing it:**
+``` xml
+ extends BaseDao {
+ // This is ok...
+}
+
+public interface GenericDao {
+ // Also this
+}
+
+public interface GenericDao {
+ // 'e' should be an 'E'
+}
+
+public interface GenericDao {
+ // 'EF' is not ok.
+}
+```
+
+**Use this rule by referencing it:**
+``` xml
+
-*
-
-**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.java.rule.coupling.LawOfDemeterRule](https://github.com/pmd/pmd/blob/master/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/coupling/LawOfDemeterRule.java)
-
-**Example(s):**
-
-``` java
-public class Foo {
- /**
- * This example will result in two violations.
- */
- public void example(Bar b) {
- // this method call is ok, as b is a parameter of "example"
- C c = b.getC();
-
- // this method call is a violation, as we are using c, which we got from B.
- // We should ask b directly instead, e.g. "b.doItOnC();"
- c.doIt();
-
- // this is also a violation, just expressed differently as a method chain without temporary variables.
- b.getC().doIt();
-
- // a constructor call, not a method call.
- D d = new D();
- // this method call is ok, because we have create the new instance of D locally.
- d.doSomethingElse();
- }
-}
-```
-
-**Use this rule by referencing it:**
-``` xml
- list = new ArrayList<>();
-
-public HashSet getFoo() {
- return new HashSet();
-}
-
-// preferred approach
-private List list = new ArrayList<>();
-
-public Set getFoo() {
- return new HashSet();
-}
-```
-
-**Use this rule by referencing it:**
-``` xml
-
+*
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.java.rule.design.LawOfDemeterRule](https://github.com/pmd/pmd/blob/master/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/design/LawOfDemeterRule.java)
**Example(s):**
``` java
-// replace this
-Class c = new String().getClass();
+public class Foo {
+ /**
+ * This example will result in two violations.
+ */
+ public void example(Bar b) {
+ // this method call is ok, as b is a parameter of "example"
+ C c = b.getC();
+
+ // this method call is a violation, as we are using c, which we got from B.
+ // We should ask b directly instead, e.g. "b.doItOnC();"
+ c.doIt();
-// with this:
-Class c = String.class;
+ // this is also a violation, just expressed differently as a method chain without temporary variables.
+ b.getC().doIt();
+
+ // a constructor call, not a method call.
+ D d = new D();
+ // this method call is ok, because we have create the new instance of D locally.
+ d.doSomethingElse();
+ }
+}
```
**Use this rule by referencing it:**
``` xml
- l) {
- for (int i = 0; i < l.size(); i++) { // pre Java 1.5
- System.out.println(l.get(i));
- }
-
- for (String s : l) { // post Java 1.5
- System.out.println(s);
- }
- }
-}
-```
-
-**Use this rule by referencing it:**
-``` xml
-
+or
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.java.rule.multithreading.DoubleCheckedLockingRule](https://github.com/pmd/pmd/blob/master/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/multithreading/DoubleCheckedLockingRule.java)
+
+**Example(s):**
+
+``` java
+public class Foo {
+ /*volatile */ Object baz = null; // fix for Java5 and later: volatile
+ Object bar() {
+ if (baz == null) { // baz may be non-null yet not fully created
+ synchronized(this) {
+ if (baz == null) {
+ baz = new Object();
+ }
+ }
+ }
+ return baz;
+ }
+}
+```
+
+**Use this rule by referencing it:**
+``` xml
+ extends BaseDao {
- // This is ok...
-}
-
-public interface GenericDao {
- // Also this
-}
-
-public interface GenericDao {
- // 'e' should be an 'E'
-}
-
-public interface GenericDao {
- // 'EF' is not ok.
-}
-```
-
-**Use this rule by referencing it:**
-``` xml
- foos = getFoos();
+
+// much better; this one allows the jvm to allocate an array of the correct size and effectively skip
+// the zeroing, since each array element will be overridden anyways
+Foo[] fooArray = foos.toArray(new Foo[0]);
+
+// inefficient, the array needs to be zeroed out by the jvm before it is handed over to the toArray method
+Foo[] fooArray = foos.toArray(new Foo[foos.size()]);
+```
+
+**Use this rule by referencing it:**
+``` xml
+ l= new ArrayList<>(100);
+ for (int i=0; i< 100; i++) {
+ l.add(ints[i]);
+ }
+ for (int i=0; i< 100; i++) {
+ l.add(a[i].toString()); // won't trigger the rule
+ }
+ }
+}
+```
+
+**Use this rule by referencing it:**
+``` xml
+
-
- -
-
-
-
-
-```
-
-**Use this rule by referencing it:**
-``` xml
-![](\"<%=Some.get()%)
/foo\">xxtext
-```
-
-**Use this rule by referencing it:**
-``` xml
-bad example><BODY>
-<iframe></iframe>
-</BODY> </HTML>
-
-<HTML><title>good example><BODY>
-<iframe src="foo"></iframe>
-</BODY> </HTML>
-```
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/jsp/basic.xml/IframeMissingSrcAttribute" />
-```
-
-## JspEncoding
-
-**Since:** PMD 4.0
-
-**Priority:** Medium (3)
-
-A missing 'meta' tag or page directive will trigger this rule, as well as a non-UTF-8 charset.
-
-```
-//CompilationUnit/Content[
-not(Element[@Name="meta"][
- Attribute[@Name="content"]/AttributeValue[contains(lower-case(@Image),"charset=utf-8")]
-])
-and
- not(JspDirective[@Name='page']/JspDirectiveAttribute[@Name='contentType'][contains(lower-case(@Value),"charset=utf-8")])
-]
-```
-
-**Example(s):**
-
-``` jsp
-Most browsers should be able to interpret the following headers:
-
-<%@ page contentType="text/html; charset=UTF-8" pageEncoding="UTF-8" %>
-
-<meta http-equiv="Content-Type"Â content="text/html; charset=UTF-8" />
-```
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/jsp/basic.xml/JspEncoding" />
-```
-
-## NoClassAttribute
-
-**Since:** PMD 3.6
-
-**Priority:** Medium High (2)
-
-Do not use an attribute called 'class'. Use "styleclass" for CSS styles.
-
-```
-//Attribute[ upper-case(@Name)="CLASS" ]
-```
-
-**Example(s):**
-
-``` jsp
-<HTML> <BODY>
-<P class="MajorHeading">Some text</P>
-</BODY> </HTML>
-```
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/jsp/basic.xml/NoClassAttribute" />
-```
-
-## NoHtmlComments
-
-**Since:** PMD 3.6
-
-**Priority:** Medium High (2)
-
-In a production system, HTML comments increase the payload
-between the application server to the client, and serve
-little other purpose. Consider switching to JSP comments.
-
-```
-//CommentTag
-```
-
-**Example(s):**
-
-``` jsp
-<HTML><title>bad example><BODY>
-<!-- HTML comment -->
-</BODY> </HTML>
-
-<HTML><title>good example><BODY>
-<%-- JSP comment --%>
-</BODY> </HTML>
-```
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/jsp/basic.xml/NoHtmlComments" />
-```
-
-## NoInlineScript
-
-**Since:** PMD 4.0
-
-**Priority:** Medium (3)
-
-Avoid inlining HTML script content. Consider externalizing the HTML script using the 'src' attribute on the "script" element.
-Externalized script could be reused between pages. Browsers can also cache the script, reducing overall download bandwidth.
-
-```
-//HtmlScript[@Image != '']
-```
-
-**Example(s):**
-
-``` jsp
-Most browsers should be able to interpret the following headers:
-
-<%@ page contentType="text/html; charset=UTF-8" pageEncoding="UTF-8" %>
-
-<meta http-equiv="Content-Type"Â content="text/html; charset=UTF-8" />
-```
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/jsp/basic.xml/NoInlineScript" />
-```
-
-## NoInlineStyleInformation
-
-**Since:** PMD 3.6
-
-**Priority:** Medium (3)
-
-Style information should be put in CSS files, not in JSPs. Therefore, don't use <B> or <FONT>
-tags, or attributes like "align='center'".
-
-**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.jsp.rule.basic.NoInlineStyleInformationRule](https://github.com/pmd/pmd/blob/master/pmd-jsp/src/main/java/net/sourceforge/pmd/lang/jsp/rule/basic/NoInlineStyleInformationRule.java)
-
-**Example(s):**
-
-``` jsp
-<html><body><p align='center'><b>text</b></p></body></html>
-```
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/jsp/basic.xml/NoInlineStyleInformation" />
-```
-
-## NoJspForward
-
-**Since:** PMD 3.6
-
-**Priority:** Medium (3)
-
-Do not do a forward from within a JSP file.
-
-```
-//Element[ @Name="jsp:forward" ]
-```
-
-**Example(s):**
-
-``` jsp
-<jsp:forward page='UnderConstruction.jsp'/>
-```
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/jsp/basic.xml/NoJspForward" />
-```
-
-## NoLongScripts
-
-**Since:** PMD 3.6
-
-**Priority:** Medium High (2)
-
-Scripts should be part of Tag Libraries, rather than part of JSP pages.
-
-```
-//HtmlScript[(@EndLine - @BeginLine > 10)]
-```
-
-**Example(s):**
-
-``` jsp
-<HTML>
-<BODY>
-<!--Java Script-->
-<SCRIPT language="JavaScript" type="text/javascript">
-<!--
-function calcDays(){
- var date1 = document.getElementById('d1').lastChild.data;
- var date2 = document.getElementById('d2').lastChild.data;
- date1 = date1.split("-");
- date2 = date2.split("-");
- var sDate = new Date(date1[0]+"/"+date1[1]+"/"+date1[2]);
- var eDate = new Date(date2[0]+"/"+date2[1]+"/"+date2[2]);
- var daysApart = Math.abs(Math.round((sDate-eDate)/86400000));
- document.getElementById('diffDays').lastChild.data = daysApart;
-}
-
-onload=calcDays;
-//-->
-</SCRIPT>
-</BODY>
-</HTML>
-```
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/jsp/basic.xml/NoLongScripts" />
-```
-
-## NoScriptlets
-
-**Since:** PMD 3.6
-
-**Priority:** Medium (3)
-
-Scriptlets should be factored into Tag Libraries or JSP declarations, rather than being part of JSP pages.
-
-```
-//JspScriptlet
-|
-//Element[ upper-case(@Name)="JSP:SCRIPTLET" ]
-```
-
-**Example(s):**
-
-``` jsp
-<HTML>
-<HEAD>
-<%
-response.setHeader("Pragma", "No-cache");
-%>
-</HEAD>
- <BODY>
- <jsp:scriptlet>String title = "Hello world!";</jsp:scriptlet>
- </BODY>
-</HTML>
-```
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/jsp/basic.xml/NoScriptlets" />
-```
-
-## NoUnsanitizedJSPExpression
-
-**Since:** PMD 5.1.4
-
-**Priority:** Medium (3)
-
-Avoid using expressions without escaping / sanitizing. This could lead to cross site scripting - as the expression
-would be interpreted by the browser directly (e.g. "<script>alert('hello');</script>").
-
-**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.jsp.rule.basic.NoUnsanitizedJSPExpressionRule](https://github.com/pmd/pmd/blob/master/pmd-jsp/src/main/java/net/sourceforge/pmd/lang/jsp/rule/basic/NoUnsanitizedJSPExpressionRule.java)
-
-**Example(s):**
-
-``` jsp
-<%@ page contentType="text/html; charset=UTF-8" %>
-<%@ taglib prefix="fn" uri="http://java.sun.com/jsp/jstl/functions" %>
-${expression} <!-- don't use this -->
-${fn:escapeXml(expression)} <!-- instead, escape it -->
-<c:out value="${expression}" /> <!-- or use c:out -->
-```
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/jsp/basic.xml/NoUnsanitizedJSPExpression" />
-```
-
diff --git a/docs/pages/pmd/rules/jsp/bestpractices.md b/docs/pages/pmd/rules/jsp/bestpractices.md
new file mode 100644
index 00000000000..eb055fb6c99
--- /dev/null
+++ b/docs/pages/pmd/rules/jsp/bestpractices.md
@@ -0,0 +1,124 @@
+---
+title: Best Practices
+summary: Rules which enforce generally accepted best practices.
+permalink: pmd_rules_jsp_bestpractices.html
+folder: pmd/rules/jsp
+sidebaractiveurl: /pmd_rules_jsp.html
+editmepath: ../pmd-jsp/src/main/resources/category/jsp/bestpractices.xml
+keywords: Best Practices, DontNestJsfInJstlIteration, NoClassAttribute, NoHtmlComments, NoJspForward
+language: Java Server Pages
+---
+## DontNestJsfInJstlIteration
+
+**Since:** PMD 3.6
+
+**Priority:** Medium (3)
+
+Do not nest JSF component custom actions inside a custom action that iterates over its body.
+
+**This rule is defined by the following XPath expression:**
+``` xpath
+//Element[ @Name="c:forEach" ] // Element[ @NamespacePrefix="h" or @NamespacePrefix="f" ]
+```
+
+**Example(s):**
+
+``` jsp
+<html>
+ <body>
+ <ul>
+ <c:forEach items='${books}' var='b'>
+ <li> <h:outputText value='#{b}' /> </li>
+ </c:forEach>
+ </ul>
+ </body>
+</html>
+```
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/jsp/bestpractices.xml/DontNestJsfInJstlIteration" />
+```
+
+## NoClassAttribute
+
+**Since:** PMD 3.6
+
+**Priority:** Medium High (2)
+
+Do not use an attribute called 'class'. Use "styleclass" for CSS styles.
+
+**This rule is defined by the following XPath expression:**
+``` xpath
+//Attribute[ upper-case(@Name)="CLASS" ]
+```
+
+**Example(s):**
+
+``` jsp
+<HTML> <BODY>
+<P class="MajorHeading">Some text</P>
+</BODY> </HTML>
+```
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/jsp/bestpractices.xml/NoClassAttribute" />
+```
+
+## NoHtmlComments
+
+**Since:** PMD 3.6
+
+**Priority:** Medium High (2)
+
+In a production system, HTML comments increase the payload
+between the application server to the client, and serve
+little other purpose. Consider switching to JSP comments.
+
+**This rule is defined by the following XPath expression:**
+``` xpath
+//CommentTag
+```
+
+**Example(s):**
+
+``` jsp
+<HTML><title>bad example><BODY>
+<!-- HTML comment -->
+</BODY> </HTML>
+
+<HTML><title>good example><BODY>
+<%-- JSP comment --%>
+</BODY> </HTML>
+```
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/jsp/bestpractices.xml/NoHtmlComments" />
+```
+
+## NoJspForward
+
+**Since:** PMD 3.6
+
+**Priority:** Medium (3)
+
+Do not do a forward from within a JSP file.
+
+**This rule is defined by the following XPath expression:**
+``` xpath
+//Element[ @Name="jsp:forward" ]
+```
+
+**Example(s):**
+
+``` jsp
+<jsp:forward page='UnderConstruction.jsp'/>
+```
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/jsp/bestpractices.xml/NoJspForward" />
+```
+
diff --git a/docs/pages/pmd/rules/jsp/codestyle.md b/docs/pages/pmd/rules/jsp/codestyle.md
new file mode 100644
index 00000000000..2654710a2d1
--- /dev/null
+++ b/docs/pages/pmd/rules/jsp/codestyle.md
@@ -0,0 +1,31 @@
+---
+title: Code Style
+summary: Rules which enforce a specific coding style.
+permalink: pmd_rules_jsp_codestyle.html
+folder: pmd/rules/jsp
+sidebaractiveurl: /pmd_rules_jsp.html
+editmepath: ../pmd-jsp/src/main/resources/category/jsp/codestyle.xml
+keywords: Code Style, DuplicateJspImports
+language: Java Server Pages
+---
+## DuplicateJspImports
+
+**Since:** PMD 3.7
+
+**Priority:** Medium (3)
+
+Avoid duplicate import statements inside JSP's.
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.jsp.rule.codestyle.DuplicateJspImportsRule](https://github.com/pmd/pmd/blob/master/pmd-jsp/src/main/java/net/sourceforge/pmd/lang/jsp/rule/codestyle/DuplicateJspImportsRule.java)
+
+**Example(s):**
+
+``` jsp
+<%@ page import=\"com.foo.MyClass,com.foo.MyClass\"%><html><body><b><img src=\"<%=Some.get()%>/foo\">xx</img>text</b></body></html>
+```
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/jsp/codestyle.xml/DuplicateJspImports" />
+```
+
diff --git a/docs/pages/pmd/rules/jsp/design.md b/docs/pages/pmd/rules/jsp/design.md
new file mode 100644
index 00000000000..b4b1733fe42
--- /dev/null
+++ b/docs/pages/pmd/rules/jsp/design.md
@@ -0,0 +1,130 @@
+---
+title: Design
+summary: Rules that help you discover design issues.
+permalink: pmd_rules_jsp_design.html
+folder: pmd/rules/jsp
+sidebaractiveurl: /pmd_rules_jsp.html
+editmepath: ../pmd-jsp/src/main/resources/category/jsp/design.xml
+keywords: Design, NoInlineScript, NoInlineStyleInformation, NoLongScripts, NoScriptlets
+language: Java Server Pages
+---
+## NoInlineScript
+
+**Since:** PMD 4.0
+
+**Priority:** Medium (3)
+
+Avoid inlining HTML script content. Consider externalizing the HTML script using the 'src' attribute on the "script" element.
+Externalized script could be reused between pages. Browsers can also cache the script, reducing overall download bandwidth.
+
+**This rule is defined by the following XPath expression:**
+``` xpath
+//HtmlScript[@Image != '']
+```
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/jsp/design.xml/NoInlineScript" />
+```
+
+## NoInlineStyleInformation
+
+**Since:** PMD 3.6
+
+**Priority:** Medium (3)
+
+Style information should be put in CSS files, not in JSPs. Therefore, don't use <B> or <FONT>
+tags, or attributes like "align='center'".
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.jsp.rule.design.NoInlineStyleInformationRule](https://github.com/pmd/pmd/blob/master/pmd-jsp/src/main/java/net/sourceforge/pmd/lang/jsp/rule/design/NoInlineStyleInformationRule.java)
+
+**Example(s):**
+
+``` jsp
+<html><body><p align='center'><b>text</b></p></body></html>
+```
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/jsp/design.xml/NoInlineStyleInformation" />
+```
+
+## NoLongScripts
+
+**Since:** PMD 3.6
+
+**Priority:** Medium High (2)
+
+Scripts should be part of Tag Libraries, rather than part of JSP pages.
+
+**This rule is defined by the following XPath expression:**
+``` xpath
+//HtmlScript[(@EndLine - @BeginLine > 10)]
+```
+
+**Example(s):**
+
+``` jsp
+<HTML>
+<BODY>
+<!--Java Script-->
+<SCRIPT language="JavaScript" type="text/javascript">
+<!--
+function calcDays(){
+ var date1 = document.getElementById('d1').lastChild.data;
+ var date2 = document.getElementById('d2').lastChild.data;
+ date1 = date1.split("-");
+ date2 = date2.split("-");
+ var sDate = new Date(date1[0]+"/"+date1[1]+"/"+date1[2]);
+ var eDate = new Date(date2[0]+"/"+date2[1]+"/"+date2[2]);
+ var daysApart = Math.abs(Math.round((sDate-eDate)/86400000));
+ document.getElementById('diffDays').lastChild.data = daysApart;
+}
+
+onload=calcDays;
+//-->
+</SCRIPT>
+</BODY>
+</HTML>
+```
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/jsp/design.xml/NoLongScripts" />
+```
+
+## NoScriptlets
+
+**Since:** PMD 3.6
+
+**Priority:** Medium (3)
+
+Scriptlets should be factored into Tag Libraries or JSP declarations, rather than being part of JSP pages.
+
+**This rule is defined by the following XPath expression:**
+``` xpath
+//JspScriptlet
+|
+//Element[ upper-case(@Name)="JSP:SCRIPTLET" ]
+```
+
+**Example(s):**
+
+``` jsp
+<HTML>
+<HEAD>
+<%
+response.setHeader("Pragma", "No-cache");
+%>
+</HEAD>
+ <BODY>
+ <jsp:scriptlet>String title = "Hello world!";</jsp:scriptlet>
+ </BODY>
+</HTML>
+```
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/jsp/design.xml/NoScriptlets" />
+```
+
diff --git a/docs/pages/pmd/rules/jsp/errorprone.md b/docs/pages/pmd/rules/jsp/errorprone.md
new file mode 100644
index 00000000000..b351d9a844d
--- /dev/null
+++ b/docs/pages/pmd/rules/jsp/errorprone.md
@@ -0,0 +1,44 @@
+---
+title: Error Prone
+summary: Rules to detect constructs that are either broken, extremely confusing or prone to runtime errors.
+permalink: pmd_rules_jsp_errorprone.html
+folder: pmd/rules/jsp
+sidebaractiveurl: /pmd_rules_jsp.html
+editmepath: ../pmd-jsp/src/main/resources/category/jsp/errorprone.xml
+keywords: Error Prone, JspEncoding
+language: Java Server Pages
+---
+## JspEncoding
+
+**Since:** PMD 4.0
+
+**Priority:** Medium (3)
+
+A missing 'meta' tag or page directive will trigger this rule, as well as a non-UTF-8 charset.
+
+**This rule is defined by the following XPath expression:**
+``` xpath
+//CompilationUnit/Content[
+not(Element[@Name="meta"][
+ Attribute[@Name="content"]/AttributeValue[contains(lower-case(@Image),"charset=utf-8")]
+])
+and
+ not(JspDirective[@Name='page']/JspDirectiveAttribute[@Name='contentType'][contains(lower-case(@Value),"charset=utf-8")])
+]
+```
+
+**Example(s):**
+
+``` jsp
+Most browsers should be able to interpret the following headers:
+
+<%@ page contentType="text/html; charset=UTF-8" pageEncoding="UTF-8" %>
+
+<meta http-equiv="Content-Type"Â content="text/html; charset=UTF-8" />
+```
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/jsp/errorprone.xml/JspEncoding" />
+```
+
diff --git a/docs/pages/pmd/rules/jsp/security.md b/docs/pages/pmd/rules/jsp/security.md
new file mode 100644
index 00000000000..0cc3cc60e58
--- /dev/null
+++ b/docs/pages/pmd/rules/jsp/security.md
@@ -0,0 +1,67 @@
+---
+title: Security
+summary: Rules that flag potential security flaws.
+permalink: pmd_rules_jsp_security.html
+folder: pmd/rules/jsp
+sidebaractiveurl: /pmd_rules_jsp.html
+editmepath: ../pmd-jsp/src/main/resources/category/jsp/security.xml
+keywords: Security, IframeMissingSrcAttribute, NoUnsanitizedJSPExpression
+language: Java Server Pages
+---
+## IframeMissingSrcAttribute
+
+**Since:** PMD 3.6
+
+**Priority:** Medium High (2)
+
+IFrames which are missing a src element can cause security information popups in IE if you are accessing the page
+through SSL. See http://support.microsoft.com/default.aspx?scid=kb;EN-US;Q261188
+
+**This rule is defined by the following XPath expression:**
+``` xpath
+//Element[upper-case(@Name)="IFRAME"][count(Attribute[upper-case(@Name)="SRC" ]) = 0]
+```
+
+**Example(s):**
+
+``` jsp
+<HTML><title>bad example><BODY>
+<iframe></iframe>
+</BODY> </HTML>
+
+<HTML><title>good example><BODY>
+<iframe src="foo"></iframe>
+</BODY> </HTML>
+```
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/jsp/security.xml/IframeMissingSrcAttribute" />
+```
+
+## NoUnsanitizedJSPExpression
+
+**Since:** PMD 5.1.4
+
+**Priority:** Medium (3)
+
+Avoid using expressions without escaping / sanitizing. This could lead to cross site scripting - as the expression
+would be interpreted by the browser directly (e.g. "<script>alert('hello');</script>").
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.jsp.rule.security.NoUnsanitizedJSPExpressionRule](https://github.com/pmd/pmd/blob/master/pmd-jsp/src/main/java/net/sourceforge/pmd/lang/jsp/rule/security/NoUnsanitizedJSPExpressionRule.java)
+
+**Example(s):**
+
+``` jsp
+<%@ page contentType="text/html; charset=UTF-8" %>
+<%@ taglib prefix="fn" uri="http://java.sun.com/jsp/jstl/functions" %>
+${expression} <!-- don't use this -->
+${fn:escapeXml(expression)} <!-- instead, escape it -->
+<c:out value="${expression}" /> <!-- or use c:out -->
+```
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/jsp/security.xml/NoUnsanitizedJSPExpression" />
+```
+
diff --git a/docs/pages/pmd/rules/plsql.md b/docs/pages/pmd/rules/plsql.md
index 8263aac1d85..7dfe05bca82 100644
--- a/docs/pages/pmd/rules/plsql.md
+++ b/docs/pages/pmd/rules/plsql.md
@@ -1,37 +1,82 @@
---
title: PLSQL Rules
+tags: [rule_references, plsql]
+summary: Index of all built-in rules available for PLSQL
+language_name: PLSQL
permalink: pmd_rules_plsql.html
folder: pmd/rules
---
-List of rulesets and rules contained in each ruleset.
-
-* [Code Size](pmd_rules_plsql_codesize.html): The Code Size ruleset contains rules that find problems related to code size or complexity.
-* [PLSQL DATETIME](pmd_rules_plsql_dates.html): The Dates ruleset deals with PLSQL DATETIME usages.
-* [Strict Syntax](pmd_rules_plsql_strictsyntax.html): The Strict Syntax ruleset contains rules that highlight invalid plsql syntax, which works, but should be avoided.
-* [Tom Kyte's Despair](pmd_rules_plsql_TomKytesDespair.html): Rules based on Thomas Kyte's recommendations on http://asktom.oracle.com/ and http://tkyte.blogspot.com/.
-
-## Code Size
-* [CyclomaticComplexity](pmd_rules_plsql_codesize.html#cyclomaticcomplexity): Complexity directly affects maintenance costs is determined by the number of decision points in a...
-* [ExcessiveMethodLength](pmd_rules_plsql_codesize.html#excessivemethodlength): When methods are excessively long this usually indicates that the method is doing more than itsna...
-* [ExcessiveObjectLength](pmd_rules_plsql_codesize.html#excessiveobjectlength): Excessive object line lengths are usually indications that the object may be burdened with excess...
-* [ExcessivePackageBodyLength](pmd_rules_plsql_codesize.html#excessivepackagebodylength): Excessive class file lengths are usually indications that the class may be burdened with excessiv...
-* [ExcessivePackageSpecificationLength](pmd_rules_plsql_codesize.html#excessivepackagespecificationlength): Excessive class file lengths are usually indications that the class may be burdened with excessiv...
-* [ExcessiveParameterList](pmd_rules_plsql_codesize.html#excessiveparameterlist): Methods with numerous parameters are a challenge to maintain, especially if most of them share th...
-* [ExcessiveTypeLength](pmd_rules_plsql_codesize.html#excessivetypelength): Excessive class file lengths are usually indications that the class may be burdened with excessiv...
-* [NcssMethodCount](pmd_rules_plsql_codesize.html#ncssmethodcount): This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of l...
-* [NcssObjectCount](pmd_rules_plsql_codesize.html#ncssobjectcount): This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of l...
-* [NPathComplexity](pmd_rules_plsql_codesize.html#npathcomplexity): The NPath complexity of a method is the number of acyclic execution paths through that method.A t...
-* [TooManyFields](pmd_rules_plsql_codesize.html#toomanyfields): Classes that have too many fields can become unwieldy and could be redesigned to have fewer field...
-* [TooManyMethods](pmd_rules_plsql_codesize.html#toomanymethods): A package or type with too many methods is probably a good suspect for refactoring, in order to r...
-
-## PLSQL DATETIME
-* [TO_DATE_TO_CHAR](pmd_rules_plsql_dates.html#to_date_to_char): TO_DATE(TO_CHAR(date-variable)) used to remove time component - use TRUNC(date-veriable)
-* [TO_DATEWithoutDateFormat](pmd_rules_plsql_dates.html#to_datewithoutdateformat): TO_DATE without date format- use TO_DATE(expression, date-format)
-* [TO_TIMESTAMPWithoutDateFormat](pmd_rules_plsql_dates.html#to_timestampwithoutdateformat): TO_TIMESTAMP without date format- use TO_TIMESTAMP(expression, date-format)
-
-## Strict Syntax
-* [MisplacedPragma](pmd_rules_plsql_strictsyntax.html#misplacedpragma): Oracle states that the PRAQMA AUTONOMOUS_TRANSACTION must be in the declaration block,but the cod...
-
-## Tom Kyte's Despair
-* [TomKytesDespair](pmd_rules_plsql_TomKytesDespair.html#tomkytesdespair): "WHEN OTHERS THEN NULL" hides all errors - (Re)RAISE an exception or call RAISE_APPLICATION_ERROR
+## Best Practices
+
+{% include callout.html content="Rules which enforce generally accepted best practices." %}
+
+* [TomKytesDespair](pmd_rules_plsql_bestpractices.html#tomkytesdespair): "WHEN OTHERS THEN NULL" hides all errors - (Re)RAISE an exception or call RAISE_APPLICATION_ERROR
+
+## Code Style
+
+{% include callout.html content="Rules which enforce a specific coding style." %}
+
+* [CodeFormat](pmd_rules_plsql_codestyle.html#codeformat): This rule verifies that the PLSQL code is properly formatted. The following checks are executed:S...
+* [ForLoopNaming](pmd_rules_plsql_codestyle.html#forloopnaming): In case you have loops please name the loop variables more meaningful.
+* [MisplacedPragma](pmd_rules_plsql_codestyle.html#misplacedpragma): Oracle states that the PRAQMA AUTONOMOUS_TRANSACTION must be in the declaration block,but the cod...
+
+## Design
+
+{% include callout.html content="Rules that help you discover design issues." %}
+
+* [CyclomaticComplexity](pmd_rules_plsql_design.html#cyclomaticcomplexity): Complexity directly affects maintenance costs is determined by the number of decision points in a...
+* [ExcessiveMethodLength](pmd_rules_plsql_design.html#excessivemethodlength): When methods are excessively long this usually indicates that the method is doing more than itsna...
+* [ExcessiveObjectLength](pmd_rules_plsql_design.html#excessiveobjectlength): Excessive object line lengths are usually indications that the object may be burdened with excess...
+* [ExcessivePackageBodyLength](pmd_rules_plsql_design.html#excessivepackagebodylength): Excessive class file lengths are usually indications that the class may be burdened with excessiv...
+* [ExcessivePackageSpecificationLength](pmd_rules_plsql_design.html#excessivepackagespecificationlength): Excessive class file lengths are usually indications that the class may be burdened with excessiv...
+* [ExcessiveParameterList](pmd_rules_plsql_design.html#excessiveparameterlist): Methods with numerous parameters are a challenge to maintain, especially if most of them share th...
+* [ExcessiveTypeLength](pmd_rules_plsql_design.html#excessivetypelength): Excessive class file lengths are usually indications that the class may be burdened with excessiv...
+* [NcssMethodCount](pmd_rules_plsql_design.html#ncssmethodcount): This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of l...
+* [NcssObjectCount](pmd_rules_plsql_design.html#ncssobjectcount): This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of l...
+* [NPathComplexity](pmd_rules_plsql_design.html#npathcomplexity): The NPath complexity of a method is the number of acyclic execution paths through that method.A t...
+* [TooManyFields](pmd_rules_plsql_design.html#toomanyfields): Classes that have too many fields can become unwieldy and could be redesigned to have fewer field...
+* [TooManyMethods](pmd_rules_plsql_design.html#toomanymethods): A package or type with too many methods is probably a good suspect for refactoring, in order to r...
+
+## Error Prone
+
+{% include callout.html content="Rules to detect constructs that are either broken, extremely confusing or prone to runtime errors." %}
+
+* [TO_DATE_TO_CHAR](pmd_rules_plsql_errorprone.html#to_date_to_char): TO_DATE(TO_CHAR(date-variable)) used to remove time component - use TRUNC(date-variable)
+* [TO_DATEWithoutDateFormat](pmd_rules_plsql_errorprone.html#to_datewithoutdateformat): TO_DATE without date format- use TO_DATE(expression, date-format)
+* [TO_TIMESTAMPWithoutDateFormat](pmd_rules_plsql_errorprone.html#to_timestampwithoutdateformat): TO_TIMESTAMP without date format- use TO_TIMESTAMP(expression, date-format)
+
+## Additional rulesets
+
+* Code Size (`rulesets/plsql/codesize.xml`):
+
+ <span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> This ruleset is for backwards compatibility.
+
+ It contains the following rules:
+
+ [CyclomaticComplexity](pmd_rules_plsql_design.html#cyclomaticcomplexity), [ExcessiveMethodLength](pmd_rules_plsql_design.html#excessivemethodlength), [ExcessiveObjectLength](pmd_rules_plsql_design.html#excessiveobjectlength), [ExcessivePackageBodyLength](pmd_rules_plsql_design.html#excessivepackagebodylength), [ExcessivePackageSpecificationLength](pmd_rules_plsql_design.html#excessivepackagespecificationlength), [ExcessiveParameterList](pmd_rules_plsql_design.html#excessiveparameterlist), [ExcessiveTypeLength](pmd_rules_plsql_design.html#excessivetypelength), [NcssMethodCount](pmd_rules_plsql_design.html#ncssmethodcount), [NcssObjectCount](pmd_rules_plsql_design.html#ncssobjectcount), [NPathComplexity](pmd_rules_plsql_design.html#npathcomplexity), [TooManyFields](pmd_rules_plsql_design.html#toomanyfields), [TooManyMethods](pmd_rules_plsql_design.html#toomanymethods)
+
+* PLSQL DATETIME (`rulesets/plsql/dates.xml`):
+
+ <span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> This ruleset is for backwards compatibility.
+
+ It contains the following rules:
+
+ [TO_DATE_TO_CHAR](pmd_rules_plsql_errorprone.html#to_date_to_char), [TO_DATEWithoutDateFormat](pmd_rules_plsql_errorprone.html#to_datewithoutdateformat), [TO_TIMESTAMPWithoutDateFormat](pmd_rules_plsql_errorprone.html#to_timestampwithoutdateformat)
+
+* Strict Syntax (`rulesets/plsql/strictsyntax.xml`):
+
+ <span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> This ruleset is for backwards compatibility.
+
+ It contains the following rules:
+
+ [MisplacedPragma](pmd_rules_plsql_codestyle.html#misplacedpragma)
+
+* Tom Kyte's Despair (`rulesets/plsql/TomKytesDespair.xml`):
+
+ <span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> This ruleset is for backwards compatibility.
+
+ It contains the following rules:
+
+ [TomKytesDespair](pmd_rules_plsql_bestpractices.html#tomkytesdespair)
+
diff --git a/docs/pages/pmd/rules/plsql/TomKytesDespair.md b/docs/pages/pmd/rules/plsql/TomKytesDespair.md
deleted file mode 100644
index d6f2bbdf6bf..00000000000
--- a/docs/pages/pmd/rules/plsql/TomKytesDespair.md
+++ /dev/null
@@ -1,71 +0,0 @@
----
-title: Tom Kyte's Despair
-summary: Rules based on Thomas Kyte's recommendations on http://asktom.oracle.com/ and http://tkyte.blogspot.com/.
-permalink: pmd_rules_plsql_TomKytesDespair.html
-folder: pmd/rules/plsql
-sidebaractiveurl: /pmd_rules_plsql.html
-editmepath: ../pmd-plsql/src/main/resources/rulesets/plsql/TomKytesDespair.xml
-keywords: Tom Kyte's Despair, TomKytesDespair
----
-## TomKytesDespair
-
-**Since:** PMD 5.1
-
-**Priority:** Medium (3)
-
-"WHEN OTHERS THEN NULL" hides all errors - (Re)RAISE an exception or call RAISE_APPLICATION_ERROR
-
-```
-//ExceptionHandler[QualifiedName/@Image='OTHERS' and upper-case(Statement/UnlabelledStatement/Expression/@Image)='NULL']
-```
-
-**Example(s):**
-
-``` sql
-CREATE OR REPLACE PACKAGE BODY update_planned_hrs
-IS
-
-PROCEDURE set_new_planned (p_emp_id IN NUMBER, p_project_id IN NUMBER, p_hours IN NUMBER)
-IS
-BEGIN
- UPDATE employee_on_activity ea
- SET ea.ea_planned_hours = p_hours
- WHERE
- ea.ea_emp_id = p_emp_id
- AND ea.ea_proj_id = p_project_id;
-
-EXCEPTION
- WHEN NO_DATA_FOUND THEN
- RAISE_APPLICATION_ERROR (-20100, 'No such employee or project');
-
-END set_new_planned;
-
-FUNCTION existing_planned (p_emp_id IN NUMBER, p_project_id IN NUMBER) RETURN NUMBER
-
-IS
-
-existing_hours NUMBER(4);
-
-BEGIN
- SELECT ea.ea_planned_hours INTO existing_hours
- FROM employee_on_activity ea
- WHERE
- ea.ea_emp_id = p_emp_id
- AND ea.ea_proj_id = p_project_id;
-
- RETURN (existing_hours);
-
- EXCEPTION
- WHEN OTHERS THEN NULL;
-
- END existing_planned;
-
-END update_planned_hrs;
-/
-```
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/plsql/TomKytesDespair.xml/TomKytesDespair" />
-```
-
diff --git a/docs/pages/pmd/rules/plsql/bestpractices.md b/docs/pages/pmd/rules/plsql/bestpractices.md
new file mode 100644
index 00000000000..498922eab21
--- /dev/null
+++ b/docs/pages/pmd/rules/plsql/bestpractices.md
@@ -0,0 +1,73 @@
+---
+title: Best Practices
+summary: Rules which enforce generally accepted best practices.
+permalink: pmd_rules_plsql_bestpractices.html
+folder: pmd/rules/plsql
+sidebaractiveurl: /pmd_rules_plsql.html
+editmepath: ../pmd-plsql/src/main/resources/category/plsql/bestpractices.xml
+keywords: Best Practices, TomKytesDespair
+language: PLSQL
+---
+## TomKytesDespair
+
+**Since:** PMD 5.1
+
+**Priority:** Medium (3)
+
+"WHEN OTHERS THEN NULL" hides all errors - (Re)RAISE an exception or call RAISE_APPLICATION_ERROR
+
+**This rule is defined by the following XPath expression:**
+``` xpath
+//ExceptionHandler[QualifiedName/@Image='OTHERS' and upper-case(Statement/UnlabelledStatement/Expression/@Image)='NULL']
+```
+
+**Example(s):**
+
+``` sql
+CREATE OR REPLACE PACKAGE BODY update_planned_hrs
+IS
+
+PROCEDURE set_new_planned (p_emp_id IN NUMBER, p_project_id IN NUMBER, p_hours IN NUMBER)
+IS
+BEGIN
+ UPDATE employee_on_activity ea
+ SET ea.ea_planned_hours = p_hours
+ WHERE
+ ea.ea_emp_id = p_emp_id
+ AND ea.ea_proj_id = p_project_id;
+
+EXCEPTION
+ WHEN NO_DATA_FOUND THEN
+ RAISE_APPLICATION_ERROR (-20100, 'No such employee or project');
+
+END set_new_planned;
+
+FUNCTION existing_planned (p_emp_id IN NUMBER, p_project_id IN NUMBER) RETURN NUMBER
+
+IS
+
+existing_hours NUMBER(4);
+
+BEGIN
+ SELECT ea.ea_planned_hours INTO existing_hours
+ FROM employee_on_activity ea
+ WHERE
+ ea.ea_emp_id = p_emp_id
+ AND ea.ea_proj_id = p_project_id;
+
+ RETURN (existing_hours);
+
+ EXCEPTION
+ WHEN OTHERS THEN NULL;
+
+ END existing_planned;
+
+END update_planned_hrs;
+/
+```
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/plsql/bestpractices.xml/TomKytesDespair" />
+```
+
diff --git a/docs/pages/pmd/rules/plsql/codesize.md b/docs/pages/pmd/rules/plsql/codesize.md
deleted file mode 100644
index 60c525d2e5d..00000000000
--- a/docs/pages/pmd/rules/plsql/codesize.md
+++ /dev/null
@@ -1,638 +0,0 @@
----
-title: Code Size
-summary: The Code Size ruleset contains rules that find problems related to code size or complexity.
-permalink: pmd_rules_plsql_codesize.html
-folder: pmd/rules/plsql
-sidebaractiveurl: /pmd_rules_plsql.html
-editmepath: ../pmd-plsql/src/main/resources/rulesets/plsql/codesize.xml
-keywords: Code Size, NPathComplexity, ExcessiveMethodLength, ExcessiveParameterList, ExcessiveObjectLength, ExcessiveTypeLength, ExcessivePackageBodyLength, ExcessivePackageSpecificationLength, CyclomaticComplexity, TooManyFields, NcssMethodCount, NcssObjectCount, TooManyMethods
----
-## CyclomaticComplexity
-
-**Since:** PMD 5.1
-
-**Priority:** Medium (3)
-
-Complexity directly affects maintenance costs is determined by the number of decision points in a method
-plus one for the method entry. The decision points include 'if', 'while', 'for', and 'case labels' calls.
-Generally, numbers ranging from 1-4 denote low complexity, 5-7 denote moderate complexity, 8-10 denote
-high complexity, and 11+ is very high complexity.
-
-**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.plsql.rule.codesize.CyclomaticComplexityRule](https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/codesize/CyclomaticComplexityRule.java)
-
-**Example(s):**
-
-``` sql
--- Cyclomatic Complexity of 25
-CREATE OR REPLACE PACKAGE BODY pkg_pmd_working_sequence AS
-1 PROCEDURE ty_logger IS BEGIN
-2 IF true
- THEN
- DBMS_OUTPUT.PUT_LINE('IF/THEN l_Integer='||l_integer);
-3 IF true
- THEN
- DBMS_OUTPUT.PUT_LINE('IF/THEN l_Integer='||l_integer);
-4 IF true
- THEN
- DBMS_OUTPUT.PUT_LINE('IF/THEN l_Integer='||l_integer);
-5 ELSIF false
- THEN
- DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
- ELSE
- DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
- END IF;
-6 ELSIF false
- THEN
- DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
-7 IF true
- THEN
- DBMS_OUTPUT.PUT_LINE('IF/THEN l_Integer='||l_integer);
-8 ELSIF false
- THEN
- DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
- ELSE
- DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
- END IF;
- ELSE
- DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
-9 IF true
- THEN
- DBMS_OUTPUT.PUT_LINE('IF/THEN l_Integer='||l_integer);
-10 ELSIF false
- THEN
- DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
- ELSE
- DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
- END IF;
- END IF;
-11 ELSIF false
- THEN
- DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
-12 IF true
- THEN
- DBMS_OUTPUT.PUT_LINE('IF/THEN l_Integer='||l_integer);
-13 IF true
- THEN
- DBMS_OUTPUT.PUT_LINE('IF/THEN l_Integer='||l_integer);
-14 ELSIF false
- THEN
- DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
- ELSE
- DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
- END IF;
-15 ELSIF false
- THEN
-16 IF true
- THEN
- DBMS_OUTPUT.PUT_LINE('IF/THEN l_Integer='||l_integer);
-17 ELSIF false
- THEN
- DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
- ELSE
- DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
- END IF;
- DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
- ELSE
- DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
- END IF;
- ELSE
- DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
-18 IF true
- THEN
- DBMS_OUTPUT.PUT_LINE('IF/THEN l_Integer='||l_integer);
-19 IF true
- THEN
- DBMS_OUTPUT.PUT_LINE('IF/THEN l_Integer='||l_integer);
-20 ELSIF false
- THEN
- DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
- ELSE
- DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
- END IF;
-21 ELSIF false
- THEN
- DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
-22 IF true
- THEN
- DBMS_OUTPUT.PUT_LINE('IF/THEN l_Integer='||l_integer);
-23 ELSIF false
- THEN
- DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
- ELSE
- DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
- END IF;
- ELSE
- DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
-24 IF true
- THEN
- DBMS_OUTPUT.PUT_LINE('IF/THEN l_Integer='||l_integer);
-25 ELSIF false
- THEN
- DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
- ELSE
- DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
- END IF;
- END IF;
- END IF;
-END;
-
-END;
-```
-
-**This rule has the following properties:**
-
-|Name|Default Value|Description|
-|----|-------------|-----------|
-|showMethodsComplexity|true|Add method average violations to the report|
-|showClassesComplexity|true|Add class average violations to the report|
-|reportLevel|10|Cyclomatic Complexity reporting threshold|
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/plsql/codesize.xml/CyclomaticComplexity" />
-```
-
-## ExcessiveMethodLength
-
-**Since:** PMD 5.1
-
-**Priority:** Medium (3)
-
-When methods are excessively long this usually indicates that the method is doing more than its
-name/signature might suggest. They also become challenging for others to digest since excessive
-scrolling causes readers to lose focus.
-Try to reduce the method length by creating helper methods and removing any copy/pasted code.
-
-**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.plsql.rule.codesize.ExcessiveMethodLengthRule](https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/codesize/ExcessiveMethodLengthRule.java)
-
-**Example(s):**
-
-``` sql
-CREATE OR REPLACE
-PROCEDURE doSomething BEGIN
- DBMS_OUTPUT.PUT_LINE("Hello world!");
- DBMS_OUTPUT.PUT_LINE("Hello world!");
- -- 98 copies omitted for brevity.
-END;
-```
-
-**This rule has the following properties:**
-
-|Name|Default Value|Description|
-|----|-------------|-----------|
-|topscore||Top score value|
-|minimum||Minimum reporting threshold|
-|sigma||Sigma value|
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/plsql/codesize.xml/ExcessiveMethodLength" />
-```
-
-## ExcessiveObjectLength
-
-**Since:** PMD 5.1
-
-**Priority:** Medium (3)
-
-Excessive object line lengths are usually indications that the object may be burdened with excessive
-responsibilities that could be provided by other objects. In breaking these methods
-apart the code becomes more managable and ripe for reuse.
-
-**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.plsql.rule.codesize.ExcessiveObjectLengthRule](https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/codesize/ExcessiveObjectLengthRule.java)
-
-**Example(s):**
-
-``` sql
-CREATE OR REPLACE
-PACKAGE BODY Foo AS
- PROCEDURE bar1 IS BEGIN
- -- 1000 lines of code
- END bar1;
- PROCEDURE bar2 IS BEGIN
- -- 1000 lines of code
- END bar2;
- PROCEDURE bar3 IS BEGIN
- -- 1000 lines of code
- END bar3;
-
-
- PROCEDURE barN IS BEGIN
- -- 1000 lines of code
- END barn;
-END;
-```
-
-**This rule has the following properties:**
-
-|Name|Default Value|Description|
-|----|-------------|-----------|
-|topscore||Top score value|
-|minimum||Minimum reporting threshold|
-|sigma||Sigma value|
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/plsql/codesize.xml/ExcessiveObjectLength" />
-```
-
-## ExcessivePackageBodyLength
-
-**Since:** PMD 5.1
-
-**Priority:** Medium (3)
-
-Excessive class file lengths are usually indications that the class may be burdened with excessive
-responsibilities that could be provided by external classes or functions. In breaking these methods
-apart the code becomes more managable and ripe for reuse.
-
-**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.plsql.rule.codesize.ExcessivePackageBodyLengthRule](https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/codesize/ExcessivePackageBodyLengthRule.java)
-
-**Example(s):**
-
-``` sql
-CREATE OR REPLACE
-PACKAGE BODY Foo AS
- PROCEDURE bar1 IS BEGIN
- -- 1000 lines of code
- END bar1;
- PROCEDURE bar2 IS BEGIN
- -- 1000 lines of code
- END bar2;
- PROCEDURE bar3 IS BEGIN
- -- 1000 lines of code
- END bar3;
-
-
- PROCEDURE barN IS BEGIN
- -- 1000 lines of code
- END barn;
-END;
-```
-
-**This rule has the following properties:**
-
-|Name|Default Value|Description|
-|----|-------------|-----------|
-|topscore||Top score value|
-|minimum||Minimum reporting threshold|
-|sigma||Sigma value|
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/plsql/codesize.xml/ExcessivePackageBodyLength" />
-```
-
-## ExcessivePackageSpecificationLength
-
-**Since:** PMD 5.1
-
-**Priority:** Medium (3)
-
-Excessive class file lengths are usually indications that the class may be burdened with excessive
-responsibilities that could be provided by external classes or functions. In breaking these methods
-apart the code becomes more managable and ripe for reuse.
-
-**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.plsql.rule.codesize.ExcessivePackageSpecificationLengthRule](https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/codesize/ExcessivePackageSpecificationLengthRule.java)
-
-**Example(s):**
-
-``` sql
-CREATE OR REPLACE
-PACKAGE Foo AS
- PROCEDURE bar1;
- PROCEDURE bar2;
- PROCEDURE bar3;
-
- ...
-
- PROCEDURE barN;
-END;
-```
-
-**This rule has the following properties:**
-
-|Name|Default Value|Description|
-|----|-------------|-----------|
-|topscore||Top score value|
-|minimum||Minimum reporting threshold|
-|sigma||Sigma value|
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/plsql/codesize.xml/ExcessivePackageSpecificationLength" />
-```
-
-## ExcessiveParameterList
-
-**Since:** PMD 5.1
-
-**Priority:** Medium (3)
-
-Methods with numerous parameters are a challenge to maintain, especially if most of them share the
-same datatype. These situations usually denote the need for new objects to wrap the numerous parameters.
-
-**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.plsql.rule.codesize.ExcessiveParameterListRule](https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/codesize/ExcessiveParameterListRule.java)
-
-**Example(s):**
-
-``` sql
-CREATE OR REPLACE
-PROCEDURE addPerson( -- too many arguments liable to be mixed up
- birthYear pls_integer, birthMonth pls_integer, birthDate pls_integer, height pls_integer, weight pls_integer, ssn pls_integer) {
-
- . . . .
-END ADDPERSON;
-
-CREATE OR REPLACE
-PROCEDURE addPerson( -- preferred approach
- birthdate DATE, measurements BodyMeasurements , ssn INTEGER) BEGIN
-
- . . . .
-END;
-```
-
-**This rule has the following properties:**
-
-|Name|Default Value|Description|
-|----|-------------|-----------|
-|topscore||Top score value|
-|minimum||Minimum reporting threshold|
-|sigma||Sigma value|
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/plsql/codesize.xml/ExcessiveParameterList" />
-```
-
-## ExcessiveTypeLength
-
-**Since:** PMD 5.1
-
-**Priority:** Medium (3)
-
-Excessive class file lengths are usually indications that the class may be burdened with excessive
-responsibilities that could be provided by external classes or functions. In breaking these methods
-apart the code becomes more managable and ripe for reuse.
-
-**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.plsql.rule.codesize.ExcessiveTypeLengthRule](https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/codesize/ExcessiveTypeLengthRule.java)
-
-**Example(s):**
-
-``` sql
-CREATE OR REPLACE
-TYPE BODY Foo AS
- MEMBER PROCEDURE bar1 IS BEGIN
- -- 1000 lines of code
- END bar1;
- MEMBER PROCEDURE bar2 IS BEGIN
- -- 1000 lines of code
- END bar2;
- MEMBER PROCEDURE bar3 IS BEGIN
- -- 1000 lines of code
- END bar3;
-
-
- MEMBER PROCEDURE barN IS BEGIN
- -- 1000 lines of code
- END barn;
-END;
-```
-
-**This rule has the following properties:**
-
-|Name|Default Value|Description|
-|----|-------------|-----------|
-|topscore||Top score value|
-|minimum||Minimum reporting threshold|
-|sigma||Sigma value|
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/plsql/codesize.xml/ExcessiveTypeLength" />
-```
-
-## NcssMethodCount
-
-**Since:** PMD 5.1
-
-**Priority:** Medium (3)
-
-This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of lines
-of code for a given method. NCSS ignores comments, and counts actual statements. Using this algorithm,
-lines of code that are split are counted as one.
-
-**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.plsql.rule.codesize.NcssMethodCountRule](https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/codesize/NcssMethodCountRule.java)
-
-**Example(s):**
-
-``` sql
-CREATE OR REPLACE PACKAGE BODY AS
- FUNCTION methd RETURN INTEGER IS
- BEGIN
- RETURN 1;;
- END;
-END;
-```
-
-**This rule has the following properties:**
-
-|Name|Default Value|Description|
-|----|-------------|-----------|
-|topscore||Top score value|
-|minimum||Minimum reporting threshold|
-|sigma||Sigma value|
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/plsql/codesize.xml/NcssMethodCount" />
-```
-
-## NcssObjectCount
-
-**Since:** PMD 5.1
-
-**Priority:** Medium (3)
-
-This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of lines
-of code for a given Oracle object. NCSS ignores comments, and counts actual statements. Using this algorithm,
-lines of code that are split are counted as one.
-
-**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.plsql.rule.codesize.NcssObjectCountRule](https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/codesize/NcssObjectCountRule.java)
-
-**Example(s):**
-
-``` sql
-CREATE OR REPLACE PACKAGE pkg_
- PROCEDURE Foo IS
- BEGIN
- --this class only has 6 NCSS lines
- super();
- super();
- END;
-}
-```
-
-**This rule has the following properties:**
-
-|Name|Default Value|Description|
-|----|-------------|-----------|
-|topscore||Top score value|
-|minimum||Minimum reporting threshold|
-|sigma||Sigma value|
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/plsql/codesize.xml/NcssObjectCount" />
-```
-
-## NPathComplexity
-
-**Since:** PMD 5.1
-
-**Priority:** Medium (3)
-
-The NPath complexity of a method is the number of acyclic execution paths through that method.
-A threshold of 200 is generally considered the point where measures should be taken to reduce
-complexity and increase readability.
-
-**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.plsql.rule.codesize.NPathComplexityRule](https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/codesize/NPathComplexityRule.java)
-
-**Example(s):**
-
-``` sql
-CREATE OR REPLACE
-PROCEDURE bar AS BEGIN -- this is something more complex than it needs to be,
- if (y) THEN -- it should be broken down into smaller methods or functions
- for j IN 0 .. j-1 LOOP
- if (j > r) THEN
- doSomething;
- while (f < 5 ) LOOP
- anotherThing;
- f := f - 27;
- END LOOP;
- else
- tryThis();
- END IF;
- END LOOP;
- END IF;
- if ( r - n > 45) THEN
- while (doMagic) LOOP
- findRabbits;
- END LOOP;
- END IF;
- BEGIN
- doSomethingDangerous();
- EXCEPTION WHEN FooException THEN
- makeAmends;
- BEGIN
- dontDoItAgain;
- EXCEPTION
- WHEN OTHERS THEN
- log_problem;
- END;
- END;
-END;
-```
-
-**This rule has the following properties:**
-
-|Name|Default Value|Description|
-|----|-------------|-----------|
-|topscore||Top score value|
-|minimum||Minimum reporting threshold|
-|sigma||Sigma value|
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/plsql/codesize.xml/NPathComplexity" />
-```
-
-## TooManyFields
-
-**Since:** PMD 5.1
-
-**Priority:** Medium (3)
-
-Classes that have too many fields can become unwieldy and could be redesigned to have fewer fields,
-possibly through grouping related fields in new objects. For example, a class with individual
-city/state/zip fields could park them within a single Address field.
-
-**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.plsql.rule.codesize.TooManyFieldsRule](https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/codesize/TooManyFieldsRule.java)
-
-**Example(s):**
-
-``` sql
-CREATE OR REPLACE PACKAGE pkg_too_many_fields AS
- C_CHAR_A CONSTANT CHAR(1 CHAR) := 'A';
- C_CHAR_B CONSTANT CHAR(1 CHAR) := 'B';
- ...
- C_CHAR_Z CONSTANT CHAR(1 CHAR) := 'Z';
-END pkg_too_many_fields;
-```
-
-**This rule has the following properties:**
-
-|Name|Default Value|Description|
-|----|-------------|-----------|
-|maxfields|15|Max allowable fields|
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/plsql/codesize.xml/TooManyFields" />
-```
-
-## TooManyMethods
-
-**Since:** PMD 5.1
-
-**Priority:** Medium (3)
-
-A package or type with too many methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to
-have more fine grained objects.
-
-```
-//node()
- [ (
- local-name(.) = 'PackageSpecification'
- or
- local-name(.) = 'TypeSpecification'
- )
- and
- (
- count(/descendant::ProgramUnit[
- not (
- starts-with(@Image,'get')
- or
- starts-with(@Image,'set')
- or
- starts-with(@Image,'is')
- )
- ]
- )
- +
- count(/descendant::TypeMethod[
- not (
- starts-with(@Image,'get')
- or
- starts-with(@Image,'set')
- or
- starts-with(@Image,'is')
- )
- ]
- )
- ) > $maxmethods
- ]
-```
-
-**This rule has the following properties:**
-
-|Name|Default Value|Description|
-|----|-------------|-----------|
-|maxmethods|1|The method count reporting threshold|
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/plsql/codesize.xml/TooManyMethods" />
-```
-
diff --git a/docs/pages/pmd/rules/plsql/codestyle.md b/docs/pages/pmd/rules/plsql/codestyle.md
new file mode 100644
index 00000000000..eeecd344a33
--- /dev/null
+++ b/docs/pages/pmd/rules/plsql/codestyle.md
@@ -0,0 +1,192 @@
+---
+title: Code Style
+summary: Rules which enforce a specific coding style.
+permalink: pmd_rules_plsql_codestyle.html
+folder: pmd/rules/plsql
+sidebaractiveurl: /pmd_rules_plsql.html
+editmepath: ../pmd-plsql/src/main/resources/category/plsql/codestyle.xml
+keywords: Code Style, CodeFormat, MisplacedPragma, ForLoopNaming
+language: PLSQL
+---
+## CodeFormat
+
+**Since:** PMD 6.9.0
+
+**Priority:** Medium (3)
+
+This rule verifies that the PLSQL code is properly formatted. The following checks are executed:
+
+SQL Queries:
+
+* The selected columns must be each on a new line
+* The keywords (BULK COLLECT INTO, FROM) start on a new line and are indented by one level
+* UNION should be on the same indentation level as SELECT
+* Each JOIN is on a new line. If there are more than one JOIN conditions, then each condition should be
+ on a separate line.
+
+Parameter definitions for procedures:
+
+* Each parameter should be on a new line
+* Variable names as well as their types should be aligned
+
+Variable declarations:
+
+* Each variable should be on a new line
+* Variable names as well as their types should be aligned
+
+Calling a procedure:
+
+* If there are more than 3 parameters
+ * then named parameters should be used
+ * and each parameter should be on a new line
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.plsql.rule.codestyle.CodeFormatRule](https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/codestyle/CodeFormatRule.java)
+
+**Example(s):**
+
+``` sql
+BEGIN
+ -- select columns each on a separate line
+ SELECT cmer_id
+ ,version
+ ,cmp_id
+ BULK COLLECT INTO v_cmer_ids
+ ,v_versions
+ ,v_cmp_ids
+ FROM cmer;
+
+ -- each parameter on a new line
+ PROCEDURE create_prospect(
+ company_info_in IN prospects.company_info%TYPE -- Organization
+ ,firstname_in IN persons.firstname%TYPE -- FirstName
+ ,lastname_in IN persons.lastname%TYPE -- LastName
+ );
+
+ -- more than three parameters, each parameter on a separate line
+ webcrm_marketing.prospect_ins(
+ cmp_id_in => NULL
+ ,company_info_in => company_info_in
+ ,firstname_in => firstname_in
+ ,lastname_in => lastname_in
+ ,slt_code_in => NULL
+ );
+
+END;
+```
+
+**This rule has the following properties:**
+
+|Name|Default Value|Description|Multivalued|
+|----|-------------|-----------|-----------|
+|indentation|2|Indentation to be used for blocks|no|
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/plsql/codestyle.xml/CodeFormat" />
+```
+
+## ForLoopNaming
+
+**Since:** PMD 6.7.0
+
+**Priority:** Medium (3)
+
+In case you have loops please name the loop variables more meaningful.
+
+**This rule is defined by the following XPath expression:**
+``` xpath
+//CursorForLoopStatement[
+ $allowSimpleLoops = 'false' or
+ (Statement//CursorForLoopStatement or ancestor::CursorForLoopStatement)
+]
+/ForIndex[not(matches(@Image, $cursorPattern))]
+|
+//ForStatement[
+ $allowSimpleLoops = 'false' or
+ (Statement//ForStatement or ancestor::ForStatement)
+]
+/ForIndex[not(matches(@Image, $indexPattern))]
+```
+
+**Example(s):**
+
+``` sql
+-- good example
+BEGIN
+FOR company IN (SELECT * FROM companies) LOOP
+ FOR contact IN (SELECT * FROM contacts) LOOP
+ FOR party IN (SELECT * FROM parties) LOOP
+ NULL;
+ END LOOP;
+ END LOOP;
+END LOOP;
+END;
+/
+
+-- bad example
+BEGIN
+FOR c1 IN (SELECT * FROM companies) LOOP
+ FOR c2 IN (SELECT * FROM contacts) LOOP
+ FOR c3 IN (SELECT * FROM parties) LOOP
+ NULL;
+ END LOOP;
+ END LOOP;
+END LOOP;
+END;
+/
+```
+
+**This rule has the following properties:**
+
+|Name|Default Value|Description|Multivalued|
+|----|-------------|-----------|-----------|
+|allowSimpleLoops|false|Ignore simple loops, that are not nested|no|
+|cursorPattern|\[a-zA-Z\_0-9\]{5,}|The pattern used for the curosr loop variable|no|
+|indexPattern|\[a-zA-Z\_0-9\]{5,}|The pattern used for the index loop variable|no|
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/plsql/codestyle.xml/ForLoopNaming" />
+```
+
+## MisplacedPragma
+
+**Since:** PMD 5.5.2
+
+**Priority:** Medium (3)
+
+Oracle states that the PRAQMA AUTONOMOUS_TRANSACTION must be in the declaration block,
+but the code does not complain, when being compiled on the 11g DB.
+https://docs.oracle.com/cd/B28359_01/appdev.111/b28370/static.htm#BABIIHBJ
+
+**This rule is defined by the following XPath expression:**
+``` xpath
+//ProgramUnit/Pragma
+```
+
+**Example(s):**
+
+``` sql
+create or replace package inline_pragma_error is
+
+end;
+/
+
+create or replace package body inline_pragma_error is
+ procedure do_transaction(p_input_token in varchar(200)) is
+ PRAGMA AUTONOMOUS_TRANSACTION; /* this is correct place for PRAGMA */
+ begin
+ PRAGMA AUTONOMOUS_TRANSACTION; /* this is the wrong place for PRAGMA -> violation */
+ /* do something */
+ COMMIT;
+ end do_transaction;
+
+end inline_pragma_error;
+/
+```
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/plsql/codestyle.xml/MisplacedPragma" />
+```
+
diff --git a/docs/pages/pmd/rules/plsql/dates.md b/docs/pages/pmd/rules/plsql/dates.md
deleted file mode 100644
index 63e581f4aee..00000000000
--- a/docs/pages/pmd/rules/plsql/dates.md
+++ /dev/null
@@ -1,146 +0,0 @@
----
-title: PLSQL DATETIME
-summary: The Dates ruleset deals with PLSQL DATETIME usages.
-permalink: pmd_rules_plsql_dates.html
-folder: pmd/rules/plsql
-sidebaractiveurl: /pmd_rules_plsql.html
-editmepath: ../pmd-plsql/src/main/resources/rulesets/plsql/dates.xml
-keywords: PLSQL DATETIME, TO_DATEWithoutDateFormat, TO_DATE_TO_CHAR, TO_TIMESTAMPWithoutDateFormat
----
-## TO_DATE_TO_CHAR
-
-**Since:** PMD 5.1
-
-**Priority:** Medium (3)
-
-TO_DATE(TO_CHAR(date-variable)) used to remove time component - use TRUNC(date-veriable)
-
-```
-//PrimaryExpression
- [PrimaryPrefix/Name/@Image='TO_DATE']
- [count(PrimarySuffix/Arguments/ArgumentList/Argument) = 1]
- [.//PrimaryExpression
- [PrimaryPrefix/Name/@Image='TO_CHAR']
- [count(PrimarySuffix/Arguments/ArgumentList/Argument) = 1]
- ]
-```
-
-**Example(s):**
-
-``` sql
-CREATE OR REPLACE PACKAGE BODY date_utilities
-IS
-
--- Take single parameter, relyimg on current default NLS date format
-FUNCTION strip_time (p_date IN DATE) RETURN DATE
-IS
-BEGIN
- RETURN TO_DATE(TO_CHAR(p_date));
-END strip_time;
-
-
-END date_utilities;
-/
-```
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/plsql/dates.xml/TO_DATE_TO_CHAR" />
-```
-
-## TO_DATEWithoutDateFormat
-
-**Since:** PMD 5.1
-
-**Priority:** Medium (3)
-
-TO_DATE without date format- use TO_DATE(expression, date-format)
-
-```
-//PrimaryExpression[PrimaryPrefix/Name/@Image='TO_DATE' and count(PrimarySuffix/Arguments/ArgumentList/Argument) = 1 ]
-```
-
-**Example(s):**
-
-``` sql
-CREATE OR REPLACE PACKAGE BODY date_utilities
-IS
-
--- Take single parameter, relyimg on current default NLS date format
-FUNCTION to_date_single_parameter (p_date_string IN VARCHAR2) RETURN DATE
-IS
-BEGIN
- RETURN TO_DATE(p_date_string);
-END to_date_single_parameter ;
-
--- Take 2 parameters, using an explicit date format string
-FUNCTION to_date_two_parameters (p_date_string IN VARCHAR2, p_format_mask IN VARCHAR2) RETURN DATE
-IS
-BEGIN
- TO_DATE(p_date_string, p_date_format);
-END to_date_two_parameters;
-
--- Take 3 parameters, using an explicit date format string and an explicit language
-FUNCTION to_date_three_parameters (p_date_string IN VARCHAR2, p_format_mask IN VARCHAR2, p_nls_language VARCHAR2 ) RETURN DATE
-IS
-BEGIN
- TO_DATE(p_date_string, p_format_mask, p_nls_language);
-END to_date_three_parameters;
-
-END date_utilities;
-/
-```
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/plsql/dates.xml/TO_DATEWithoutDateFormat" />
-```
-
-## TO_TIMESTAMPWithoutDateFormat
-
-**Since:** PMD 5.1
-
-**Priority:** Medium (3)
-
-TO_TIMESTAMP without date format- use TO_TIMESTAMP(expression, date-format)
-
-```
-//PrimaryExpression[PrimaryPrefix/Name/@Image='TO_TIMESTAMP' and count(PrimarySuffix/Arguments/ArgumentList/Argument) = 1 ]
-```
-
-**Example(s):**
-
-``` sql
-CREATE OR REPLACE PACKAGE BODY date_utilities
-IS
-
--- Take single parameter, relyimg on current default NLS date format
-FUNCTION to_timestamp_single_parameter (p_date_string IN VARCHAR2) RETURN DATE
-IS
-BEGIN
- RETURN TO_TIMESTAMP(p_date_string);
-END to_timestamp_single_parameter;
-
--- Take 2 parameters, using an explicit date format string
-FUNCTION to_timestamp_two_parameters (p_date_string IN VARCHAR2, p_format_mask IN VARCHAR2) RETURN DATE
-IS
-BEGIN
- TO_TIMESTAMP(p_date_string, p_date_format);
-END to_timestamp_two_parameters;
-
--- Take 3 parameters, using an explicit date format string and an explicit language
-FUNCTION to_timestamp_three_parameters (p_date_string IN VARCHAR2, p_format_mask IN VARCHAR2, p_nls_language VARCHAR2 ) RETURN DATE
-IS
-BEGIN
- TO_TIMESTAMP(p_date_string, p_format_mask, p_nls_language);
-END to_timestamp_three_parameters;
-
-END date_utilities;
-/
-```
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/plsql/dates.xml/TO_TIMESTAMPWithoutDateFormat" />
-```
-
diff --git a/docs/pages/pmd/rules/plsql/design.md b/docs/pages/pmd/rules/plsql/design.md
new file mode 100644
index 00000000000..68e2fb29b71
--- /dev/null
+++ b/docs/pages/pmd/rules/plsql/design.md
@@ -0,0 +1,640 @@
+---
+title: Design
+summary: Rules that help you discover design issues.
+permalink: pmd_rules_plsql_design.html
+folder: pmd/rules/plsql
+sidebaractiveurl: /pmd_rules_plsql.html
+editmepath: ../pmd-plsql/src/main/resources/category/plsql/design.xml
+keywords: Design, CyclomaticComplexity, ExcessiveMethodLength, ExcessiveObjectLength, ExcessivePackageBodyLength, ExcessivePackageSpecificationLength, ExcessiveParameterList, ExcessiveTypeLength, NcssMethodCount, NcssObjectCount, NPathComplexity, TooManyFields, TooManyMethods
+language: PLSQL
+---
+## CyclomaticComplexity
+
+**Since:** PMD 5.1
+
+**Priority:** Medium (3)
+
+Complexity directly affects maintenance costs is determined by the number of decision points in a method
+plus one for the method entry. The decision points include 'if', 'while', 'for', and 'case labels' calls.
+Generally, numbers ranging from 1-4 denote low complexity, 5-7 denote moderate complexity, 8-10 denote
+high complexity, and 11+ is very high complexity.
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.plsql.rule.design.CyclomaticComplexityRule](https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/design/CyclomaticComplexityRule.java)
+
+**Example(s):**
+
+``` sql
+-- Cyclomatic Complexity of 25
+CREATE OR REPLACE PACKAGE BODY pkg_pmd_working_sequence AS
+1 PROCEDURE ty_logger IS BEGIN
+2 IF true
+ THEN
+ DBMS_OUTPUT.PUT_LINE('IF/THEN l_Integer='||l_integer);
+3 IF true
+ THEN
+ DBMS_OUTPUT.PUT_LINE('IF/THEN l_Integer='||l_integer);
+4 IF true
+ THEN
+ DBMS_OUTPUT.PUT_LINE('IF/THEN l_Integer='||l_integer);
+5 ELSIF false
+ THEN
+ DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
+ ELSE
+ DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
+ END IF;
+6 ELSIF false
+ THEN
+ DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
+7 IF true
+ THEN
+ DBMS_OUTPUT.PUT_LINE('IF/THEN l_Integer='||l_integer);
+8 ELSIF false
+ THEN
+ DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
+ ELSE
+ DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
+ END IF;
+ ELSE
+ DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
+9 IF true
+ THEN
+ DBMS_OUTPUT.PUT_LINE('IF/THEN l_Integer='||l_integer);
+10 ELSIF false
+ THEN
+ DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
+ ELSE
+ DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
+ END IF;
+ END IF;
+11 ELSIF false
+ THEN
+ DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
+12 IF true
+ THEN
+ DBMS_OUTPUT.PUT_LINE('IF/THEN l_Integer='||l_integer);
+13 IF true
+ THEN
+ DBMS_OUTPUT.PUT_LINE('IF/THEN l_Integer='||l_integer);
+14 ELSIF false
+ THEN
+ DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
+ ELSE
+ DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
+ END IF;
+15 ELSIF false
+ THEN
+16 IF true
+ THEN
+ DBMS_OUTPUT.PUT_LINE('IF/THEN l_Integer='||l_integer);
+17 ELSIF false
+ THEN
+ DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
+ ELSE
+ DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
+ END IF;
+ DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
+ ELSE
+ DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
+ END IF;
+ ELSE
+ DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
+18 IF true
+ THEN
+ DBMS_OUTPUT.PUT_LINE('IF/THEN l_Integer='||l_integer);
+19 IF true
+ THEN
+ DBMS_OUTPUT.PUT_LINE('IF/THEN l_Integer='||l_integer);
+20 ELSIF false
+ THEN
+ DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
+ ELSE
+ DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
+ END IF;
+21 ELSIF false
+ THEN
+ DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
+22 IF true
+ THEN
+ DBMS_OUTPUT.PUT_LINE('IF/THEN l_Integer='||l_integer);
+23 ELSIF false
+ THEN
+ DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
+ ELSE
+ DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
+ END IF;
+ ELSE
+ DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
+24 IF true
+ THEN
+ DBMS_OUTPUT.PUT_LINE('IF/THEN l_Integer='||l_integer);
+25 ELSIF false
+ THEN
+ DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
+ ELSE
+ DBMS_OUTPUT.PUT_LINE('ELSIF l_Integer='||l_integer);
+ END IF;
+ END IF;
+ END IF;
+END;
+
+END;
+```
+
+**This rule has the following properties:**
+
+|Name|Default Value|Description|Multivalued|
+|----|-------------|-----------|-----------|
+|showMethodsComplexity|true|Add method average violations to the report|no|
+|showClassesComplexity|true|Add class average violations to the report|no|
+|reportLevel|10|Cyclomatic Complexity reporting threshold|no|
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/plsql/design.xml/CyclomaticComplexity" />
+```
+
+## ExcessiveMethodLength
+
+**Since:** PMD 5.1
+
+**Priority:** Medium (3)
+
+When methods are excessively long this usually indicates that the method is doing more than its
+name/signature might suggest. They also become challenging for others to digest since excessive
+scrolling causes readers to lose focus.
+Try to reduce the method length by creating helper methods and removing any copy/pasted code.
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.plsql.rule.design.ExcessiveMethodLengthRule](https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/design/ExcessiveMethodLengthRule.java)
+
+**Example(s):**
+
+``` sql
+CREATE OR REPLACE
+PROCEDURE doSomething BEGIN
+ DBMS_OUTPUT.PUT_LINE("Hello world!");
+ DBMS_OUTPUT.PUT_LINE("Hello world!");
+ -- 98 copies omitted for brevity.
+END;
+```
+
+**This rule has the following properties:**
+
+|Name|Default Value|Description|Multivalued|
+|----|-------------|-----------|-----------|
+|topscore||Top score value|no|
+|minimum||Minimum reporting threshold|no|
+|sigma||Sigma value|no|
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/plsql/design.xml/ExcessiveMethodLength" />
+```
+
+## ExcessiveObjectLength
+
+**Since:** PMD 5.1
+
+**Priority:** Medium (3)
+
+Excessive object line lengths are usually indications that the object may be burdened with excessive
+responsibilities that could be provided by other objects. In breaking these methods
+apart the code becomes more managable and ripe for reuse.
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.plsql.rule.design.ExcessiveObjectLengthRule](https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/design/ExcessiveObjectLengthRule.java)
+
+**Example(s):**
+
+``` sql
+CREATE OR REPLACE
+PACKAGE BODY Foo AS
+ PROCEDURE bar1 IS BEGIN
+ -- 1000 lines of code
+ END bar1;
+ PROCEDURE bar2 IS BEGIN
+ -- 1000 lines of code
+ END bar2;
+ PROCEDURE bar3 IS BEGIN
+ -- 1000 lines of code
+ END bar3;
+
+
+ PROCEDURE barN IS BEGIN
+ -- 1000 lines of code
+ END barn;
+END;
+```
+
+**This rule has the following properties:**
+
+|Name|Default Value|Description|Multivalued|
+|----|-------------|-----------|-----------|
+|topscore||Top score value|no|
+|minimum||Minimum reporting threshold|no|
+|sigma||Sigma value|no|
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/plsql/design.xml/ExcessiveObjectLength" />
+```
+
+## ExcessivePackageBodyLength
+
+**Since:** PMD 5.1
+
+**Priority:** Medium (3)
+
+Excessive class file lengths are usually indications that the class may be burdened with excessive
+responsibilities that could be provided by external classes or functions. In breaking these methods
+apart the code becomes more managable and ripe for reuse.
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.plsql.rule.design.ExcessivePackageBodyLengthRule](https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/design/ExcessivePackageBodyLengthRule.java)
+
+**Example(s):**
+
+``` sql
+CREATE OR REPLACE
+PACKAGE BODY Foo AS
+ PROCEDURE bar1 IS BEGIN
+ -- 1000 lines of code
+ END bar1;
+ PROCEDURE bar2 IS BEGIN
+ -- 1000 lines of code
+ END bar2;
+ PROCEDURE bar3 IS BEGIN
+ -- 1000 lines of code
+ END bar3;
+
+
+ PROCEDURE barN IS BEGIN
+ -- 1000 lines of code
+ END barn;
+END;
+```
+
+**This rule has the following properties:**
+
+|Name|Default Value|Description|Multivalued|
+|----|-------------|-----------|-----------|
+|topscore||Top score value|no|
+|minimum||Minimum reporting threshold|no|
+|sigma||Sigma value|no|
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/plsql/design.xml/ExcessivePackageBodyLength" />
+```
+
+## ExcessivePackageSpecificationLength
+
+**Since:** PMD 5.1
+
+**Priority:** Medium (3)
+
+Excessive class file lengths are usually indications that the class may be burdened with excessive
+responsibilities that could be provided by external classes or functions. In breaking these methods
+apart the code becomes more managable and ripe for reuse.
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.plsql.rule.design.ExcessivePackageSpecificationLengthRule](https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/design/ExcessivePackageSpecificationLengthRule.java)
+
+**Example(s):**
+
+``` sql
+CREATE OR REPLACE
+PACKAGE Foo AS
+ PROCEDURE bar1;
+ PROCEDURE bar2;
+ PROCEDURE bar3;
+
+ ...
+
+ PROCEDURE barN;
+END;
+```
+
+**This rule has the following properties:**
+
+|Name|Default Value|Description|Multivalued|
+|----|-------------|-----------|-----------|
+|topscore||Top score value|no|
+|minimum||Minimum reporting threshold|no|
+|sigma||Sigma value|no|
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/plsql/design.xml/ExcessivePackageSpecificationLength" />
+```
+
+## ExcessiveParameterList
+
+**Since:** PMD 5.1
+
+**Priority:** Medium (3)
+
+Methods with numerous parameters are a challenge to maintain, especially if most of them share the
+same datatype. These situations usually denote the need for new objects to wrap the numerous parameters.
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.plsql.rule.design.ExcessiveParameterListRule](https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/design/ExcessiveParameterListRule.java)
+
+**Example(s):**
+
+``` sql
+CREATE OR REPLACE
+PROCEDURE addPerson( -- too many arguments liable to be mixed up
+ birthYear pls_integer, birthMonth pls_integer, birthDate pls_integer, height pls_integer, weight pls_integer, ssn pls_integer) {
+
+ . . . .
+END ADDPERSON;
+
+CREATE OR REPLACE
+PROCEDURE addPerson( -- preferred approach
+ birthdate DATE, measurements BodyMeasurements , ssn INTEGER) BEGIN
+
+ . . . .
+END;
+```
+
+**This rule has the following properties:**
+
+|Name|Default Value|Description|Multivalued|
+|----|-------------|-----------|-----------|
+|topscore||Top score value|no|
+|minimum||Minimum reporting threshold|no|
+|sigma||Sigma value|no|
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/plsql/design.xml/ExcessiveParameterList" />
+```
+
+## ExcessiveTypeLength
+
+**Since:** PMD 5.1
+
+**Priority:** Medium (3)
+
+Excessive class file lengths are usually indications that the class may be burdened with excessive
+responsibilities that could be provided by external classes or functions. In breaking these methods
+apart the code becomes more managable and ripe for reuse.
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.plsql.rule.design.ExcessiveTypeLengthRule](https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/design/ExcessiveTypeLengthRule.java)
+
+**Example(s):**
+
+``` sql
+CREATE OR REPLACE
+TYPE BODY Foo AS
+ MEMBER PROCEDURE bar1 IS BEGIN
+ -- 1000 lines of code
+ END bar1;
+ MEMBER PROCEDURE bar2 IS BEGIN
+ -- 1000 lines of code
+ END bar2;
+ MEMBER PROCEDURE bar3 IS BEGIN
+ -- 1000 lines of code
+ END bar3;
+
+
+ MEMBER PROCEDURE barN IS BEGIN
+ -- 1000 lines of code
+ END barn;
+END;
+```
+
+**This rule has the following properties:**
+
+|Name|Default Value|Description|Multivalued|
+|----|-------------|-----------|-----------|
+|topscore||Top score value|no|
+|minimum||Minimum reporting threshold|no|
+|sigma||Sigma value|no|
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/plsql/design.xml/ExcessiveTypeLength" />
+```
+
+## NcssMethodCount
+
+**Since:** PMD 5.1
+
+**Priority:** Medium (3)
+
+This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of lines
+of code for a given method. NCSS ignores comments, and counts actual statements. Using this algorithm,
+lines of code that are split are counted as one.
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.plsql.rule.design.NcssMethodCountRule](https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/design/NcssMethodCountRule.java)
+
+**Example(s):**
+
+``` sql
+CREATE OR REPLACE PACKAGE BODY AS
+ FUNCTION methd RETURN INTEGER IS
+ BEGIN
+ RETURN 1;;
+ END;
+END;
+```
+
+**This rule has the following properties:**
+
+|Name|Default Value|Description|Multivalued|
+|----|-------------|-----------|-----------|
+|topscore||Top score value|no|
+|minimum||Minimum reporting threshold|no|
+|sigma||Sigma value|no|
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/plsql/design.xml/NcssMethodCount" />
+```
+
+## NcssObjectCount
+
+**Since:** PMD 5.1
+
+**Priority:** Medium (3)
+
+This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of lines
+of code for a given Oracle object. NCSS ignores comments, and counts actual statements. Using this algorithm,
+lines of code that are split are counted as one.
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.plsql.rule.design.NcssObjectCountRule](https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/design/NcssObjectCountRule.java)
+
+**Example(s):**
+
+``` sql
+CREATE OR REPLACE PACKAGE pkg_
+ PROCEDURE Foo IS
+ BEGIN
+ --this class only has 6 NCSS lines
+ super();
+ super();
+ END;
+}
+```
+
+**This rule has the following properties:**
+
+|Name|Default Value|Description|Multivalued|
+|----|-------------|-----------|-----------|
+|topscore||Top score value|no|
+|minimum||Minimum reporting threshold|no|
+|sigma||Sigma value|no|
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/plsql/design.xml/NcssObjectCount" />
+```
+
+## NPathComplexity
+
+**Since:** PMD 5.1
+
+**Priority:** Medium (3)
+
+The NPath complexity of a method is the number of acyclic execution paths through that method.
+A threshold of 200 is generally considered the point where measures should be taken to reduce
+complexity and increase readability.
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.plsql.rule.design.NPathComplexityRule](https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/design/NPathComplexityRule.java)
+
+**Example(s):**
+
+``` sql
+CREATE OR REPLACE
+PROCEDURE bar AS BEGIN -- this is something more complex than it needs to be,
+ if (y) THEN -- it should be broken down into smaller methods or functions
+ for j IN 0 .. j-1 LOOP
+ if (j > r) THEN
+ doSomething;
+ while (f < 5 ) LOOP
+ anotherThing;
+ f := f - 27;
+ END LOOP;
+ else
+ tryThis();
+ END IF;
+ END LOOP;
+ END IF;
+ if ( r - n > 45) THEN
+ while (doMagic) LOOP
+ findRabbits;
+ END LOOP;
+ END IF;
+ BEGIN
+ doSomethingDangerous();
+ EXCEPTION WHEN FooException THEN
+ makeAmends;
+ BEGIN
+ dontDoItAgain;
+ EXCEPTION
+ WHEN OTHERS THEN
+ log_problem;
+ END;
+ END;
+END;
+```
+
+**This rule has the following properties:**
+
+|Name|Default Value|Description|Multivalued|
+|----|-------------|-----------|-----------|
+|topscore||Top score value|no|
+|minimum||Minimum reporting threshold|no|
+|sigma||Sigma value|no|
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/plsql/design.xml/NPathComplexity" />
+```
+
+## TooManyFields
+
+**Since:** PMD 5.1
+
+**Priority:** Medium (3)
+
+Classes that have too many fields can become unwieldy and could be redesigned to have fewer fields,
+possibly through grouping related fields in new objects. For example, a class with individual
+city/state/zip fields could park them within a single Address field.
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.plsql.rule.design.TooManyFieldsRule](https://github.com/pmd/pmd/blob/master/pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/design/TooManyFieldsRule.java)
+
+**Example(s):**
+
+``` sql
+CREATE OR REPLACE PACKAGE pkg_too_many_fields AS
+ C_CHAR_A CONSTANT CHAR(1 CHAR) := 'A';
+ C_CHAR_B CONSTANT CHAR(1 CHAR) := 'B';
+ ...
+ C_CHAR_Z CONSTANT CHAR(1 CHAR) := 'Z';
+END pkg_too_many_fields;
+```
+
+**This rule has the following properties:**
+
+|Name|Default Value|Description|Multivalued|
+|----|-------------|-----------|-----------|
+|maxfields|15|Max allowable fields|no|
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/plsql/design.xml/TooManyFields" />
+```
+
+## TooManyMethods
+
+**Since:** PMD 5.1
+
+**Priority:** Medium (3)
+
+A package or type with too many methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to
+have more fine grained objects.
+
+**This rule is defined by the following XPath expression:**
+``` xpath
+//node()
+ [ (
+ local-name(.) = 'PackageSpecification'
+ or
+ local-name(.) = 'TypeSpecification'
+ )
+ and
+ (
+ count(/descendant::ProgramUnit[
+ not (
+ starts-with(@Image,'get')
+ or
+ starts-with(@Image,'set')
+ or
+ starts-with(@Image,'is')
+ )
+ ]
+ )
+ +
+ count(/descendant::TypeMethod[
+ not (
+ starts-with(@Image,'get')
+ or
+ starts-with(@Image,'set')
+ or
+ starts-with(@Image,'is')
+ )
+ ]
+ )
+ ) > $maxmethods
+ ]
+```
+
+**This rule has the following properties:**
+
+|Name|Default Value|Description|Multivalued|
+|----|-------------|-----------|-----------|
+|maxmethods|1|The method count reporting threshold|no|
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/plsql/design.xml/TooManyMethods" />
+```
+
diff --git a/docs/pages/pmd/rules/plsql/errorprone.md b/docs/pages/pmd/rules/plsql/errorprone.md
new file mode 100644
index 00000000000..17b048571b6
--- /dev/null
+++ b/docs/pages/pmd/rules/plsql/errorprone.md
@@ -0,0 +1,150 @@
+---
+title: Error Prone
+summary: Rules to detect constructs that are either broken, extremely confusing or prone to runtime errors.
+permalink: pmd_rules_plsql_errorprone.html
+folder: pmd/rules/plsql
+sidebaractiveurl: /pmd_rules_plsql.html
+editmepath: ../pmd-plsql/src/main/resources/category/plsql/errorprone.xml
+keywords: Error Prone, TO_DATE_TO_CHAR, TO_DATEWithoutDateFormat, TO_TIMESTAMPWithoutDateFormat
+language: PLSQL
+---
+## TO_DATE_TO_CHAR
+
+**Since:** PMD 5.1
+
+**Priority:** Medium (3)
+
+TO_DATE(TO_CHAR(date-variable)) used to remove time component - use TRUNC(date-variable)
+
+**This rule is defined by the following XPath expression:**
+``` xpath
+//PrimaryExpression
+ [PrimaryPrefix/Name/@Image='TO_DATE']
+ [count(PrimarySuffix/Arguments/ArgumentList/Argument) = 1]
+ [.//PrimaryExpression
+ [PrimaryPrefix/Name/@Image='TO_CHAR']
+ [count(PrimarySuffix/Arguments/ArgumentList/Argument) = 1]
+ ]
+```
+
+**Example(s):**
+
+``` sql
+CREATE OR REPLACE PACKAGE BODY date_utilities
+IS
+
+-- Take single parameter, relying on current default NLS date format
+FUNCTION strip_time (p_date IN DATE) RETURN DATE
+IS
+BEGIN
+ RETURN TO_DATE(TO_CHAR(p_date));
+END strip_time;
+
+
+END date_utilities;
+/
+```
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/plsql/errorprone.xml/TO_DATE_TO_CHAR" />
+```
+
+## TO_DATEWithoutDateFormat
+
+**Since:** PMD 5.1
+
+**Priority:** Medium (3)
+
+TO_DATE without date format- use TO_DATE(expression, date-format)
+
+**This rule is defined by the following XPath expression:**
+``` xpath
+//PrimaryExpression[PrimaryPrefix/Name/@Image='TO_DATE' and count(PrimarySuffix/Arguments/ArgumentList/Argument) = 1 ]
+```
+
+**Example(s):**
+
+``` sql
+CREATE OR REPLACE PACKAGE BODY date_utilities
+IS
+
+-- Take single parameter, relying on current default NLS date format
+FUNCTION to_date_single_parameter (p_date_string IN VARCHAR2) RETURN DATE
+IS
+BEGIN
+ RETURN TO_DATE(p_date_string);
+END to_date_single_parameter ;
+
+-- Take 2 parameters, using an explicit date format string
+FUNCTION to_date_two_parameters (p_date_string IN VARCHAR2, p_format_mask IN VARCHAR2) RETURN DATE
+IS
+BEGIN
+ TO_DATE(p_date_string, p_date_format);
+END to_date_two_parameters;
+
+-- Take 3 parameters, using an explicit date format string and an explicit language
+FUNCTION to_date_three_parameters (p_date_string IN VARCHAR2, p_format_mask IN VARCHAR2, p_nls_language VARCHAR2 ) RETURN DATE
+IS
+BEGIN
+ TO_DATE(p_date_string, p_format_mask, p_nls_language);
+END to_date_three_parameters;
+
+END date_utilities;
+/
+```
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/plsql/errorprone.xml/TO_DATEWithoutDateFormat" />
+```
+
+## TO_TIMESTAMPWithoutDateFormat
+
+**Since:** PMD 5.1
+
+**Priority:** Medium (3)
+
+TO_TIMESTAMP without date format- use TO_TIMESTAMP(expression, date-format)
+
+**This rule is defined by the following XPath expression:**
+``` xpath
+//PrimaryExpression[PrimaryPrefix/Name/@Image='TO_TIMESTAMP' and count(PrimarySuffix/Arguments/ArgumentList/Argument) = 1 ]
+```
+
+**Example(s):**
+
+``` sql
+CREATE OR REPLACE PACKAGE BODY date_utilities
+IS
+
+-- Take single parameter, relying on current default NLS date format
+FUNCTION to_timestamp_single_parameter (p_date_string IN VARCHAR2) RETURN DATE
+IS
+BEGIN
+ RETURN TO_TIMESTAMP(p_date_string);
+END to_timestamp_single_parameter;
+
+-- Take 2 parameters, using an explicit date format string
+FUNCTION to_timestamp_two_parameters (p_date_string IN VARCHAR2, p_format_mask IN VARCHAR2) RETURN DATE
+IS
+BEGIN
+ TO_TIMESTAMP(p_date_string, p_date_format);
+END to_timestamp_two_parameters;
+
+-- Take 3 parameters, using an explicit date format string and an explicit language
+FUNCTION to_timestamp_three_parameters (p_date_string IN VARCHAR2, p_format_mask IN VARCHAR2, p_nls_language VARCHAR2 ) RETURN DATE
+IS
+BEGIN
+ TO_TIMESTAMP(p_date_string, p_format_mask, p_nls_language);
+END to_timestamp_three_parameters;
+
+END date_utilities;
+/
+```
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/plsql/errorprone.xml/TO_TIMESTAMPWithoutDateFormat" />
+```
+
diff --git a/docs/pages/pmd/rules/plsql/strictsyntax.md b/docs/pages/pmd/rules/plsql/strictsyntax.md
deleted file mode 100644
index 6e33ee8efa1..00000000000
--- a/docs/pages/pmd/rules/plsql/strictsyntax.md
+++ /dev/null
@@ -1,49 +0,0 @@
----
-title: Strict Syntax
-summary: The Strict Syntax ruleset contains rules that highlight invalid plsql syntax, which works, but should be avoided.
-permalink: pmd_rules_plsql_strictsyntax.html
-folder: pmd/rules/plsql
-sidebaractiveurl: /pmd_rules_plsql.html
-editmepath: ../pmd-plsql/src/main/resources/rulesets/plsql/strictsyntax.xml
-keywords: Strict Syntax, MisplacedPragma
----
-## MisplacedPragma
-
-**Since:** PMD 5.5.2
-
-**Priority:** Medium (3)
-
-Oracle states that the PRAQMA AUTONOMOUS_TRANSACTION must be in the declaration block,
-but the code does not complain, when being compiled on the 11g DB.
-https://docs.oracle.com/cd/B28359_01/appdev.111/b28370/static.htm#BABIIHBJ
-
-```
-//ProgramUnit/Pragma
-```
-
-**Example(s):**
-
-``` sql
-create or replace package inline_pragma_error is
-
-end;
-/
-
-create or replace package body inline_pragma_error is
- procedure do_transaction(p_input_token in varchar(200)) is
- PRAGMA AUTONOMOUS_TRANSACTION; /* this is correct place for PRAGMA */
- begin
- PRAGMA AUTONOMOUS_TRANSACTION; /* this is the wrong place for PRAGMA -> violation */
- /* do something */
- COMMIT;
- end do_transaction;
-
-end inline_pragma_error;
-/
-```
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/plsql/strictsyntax.xml/MisplacedPragma" />
-```
-
diff --git a/docs/pages/pmd/rules/pom.md b/docs/pages/pmd/rules/pom.md
index acd194c3abf..0b5e8f692fc 100644
--- a/docs/pages/pmd/rules/pom.md
+++ b/docs/pages/pmd/rules/pom.md
@@ -1,13 +1,26 @@
---
title: Maven POM Rules
+tags: [rule_references, pom]
+summary: Index of all built-in rules available for Maven POM
+language_name: Maven POM
permalink: pmd_rules_pom.html
folder: pmd/rules
---
-List of rulesets and rules contained in each ruleset.
+## Error Prone
-* [Basic POM](pmd_rules_pom_basic.html): The Basic POM Ruleset contains a collection of good practices regarding Maven's POM files.
+{% include callout.html content="Rules to detect constructs that are either broken, extremely confusing or prone to runtime errors." %}
+
+* [InvalidDependencyTypes](pmd_rules_pom_errorprone.html#invaliddependencytypes): If you use an invalid dependency type in the dependency management section, Maven doesn't fail. I...
+* [ProjectVersionAsDependencyVersion](pmd_rules_pom_errorprone.html#projectversionasdependencyversion): Using that expression in dependency declarations seems like a shortcut, but it can go wrong.By fa...
+
+## Additional rulesets
+
+* Basic POM (`rulesets/pom/basic.xml`):
+
+ <span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> This ruleset is for backwards compatibility.
+
+ It contains the following rules:
+
+ [InvalidDependencyTypes](pmd_rules_pom_errorprone.html#invaliddependencytypes), [ProjectVersionAsDependencyVersion](pmd_rules_pom_errorprone.html#projectversionasdependencyversion)
-## Basic POM
-* [InvalidDependencyTypes](pmd_rules_pom_basic.html#invaliddependencytypes): While Maven will not failed if you use an invalid type for a dependency in thedependency manageme...
-* [ProjectVersionAsDependencyVersion](pmd_rules_pom_basic.html#projectversionasdependencyversion): Using that expression in dependency declarations seems like a shortcut, but it can go wrong.By fa...
diff --git a/docs/pages/pmd/rules/pom/basic.md b/docs/pages/pmd/rules/pom/basic.md
deleted file mode 100644
index c00904d2de3..00000000000
--- a/docs/pages/pmd/rules/pom/basic.md
+++ /dev/null
@@ -1,76 +0,0 @@
----
-title: Basic POM
-summary: The Basic POM Ruleset contains a collection of good practices regarding Maven's POM files.
-permalink: pmd_rules_pom_basic.html
-folder: pmd/rules/pom
-sidebaractiveurl: /pmd_rules_pom.html
-editmepath: ../pmd-xml/src/main/resources/rulesets/pom/basic.xml
-keywords: Basic POM, ProjectVersionAsDependencyVersion, InvalidDependencyTypes
----
-## InvalidDependencyTypes
-
-**Since:** PMD 5.4
-
-**Priority:** Medium (3)
-
-While Maven will not failed if you use an invalid type for a dependency in the
-dependency management section, it will not also uses the dependency.
-
-```
-//dependencyManagement/dependency/type/text[not(contains('pom, jar, maven-plugin, ejb, war, ear, rar, par',@Image))]
-```
-
-**Example(s):**
-
-``` xml
-<project...>
- ...
- <dependencyManagement>
- ...
- <dependency>
- <groupId>org.jboss.arquillian</groupId>
- <artifactId>arquillian-bom</artifactId>
- <version>${arquillian.version}</version>
- <type>bom</type> <!-- not a valid type ! 'pom' is ! -->
- <scope>import</scope>
- </dependency>
- ...
- </dependencyManagement>
-</project>
-```
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/pom/basic.xml/InvalidDependencyTypes" />
-```
-
-## ProjectVersionAsDependencyVersion
-
-**Since:** PMD 5.4
-
-**Priority:** Medium (3)
-
-Using that expression in dependency declarations seems like a shortcut, but it can go wrong.
-By far the most common problem is the use of 6.0.0-SNAPSHOT in a BOM or parent POM.
-
-```
-//dependency/version/text[contains(@Image,'{project.version}')]
-```
-
-**Example(s):**
-
-``` xml
-<project...>
- ...
- <dependency>
- ...
- <version>${project.dependency}</version>
- </dependency>
-</project>
-```
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/pom/basic.xml/ProjectVersionAsDependencyVersion" />
-```
-
diff --git a/docs/pages/pmd/rules/pom/errorprone.md b/docs/pages/pmd/rules/pom/errorprone.md
new file mode 100644
index 00000000000..7dff1d6ec5e
--- /dev/null
+++ b/docs/pages/pmd/rules/pom/errorprone.md
@@ -0,0 +1,93 @@
+---
+title: Error Prone
+summary: Rules to detect constructs that are either broken, extremely confusing or prone to runtime errors.
+permalink: pmd_rules_pom_errorprone.html
+folder: pmd/rules/pom
+sidebaractiveurl: /pmd_rules_pom.html
+editmepath: ../pmd-xml/src/main/resources/category/pom/errorprone.xml
+keywords: Error Prone, InvalidDependencyTypes, ProjectVersionAsDependencyVersion
+language: Maven POM
+---
+## InvalidDependencyTypes
+
+**Since:** PMD 5.4
+
+**Priority:** Medium (3)
+
+If you use an invalid dependency type in the dependency management section, Maven doesn't fail. Instead,
+the entry is just ignored, which might have the effect, that the wrong version of the dependency is used.
+
+The following types are considered valid: pom, jar, maven-plugin, ejb, war, ear, rar, par.
+
+**This rule is defined by the following XPath expression:**
+``` xpath
+//dependencyManagement/dependency/type/text[not(@Image = $validTypes)]
+```
+
+**Example(s):**
+
+``` xml
+<project...>
+ ...
+ <dependencyManagement>
+ ...
+ <dependency>
+ <groupId>org.jboss.arquillian</groupId>
+ <artifactId>arquillian-bom</artifactId>
+ <version>${arquillian.version}</version>
+ <type>bom</type> <!-- not a valid type ! 'pom' is ! -->
+ <scope>import</scope>
+ </dependency>
+ ...
+ </dependencyManagement>
+</project>
+```
+
+**This rule has the following properties:**
+
+|Name|Default Value|Description|Multivalued|
+|----|-------------|-----------|-----------|
+|validTypes|pom , jar , maven-plugin , ejb , war , ear , rar , par|Set of valid types.|yes. Delimiter is ','.|
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/pom/errorprone.xml/InvalidDependencyTypes" />
+```
+
+## ProjectVersionAsDependencyVersion
+
+**Since:** PMD 5.4
+
+**Priority:** Medium (3)
+
+Using that expression in dependency declarations seems like a shortcut, but it can go wrong.
+By far the most common problem is the use of ${project.version} in a BOM or parent POM.
+
+**This rule is defined by the following XPath expression:**
+``` xpath
+//dependencies/dependency
+ [contains(version/text/@Image,'{project.version}')]
+ [
+ (/project/parent/groupId and groupId/text/@Image != /project/parent/groupId/text/@Image)
+ or
+ (/project/groupId and groupId/text/@Image != /project/groupId/text/@Image)
+ ]/version
+```
+
+**Example(s):**
+
+``` xml
+<project...>
+ ...
+ <dependency>
+ ...
+ <version>${project.dependency}</version>
+ </dependency>
+</project>
+```
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/pom/errorprone.xml/ProjectVersionAsDependencyVersion" />
+```
+
diff --git a/docs/pages/pmd/rules/vf.md b/docs/pages/pmd/rules/vf.md
index 95b6f091563..0e0ad6a889e 100644
--- a/docs/pages/pmd/rules/vf.md
+++ b/docs/pages/pmd/rules/vf.md
@@ -1,13 +1,26 @@
---
title: Salesforce VisualForce Rules
+tags: [rule_references, vf]
+summary: Index of all built-in rules available for Salesforce VisualForce
+language_name: Salesforce VisualForce
permalink: pmd_rules_vf.html
folder: pmd/rules
---
-List of rulesets and rules contained in each ruleset.
+## Security
-* [Basic VF](pmd_rules_vf_security.html): Rules concerning basic VF guidelines.
+{% include callout.html content="Rules that flag potential security flaws." %}
-## Basic VF
* [VfCsrf](pmd_rules_vf_security.html#vfcsrf): Avoid calling VF action upon page load as the action becomes vulnerable to CSRF.
* [VfUnescapeEl](pmd_rules_vf_security.html#vfunescapeel): Avoid unescaped user controlled content in EL as it results in XSS.
+## Additional rulesets
+
+* Basic VF (`rulesets/vf/security.xml`):
+
+ <span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> This ruleset is for backwards compatibility.
+
+ It contains the following rules:
+
+ [VfCsrf](pmd_rules_vf_security.html#vfcsrf), [VfUnescapeEl](pmd_rules_vf_security.html#vfunescapeel)
+
+
diff --git a/docs/pages/pmd/rules/vf/security.md b/docs/pages/pmd/rules/vf/security.md
index 1ed3b4febd2..28a4b5a6bfa 100644
--- a/docs/pages/pmd/rules/vf/security.md
+++ b/docs/pages/pmd/rules/vf/security.md
@@ -1,11 +1,12 @@
---
-title: Basic VF
-summary: Rules concerning basic VF guidelines.
+title: Security
+summary: Rules that flag potential security flaws.
permalink: pmd_rules_vf_security.html
folder: pmd/rules/vf
sidebaractiveurl: /pmd_rules_vf.html
-editmepath: ../pmd-visualforce/src/main/resources/rulesets/vf/security.xml
-keywords: Basic VF, VfUnescapeEl, VfCsrf
+editmepath: ../pmd-visualforce/src/main/resources/category/vf/security.xml
+keywords: Security, VfCsrf, VfUnescapeEl
+language: Salesforce VisualForce
---
## VfCsrf
@@ -25,7 +26,7 @@ Avoid calling VF action upon page load as the action becomes vulnerable to CSRF.
**Use this rule by referencing it:**
``` xml
-<rule ref="rulesets/vf/security.xml/VfCsrf" />
+<rule ref="category/vf/security.xml/VfCsrf" />
```
## VfUnescapeEl
@@ -46,6 +47,6 @@ Avoid unescaped user controlled content in EL as it results in XSS.
**Use this rule by referencing it:**
``` xml
-<rule ref="rulesets/vf/security.xml/VfUnescapeEl" />
+<rule ref="category/vf/security.xml/VfUnescapeEl" />
```
diff --git a/docs/pages/pmd/rules/vm.md b/docs/pages/pmd/rules/vm.md
index 88f95f9bee7..10be2fe45be 100644
--- a/docs/pages/pmd/rules/vm.md
+++ b/docs/pages/pmd/rules/vm.md
@@ -1,20 +1,43 @@
---
title: VM Rules
+tags: [rule_references, vm]
+summary: Index of all built-in rules available for VM
+language_name: VM
permalink: pmd_rules_vm.html
folder: pmd/rules
---
-List of rulesets and rules contained in each ruleset.
-
-* [Basic Velocity](pmd_rules_vm_basic.html): The Basic Velocity ruleset contains basic rules for Apache Velocity pages.
-
-## Basic Velocity
-* [AvoidDeeplyNestedIfStmts](pmd_rules_vm_basic.html#avoiddeeplynestedifstmts): Avoid creating deeply nested if-then statements since they are harder to read and error-prone to ...
-* [AvoidReassigningParameters](pmd_rules_vm_basic.html#avoidreassigningparameters): Reassigning values to incoming parameters is not recommended. Use temporary local variables inst...
-* [CollapsibleIfStatements](pmd_rules_vm_basic.html#collapsibleifstatements): Sometimes two consecutive 'if' statements can be consolidated by separating their conditions with...
-* [EmptyForeachStmt](pmd_rules_vm_basic.html#emptyforeachstmt): Empty foreach statements should be deleted.
-* [EmptyIfStmt](pmd_rules_vm_basic.html#emptyifstmt): Empty if statements should be deleted.
-* [ExcessiveTemplateLength](pmd_rules_vm_basic.html#excessivetemplatelength): The template is too long. It should be broken up into smaller pieces.
-* [NoInlineJavaScript](pmd_rules_vm_basic.html#noinlinejavascript): Avoid inline JavaScript. Import .js files instead.
-* [NoInlineStyles](pmd_rules_vm_basic.html#noinlinestyles): Avoid inline styles. Use css classes instead.
-* [UnusedMacroParameter](pmd_rules_vm_basic.html#unusedmacroparameter): Avoid unused macro parameters. They should be deleted.
+## Best Practices
+
+{% include callout.html content="Rules which enforce generally accepted best practices." %}
+
+* [AvoidReassigningParameters](pmd_rules_vm_bestpractices.html#avoidreassigningparameters): Reassigning values to incoming parameters is not recommended. Use temporary local variables inst...
+* [UnusedMacroParameter](pmd_rules_vm_bestpractices.html#unusedmacroparameter): Avoid unused macro parameters. They should be deleted.
+
+## Design
+
+{% include callout.html content="Rules that help you discover design issues." %}
+
+* [AvoidDeeplyNestedIfStmts](pmd_rules_vm_design.html#avoiddeeplynestedifstmts): Avoid creating deeply nested if-then statements since they are harder to read and error-prone to ...
+* [CollapsibleIfStatements](pmd_rules_vm_design.html#collapsibleifstatements): Sometimes two consecutive 'if' statements can be consolidated by separating their conditions with...
+* [ExcessiveTemplateLength](pmd_rules_vm_design.html#excessivetemplatelength): The template is too long. It should be broken up into smaller pieces.
+* [NoInlineJavaScript](pmd_rules_vm_design.html#noinlinejavascript): Avoid inline JavaScript. Import .js files instead.
+* [NoInlineStyles](pmd_rules_vm_design.html#noinlinestyles): Avoid inline styles. Use css classes instead.
+
+## Error Prone
+
+{% include callout.html content="Rules to detect constructs that are either broken, extremely confusing or prone to runtime errors." %}
+
+* [EmptyForeachStmt](pmd_rules_vm_errorprone.html#emptyforeachstmt): Empty foreach statements should be deleted.
+* [EmptyIfStmt](pmd_rules_vm_errorprone.html#emptyifstmt): Empty if statements should be deleted.
+
+## Additional rulesets
+
+* Basic Velocity (`rulesets/vm/basic.xml`):
+
+ <span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> This ruleset is for backwards compatibility.
+
+ It contains the following rules:
+
+ [AvoidDeeplyNestedIfStmts](pmd_rules_vm_design.html#avoiddeeplynestedifstmts), [AvoidReassigningParameters](pmd_rules_vm_bestpractices.html#avoidreassigningparameters), [CollapsibleIfStatements](pmd_rules_vm_design.html#collapsibleifstatements), [EmptyForeachStmt](pmd_rules_vm_errorprone.html#emptyforeachstmt), [EmptyIfStmt](pmd_rules_vm_errorprone.html#emptyifstmt), [ExcessiveTemplateLength](pmd_rules_vm_design.html#excessivetemplatelength), [NoInlineJavaScript](pmd_rules_vm_design.html#noinlinejavascript), [NoInlineStyles](pmd_rules_vm_design.html#noinlinestyles), [UnusedMacroParameter](pmd_rules_vm_bestpractices.html#unusedmacroparameter)
+
diff --git a/docs/pages/pmd/rules/vm/basic.md b/docs/pages/pmd/rules/vm/basic.md
deleted file mode 100644
index 2cdf621585e..00000000000
--- a/docs/pages/pmd/rules/vm/basic.md
+++ /dev/null
@@ -1,160 +0,0 @@
----
-title: Basic Velocity
-summary: The Basic Velocity ruleset contains basic rules for Apache Velocity pages.
-permalink: pmd_rules_vm_basic.html
-folder: pmd/rules/vm
-sidebaractiveurl: /pmd_rules_vm.html
-editmepath: ../pmd-vm/src/main/resources/rulesets/vm/basic.xml
-keywords: Basic Velocity, AvoidDeeplyNestedIfStmts, CollapsibleIfStatements, ExcessiveTemplateLength, AvoidReassigningParameters, EmptyIfStmt, EmptyForeachStmt, UnusedMacroParameter, NoInlineJavaScript, NoInlineStyles
----
-## AvoidDeeplyNestedIfStmts
-
-**Since:** PMD 5.1
-
-**Priority:** Medium (3)
-
-Avoid creating deeply nested if-then statements since they are harder to read and error-prone to maintain.
-
-**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.vm.rule.basic.AvoidDeeplyNestedIfStmtsRule](https://github.com/pmd/pmd/blob/master/pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/rule/basic/AvoidDeeplyNestedIfStmtsRule.java)
-
-**This rule has the following properties:**
-
-|Name|Default Value|Description|
-|----|-------------|-----------|
-|problemDepth|3|The if statement depth reporting threshold|
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/vm/basic.xml/AvoidDeeplyNestedIfStmts" />
-```
-
-## AvoidReassigningParameters
-
-**Since:** PMD 5.1
-
-**Priority:** Medium High (2)
-
-Reassigning values to incoming parameters is not recommended. Use temporary local variables instead.
-
-**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.vm.rule.basic.AvoidReassigningParametersRule](https://github.com/pmd/pmd/blob/master/pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/rule/basic/AvoidReassigningParametersRule.java)
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/vm/basic.xml/AvoidReassigningParameters" />
-```
-
-## CollapsibleIfStatements
-
-**Since:** PMD 5.1
-
-**Priority:** Medium (3)
-
-Sometimes two consecutive 'if' statements can be consolidated by separating their conditions with a boolean short-circuit operator.
-
-**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.vm.rule.basic.CollapsibleIfStatementsRule](https://github.com/pmd/pmd/blob/master/pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/rule/basic/CollapsibleIfStatementsRule.java)
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/vm/basic.xml/CollapsibleIfStatements" />
-```
-
-## EmptyForeachStmt
-
-**Since:** PMD 5.1
-
-**Priority:** Medium High (2)
-
-Empty foreach statements should be deleted.
-
-**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.vm.rule.basic.EmptyForeachStmtRule](https://github.com/pmd/pmd/blob/master/pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/rule/basic/EmptyForeachStmtRule.java)
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/vm/basic.xml/EmptyForeachStmt" />
-```
-
-## EmptyIfStmt
-
-**Since:** PMD 5.1
-
-**Priority:** Medium High (2)
-
-Empty if statements should be deleted.
-
-**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.vm.rule.basic.EmptyIfStmtRule](https://github.com/pmd/pmd/blob/master/pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/rule/basic/EmptyIfStmtRule.java)
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/vm/basic.xml/EmptyIfStmt" />
-```
-
-## ExcessiveTemplateLength
-
-**Since:** PMD 5.1
-
-**Priority:** Medium (3)
-
-The template is too long. It should be broken up into smaller pieces.
-
-**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.vm.rule.basic.ExcessiveTemplateLengthRule](https://github.com/pmd/pmd/blob/master/pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/rule/basic/ExcessiveTemplateLengthRule.java)
-
-**This rule has the following properties:**
-
-|Name|Default Value|Description|
-|----|-------------|-----------|
-|topscore||Top score value|
-|minimum||Minimum reporting threshold|
-|sigma||Sigma value|
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/vm/basic.xml/ExcessiveTemplateLength" />
-```
-
-## NoInlineJavaScript
-
-**Since:** PMD 5.1
-
-**Priority:** Medium High (2)
-
-Avoid inline JavaScript. Import .js files instead.
-
-**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.vm.rule.basic.NoInlineJavaScriptRule](https://github.com/pmd/pmd/blob/master/pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/rule/basic/NoInlineJavaScriptRule.java)
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/vm/basic.xml/NoInlineJavaScript" />
-```
-
-## NoInlineStyles
-
-**Since:** PMD 5.1
-
-**Priority:** Medium High (2)
-
-Avoid inline styles. Use css classes instead.
-
-```
-//Text[matches(@literal, "<[^>]+\s[sS][tT][yY][lL][eE]\s*=")]
-```
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/vm/basic.xml/NoInlineStyles" />
-```
-
-## UnusedMacroParameter
-
-**Since:** PMD 5.1
-
-**Priority:** Medium High (2)
-
-Avoid unused macro parameters. They should be deleted.
-
-**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.vm.rule.basic.UnusedMacroParameterRule](https://github.com/pmd/pmd/blob/master/pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/rule/basic/UnusedMacroParameterRule.java)
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/vm/basic.xml/UnusedMacroParameter" />
-```
-
diff --git a/docs/pages/pmd/rules/vm/bestpractices.md b/docs/pages/pmd/rules/vm/bestpractices.md
new file mode 100644
index 00000000000..6823e639a4e
--- /dev/null
+++ b/docs/pages/pmd/rules/vm/bestpractices.md
@@ -0,0 +1,40 @@
+---
+title: Best Practices
+summary: Rules which enforce generally accepted best practices.
+permalink: pmd_rules_vm_bestpractices.html
+folder: pmd/rules/vm
+sidebaractiveurl: /pmd_rules_vm.html
+editmepath: ../pmd-vm/src/main/resources/category/vm/bestpractices.xml
+keywords: Best Practices, AvoidReassigningParameters, UnusedMacroParameter
+language: VM
+---
+## AvoidReassigningParameters
+
+**Since:** PMD 5.1
+
+**Priority:** Medium High (2)
+
+Reassigning values to incoming parameters is not recommended. Use temporary local variables instead.
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.vm.rule.bestpractices.AvoidReassigningParametersRule](https://github.com/pmd/pmd/blob/master/pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/rule/bestpractices/AvoidReassigningParametersRule.java)
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/vm/bestpractices.xml/AvoidReassigningParameters" />
+```
+
+## UnusedMacroParameter
+
+**Since:** PMD 5.1
+
+**Priority:** Medium High (2)
+
+Avoid unused macro parameters. They should be deleted.
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.vm.rule.bestpractices.UnusedMacroParameterRule](https://github.com/pmd/pmd/blob/master/pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/rule/bestpractices/UnusedMacroParameterRule.java)
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/vm/bestpractices.xml/UnusedMacroParameter" />
+```
+
diff --git a/docs/pages/pmd/rules/vm/design.md b/docs/pages/pmd/rules/vm/design.md
new file mode 100644
index 00000000000..089de4f9267
--- /dev/null
+++ b/docs/pages/pmd/rules/vm/design.md
@@ -0,0 +1,102 @@
+---
+title: Design
+summary: Rules that help you discover design issues.
+permalink: pmd_rules_vm_design.html
+folder: pmd/rules/vm
+sidebaractiveurl: /pmd_rules_vm.html
+editmepath: ../pmd-vm/src/main/resources/category/vm/design.xml
+keywords: Design, AvoidDeeplyNestedIfStmts, CollapsibleIfStatements, ExcessiveTemplateLength, NoInlineJavaScript, NoInlineStyles
+language: VM
+---
+## AvoidDeeplyNestedIfStmts
+
+**Since:** PMD 5.1
+
+**Priority:** Medium (3)
+
+Avoid creating deeply nested if-then statements since they are harder to read and error-prone to maintain.
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.vm.rule.design.AvoidDeeplyNestedIfStmtsRule](https://github.com/pmd/pmd/blob/master/pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/rule/design/AvoidDeeplyNestedIfStmtsRule.java)
+
+**This rule has the following properties:**
+
+|Name|Default Value|Description|Multivalued|
+|----|-------------|-----------|-----------|
+|problemDepth|3|The if statement depth reporting threshold|no|
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/vm/design.xml/AvoidDeeplyNestedIfStmts" />
+```
+
+## CollapsibleIfStatements
+
+**Since:** PMD 5.1
+
+**Priority:** Medium (3)
+
+Sometimes two consecutive 'if' statements can be consolidated by separating their conditions with a boolean short-circuit operator.
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.vm.rule.design.CollapsibleIfStatementsRule](https://github.com/pmd/pmd/blob/master/pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/rule/design/CollapsibleIfStatementsRule.java)
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/vm/design.xml/CollapsibleIfStatements" />
+```
+
+## ExcessiveTemplateLength
+
+**Since:** PMD 5.1
+
+**Priority:** Medium (3)
+
+The template is too long. It should be broken up into smaller pieces.
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.vm.rule.design.ExcessiveTemplateLengthRule](https://github.com/pmd/pmd/blob/master/pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/rule/design/ExcessiveTemplateLengthRule.java)
+
+**This rule has the following properties:**
+
+|Name|Default Value|Description|Multivalued|
+|----|-------------|-----------|-----------|
+|topscore||Top score value|no|
+|minimum||Minimum reporting threshold|no|
+|sigma||Sigma value|no|
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/vm/design.xml/ExcessiveTemplateLength" />
+```
+
+## NoInlineJavaScript
+
+**Since:** PMD 5.1
+
+**Priority:** Medium High (2)
+
+Avoid inline JavaScript. Import .js files instead.
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.vm.rule.design.NoInlineJavaScriptRule](https://github.com/pmd/pmd/blob/master/pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/rule/design/NoInlineJavaScriptRule.java)
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/vm/design.xml/NoInlineJavaScript" />
+```
+
+## NoInlineStyles
+
+**Since:** PMD 5.1
+
+**Priority:** Medium High (2)
+
+Avoid inline styles. Use css classes instead.
+
+**This rule is defined by the following XPath expression:**
+``` xpath
+//Text[matches(@literal, "<[^>]+\s[sS][tT][yY][lL][eE]\s*=")]
+```
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/vm/design.xml/NoInlineStyles" />
+```
+
diff --git a/docs/pages/pmd/rules/vm/errorprone.md b/docs/pages/pmd/rules/vm/errorprone.md
new file mode 100644
index 00000000000..8fdce71143e
--- /dev/null
+++ b/docs/pages/pmd/rules/vm/errorprone.md
@@ -0,0 +1,40 @@
+---
+title: Error Prone
+summary: Rules to detect constructs that are either broken, extremely confusing or prone to runtime errors.
+permalink: pmd_rules_vm_errorprone.html
+folder: pmd/rules/vm
+sidebaractiveurl: /pmd_rules_vm.html
+editmepath: ../pmd-vm/src/main/resources/category/vm/errorprone.xml
+keywords: Error Prone, EmptyForeachStmt, EmptyIfStmt
+language: VM
+---
+## EmptyForeachStmt
+
+**Since:** PMD 5.1
+
+**Priority:** Medium High (2)
+
+Empty foreach statements should be deleted.
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.vm.rule.errorprone.EmptyForeachStmtRule](https://github.com/pmd/pmd/blob/master/pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/rule/errorprone/EmptyForeachStmtRule.java)
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/vm/errorprone.xml/EmptyForeachStmt" />
+```
+
+## EmptyIfStmt
+
+**Since:** PMD 5.1
+
+**Priority:** Medium High (2)
+
+Empty if statements should be deleted.
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.vm.rule.errorprone.EmptyIfStmtRule](https://github.com/pmd/pmd/blob/master/pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/rule/errorprone/EmptyIfStmtRule.java)
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/vm/errorprone.xml/EmptyIfStmt" />
+```
+
diff --git a/docs/pages/pmd/rules/xml.md b/docs/pages/pmd/rules/xml.md
index 104b0bbf0c1..4c3ca2ec0a9 100644
--- a/docs/pages/pmd/rules/xml.md
+++ b/docs/pages/pmd/rules/xml.md
@@ -1,12 +1,25 @@
---
title: XML Rules
+tags: [rule_references, xml]
+summary: Index of all built-in rules available for XML
+language_name: XML
permalink: pmd_rules_xml.html
folder: pmd/rules
---
-List of rulesets and rules contained in each ruleset.
+## Error Prone
-* [Basic XML](pmd_rules_xml_basic.html): The Basic XML Ruleset contains a collection of good practices which everyone should follow.
+{% include callout.html content="Rules to detect constructs that are either broken, extremely confusing or prone to runtime errors." %}
+
+* [MistypedCDATASection](pmd_rules_xml_errorprone.html#mistypedcdatasection): An XML CDATA section begins with a <!CDATA[ marker, which has only one [, and ends with a ]]> mar...
+
+## Additional rulesets
+
+* Basic XML (`rulesets/xml/basic.xml`):
+
+ <span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> This ruleset is for backwards compatibility.
+
+ It contains the following rules:
+
+ [MistypedCDATASection](pmd_rules_xml_errorprone.html#mistypedcdatasection)
-## Basic XML
-* [MistypedCDATASection](pmd_rules_xml_basic.html#mistypedcdatasection): An XML CDATA section begins with a <!CDATA[ marker, which has only one [, and ends with a ]]> mar...
diff --git a/docs/pages/pmd/rules/xml/basic.md b/docs/pages/pmd/rules/xml/basic.md
deleted file mode 100644
index f1537675594..00000000000
--- a/docs/pages/pmd/rules/xml/basic.md
+++ /dev/null
@@ -1,32 +0,0 @@
----
-title: Basic XML
-summary: The Basic XML Ruleset contains a collection of good practices which everyone should follow.
-permalink: pmd_rules_xml_basic.html
-folder: pmd/rules/xml
-sidebaractiveurl: /pmd_rules_xml.html
-editmepath: ../pmd-xml/src/main/resources/rulesets/xml/basic.xml
-keywords: Basic XML, MistypedCDATASection
----
-## MistypedCDATASection
-
-**Since:** PMD 5.0
-
-**Priority:** Medium (3)
-
-An XML CDATA section begins with a <!CDATA[ marker, which has only one [, and ends with a ]]> marker, which has only two ].
-
-```
-//cdata-section[starts-with(@Image,'[') or ends-with(@Image,']')]
-```
-
-**Example(s):**
-
-``` xml
-An extra [ looks like <!CDATA[[]]>, and an extra ] looks like <!CDATA[]]]>.
-```
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/xml/basic.xml/MistypedCDATASection" />
-```
-
diff --git a/docs/pages/pmd/rules/xml/errorprone.md b/docs/pages/pmd/rules/xml/errorprone.md
new file mode 100644
index 00000000000..01e61d95392
--- /dev/null
+++ b/docs/pages/pmd/rules/xml/errorprone.md
@@ -0,0 +1,34 @@
+---
+title: Error Prone
+summary: Rules to detect constructs that are either broken, extremely confusing or prone to runtime errors.
+permalink: pmd_rules_xml_errorprone.html
+folder: pmd/rules/xml
+sidebaractiveurl: /pmd_rules_xml.html
+editmepath: ../pmd-xml/src/main/resources/category/xml/errorprone.xml
+keywords: Error Prone, MistypedCDATASection
+language: XML
+---
+## MistypedCDATASection
+
+**Since:** PMD 5.0
+
+**Priority:** Medium (3)
+
+An XML CDATA section begins with a <!CDATA[ marker, which has only one [, and ends with a ]]> marker, which has only two ].
+
+**This rule is defined by the following XPath expression:**
+``` xpath
+//cdata-section[starts-with(@Image,'[') or ends-with(@Image,']')]
+```
+
+**Example(s):**
+
+``` xml
+An extra [ looks like <!CDATA[[]]>, and an extra ] looks like <!CDATA[]]]>.
+```
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/xml/errorprone.xml/MistypedCDATASection" />
+```
+
diff --git a/docs/pages/pmd/rules/xsl.md b/docs/pages/pmd/rules/xsl.md
index ebd281d09b4..ffaf5e0b2d5 100644
--- a/docs/pages/pmd/rules/xsl.md
+++ b/docs/pages/pmd/rules/xsl.md
@@ -1,13 +1,31 @@
---
title: XSL Rules
+tags: [rule_references, xsl]
+summary: Index of all built-in rules available for XSL
+language_name: XSL
permalink: pmd_rules_xsl.html
folder: pmd/rules
---
-List of rulesets and rules contained in each ruleset.
+## Code Style
-* [XPath in XSL](pmd_rules_xsl_xpath.html): This ruleset regroups a collection of good practices regarding XPath querying and functions inside an XSL.
+{% include callout.html content="Rules which enforce a specific coding style." %}
+
+* [UseConcatOnce](pmd_rules_xsl_codestyle.html#useconcatonce): The XPath concat() functions accepts as many arguments as required so you can have"concat($a,'b',...
+
+## Performance
+
+{% include callout.html content="Rules that flag suboptimal code." %}
+
+* [AvoidAxisNavigation](pmd_rules_xsl_performance.html#avoidaxisnavigation): Avoid using the 'following' or 'preceeding' axes whenever possible, as these can cutthrough 100% ...
+
+## Additional rulesets
+
+* XPath in XSL (`rulesets/xsl/xpath.xml`):
+
+ <span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> This ruleset is for backwards compatibility.
+
+ It contains the following rules:
+
+ [AvoidAxisNavigation](pmd_rules_xsl_performance.html#avoidaxisnavigation), [UseConcatOnce](pmd_rules_xsl_codestyle.html#useconcatonce)
-## XPath in XSL
-* [AvoidAxisNavigation](pmd_rules_xsl_xpath.html#avoidaxisnavigation): Avoid using the 'following' or 'preceeding' axes whenever possible, as these can cutthrough 100% ...
-* [UseConcatOnce](pmd_rules_xsl_xpath.html#useconcatonce): The XPath concat() functions accepts as many arguments as required so you can have"concat($a,'b',...
diff --git a/docs/pages/pmd/rules/xsl/codestyle.md b/docs/pages/pmd/rules/xsl/codestyle.md
new file mode 100644
index 00000000000..8e66e2fabf1
--- /dev/null
+++ b/docs/pages/pmd/rules/xsl/codestyle.md
@@ -0,0 +1,36 @@
+---
+title: Code Style
+summary: Rules which enforce a specific coding style.
+permalink: pmd_rules_xsl_codestyle.html
+folder: pmd/rules/xsl
+sidebaractiveurl: /pmd_rules_xsl.html
+editmepath: ../pmd-xml/src/main/resources/category/xsl/codestyle.xml
+keywords: Code Style, UseConcatOnce
+language: XSL
+---
+## UseConcatOnce
+
+**Since:** PMD 5.0
+
+**Priority:** Medium (3)
+
+The XPath concat() functions accepts as many arguments as required so you can have
+"concat($a,'b',$c)" rather than "concat($a,concat('b',$c)".
+
+**This rule is defined by the following XPath expression:**
+``` xpath
+//node()[contains(substring-after(@select,'concat'),'concat')]
+```
+
+**Example(s):**
+
+``` xsl
+<xsl:variable name="var" select="concat("Welcome",concat("to you ",$name))"/>
+<xsl:variable name="var" select="concat("Welcome","to you ",$name))">
+```
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/xsl/codestyle.xml/UseConcatOnce" />
+```
+
diff --git a/docs/pages/pmd/rules/xsl/performance.md b/docs/pages/pmd/rules/xsl/performance.md
new file mode 100644
index 00000000000..24adc757e8c
--- /dev/null
+++ b/docs/pages/pmd/rules/xsl/performance.md
@@ -0,0 +1,56 @@
+---
+title: Performance
+summary: Rules that flag suboptimal code.
+permalink: pmd_rules_xsl_performance.html
+folder: pmd/rules/xsl
+sidebaractiveurl: /pmd_rules_xsl.html
+editmepath: ../pmd-xml/src/main/resources/category/xsl/performance.xml
+keywords: Performance, AvoidAxisNavigation
+language: XSL
+---
+## AvoidAxisNavigation
+
+**Since:** PMD 5.0
+
+**Priority:** Medium (3)
+
+Avoid using the 'following' or 'preceeding' axes whenever possible, as these can cut
+through 100% of the document in the worst case. Also, try to avoid using 'descendant'
+or 'descendant-self' axes, as if you're at the top of the Document, it necessarily means
+cutting through 100% of the document.
+
+**This rule is defined by the following XPath expression:**
+``` xpath
+//node()[
+ contains(@select,'preceeding::')
+ or
+ contains(@select,'following::')
+ or
+ contains(@select,'descendant::')
+ or
+ contains(@select,'descendant-self::')
+ or (
+ ($checkSelfDescendantAbreviation = 'true' )
+ and
+ contains(@select,'//')
+ )
+]
+```
+
+**Example(s):**
+
+``` xsl
+<xsl:variable name="var" select="//item/descendant::child"/>
+```
+
+**This rule has the following properties:**
+
+|Name|Default Value|Description|Multivalued|
+|----|-------------|-----------|-----------|
+|checkSelfDescendantAbreviation|false|descendant::self abreviation, '//', will also trigger this rule.|no|
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/xsl/performance.xml/AvoidAxisNavigation" />
+```
+
diff --git a/docs/pages/pmd/rules/xsl/xpath.md b/docs/pages/pmd/rules/xsl/xpath.md
deleted file mode 100644
index eda6752a0ea..00000000000
--- a/docs/pages/pmd/rules/xsl/xpath.md
+++ /dev/null
@@ -1,79 +0,0 @@
----
-title: XPath in XSL
-summary: This ruleset regroups a collection of good practices regarding XPath querying and functions inside an XSL.
-permalink: pmd_rules_xsl_xpath.html
-folder: pmd/rules/xsl
-sidebaractiveurl: /pmd_rules_xsl.html
-editmepath: ../pmd-xml/src/main/resources/rulesets/xsl/xpath.xml
-keywords: XPath in XSL, UseConcatOnce, AvoidAxisNavigation
----
-## AvoidAxisNavigation
-
-**Since:** PMD 5.0
-
-**Priority:** Medium (3)
-
-Avoid using the 'following' or 'preceeding' axes whenever possible, as these can cut
-through 100% of the document in the worst case. Also, try to avoid using 'descendant'
-or 'descendant-self' axes, as if you're at the top of the Document, it necessarily means
-cutting through 100% of the document.
-
-```
-//node()[
- contains(@select,'preceeding::')
- or
- contains(@select,'following::')
- or
- contains(@select,'descendant::')
- or
- contains(@select,'descendant-self::')
- or (
- ($checkSelfDescendantAbreviation = 'true' )
- and
- contains(@select,'//')
- )
-]
-```
-
-**Example(s):**
-
-``` xsl
-<xsl:variable name="var" select="//item/descendant::child"/>
-```
-
-**This rule has the following properties:**
-
-|Name|Default Value|Description|
-|----|-------------|-----------|
-|checkSelfDescendantAbreviation|false|descendant::self abreviation, '//', will also trigger this rule.|
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/xsl/xpath.xml/AvoidAxisNavigation" />
-```
-
-## UseConcatOnce
-
-**Since:** PMD 5.0
-
-**Priority:** Medium (3)
-
-The XPath concat() functions accepts as many arguments as required so you can have
-"concat($a,'b',$c)" rather than "concat($a,concat('b',$c)".
-
-```
-//node()[contains(substring-after(@select,'concat'),'concat')]
-```
-
-**Example(s):**
-
-``` xsl
-<xsl:variable name="var" select="concat("Welcome",concat("to you ",$name))"/>
-<xsl:variable name="var" select="concat("Welcome","to you ",$name))">
-```
-
-**Use this rule by referencing it:**
-``` xml
-<rule ref="rulesets/xsl/xpath.xml/UseConcatOnce" />
-```
-
diff --git a/docs/pages/pmd/userdocs/best_practices.md b/docs/pages/pmd/userdocs/best_practices.md
index 6e59d9391ac..5c6aad01586 100644
--- a/docs/pages/pmd/userdocs/best_practices.md
+++ b/docs/pages/pmd/userdocs/best_practices.md
@@ -1,24 +1,32 @@
---
title: Best Practices
+tags: [userdocs]
permalink: pmd_userdocs_best_practices.html
author: Tom Copeland <tom@infoether.com>
+last_updated: November 2017
---
## Choose the rules that are right for you
-Running every ruleset will result in a huge number of rule violations, most of which will be unimportant.
+Running every existing rule will result in a huge number of rule violations, most of which will be unimportant.
Having to sort through a thousand line report to find the few you're really interested in takes
all the fun out of things.
-Instead, start with some of the obvious rulesets - just run [unusedcode](/pmd_rules_java.html#unused-code) and fix any unused locals and fields.
-Then, run [empty](/pmd_rules_java.html#empty-code) and fix all the empty `if` statements and such-like. After that, take [unnecessary](/pmd_rules_java.html#unnecessary)
-and fix these violations. Then, run [basic](/pmd_rules_java.html#basic) and fix the remaining violations.
-Then peruse the [design](/pmd_rules_java.html#design) and [controversial](/pmd_rules_java.html#controversial) rulesets and use the ones
-you like [via a custom ruleset](/pmd_userdocs_understanding_rulesets.html).
+Instead, start with some selected specific rules, e.g. the rules that detect unused code from
+the category [Best Practices](pmd_rules_java_bestpractices.html) and fix any unused locals and fields.
+
+Then, run rules, that detect empty `if` statements and such-like. You can find these rules in the category
+[Error Prone](pmd_rules_java_errorprone.html).
+
+After that, look at all the categories and select the rules, that are useful for your project.
+You can find an overview of the rules on the [Rule Index](pmd_rules_java.html).
+
+Use the rules you like [via a custom ruleset](pmd_userdocs_understanding_rulesets.html).
## PMD rules are not set in stone
-Generally, pick the ones you like, and ignore or [suppress](/pmd_userdocs_suppressing.html) the warnings you don't like. It's just a tool.
+Generally, pick the ones you like, and ignore or [suppress](pmd_userdocs_suppressing.html)
+the warnings you don't like. It's just a tool.
## PMD IDE plugins are nice
diff --git a/docs/pages/pmd/userdocs/cli_reference.md b/docs/pages/pmd/userdocs/cli_reference.md
new file mode 100644
index 00000000000..3a6b2df8e22
--- /dev/null
+++ b/docs/pages/pmd/userdocs/cli_reference.md
@@ -0,0 +1,252 @@
+---
+title: PMD CLI reference
+summary: "Full reference for PMD's command-line interface, including options, output formats and supported languages"
+tags: [userdocs]
+keywords: [command, line, options, help, formats, renderers]
+permalink: pmd_userdocs_cli_reference.html
+author: Tom Copeland <tom@infoether.com>, Xavier Le Vourch <xlv@users.sourceforge.net>, Juan MartÃn Sotuyo Dodero <juansotuyo@gmail.com>
+---
+
+
+## Options
+
+The tool comes with a rather extensive help text, simply running with `-help`!
+
+<table>
+ <tr>
+ <th>Option</th>
+ <th>Description</th>
+ <th>Default value</th>
+ <th>Applies to</th>
+ </tr>
+
+ {% include custom/cli_option_row.html options="-rulesets,-R"
+ option_arg="refs"
+ description="Comma-separated list of ruleset or rule references."
+ required="yes"
+ %}
+ {% include custom/cli_option_row.html options="-dir,-d"
+ option_arg="path"
+ description="Root directory for the analyzed sources."
+ required="yes"
+ %}
+ {% include custom/cli_option_row.html options="-format,-f"
+ option_arg="format"
+ description="Output format of the analysis report. The available formats
+ are described [here](#available-report-formats)."
+ default="text"
+ %}
+ <tr><td/><td/><td/><td/></tr>
+ {% include custom/cli_option_row.html options="-auxclasspath"
+ option_arg="cp"
+ description="Specifies the classpath for libraries used by the source code.
+ This is used to resolve types in source files. Alternatively, a `file://` URL
+ to a text file containing path elements on consecutive lines can be specified."
+ languages="Java"
+ %}
+ {% include custom/cli_option_row.html options="-benchmark,-b"
+ description="Enables benchmark mode, which outputs a benchmark report upon completion.
+ The report is sent to standard error."
+ default="false"
+ %}
+ {% include custom/cli_option_row.html options="-cache"
+ option_arg="filepath"
+ description="Specify the location of the cache file for incremental analysis.
+ This should be the full path to the file, including the desired file name (not just the parent directory).
+ If the file doesn't exist, it will be created on the first run. The file will be overwritten on each run
+ with the most up-to-date rule violations.
+ This can greatly improve analysis performance and is **highly recommended**."
+ %}
+ {% include custom/cli_option_row.html options="-debug,-verbose,-D,-V"
+ description="Debug mode. Prints more log output."
+ default="false"
+ %}
+ {% include custom/cli_option_row.html options="-encoding,-e"
+ option_arg="charset"
+ description="Specifies the character set encoding of the source code files PMD is reading.
+ The valid values are the standard character sets of `java.nio.charset.Charset`."
+ default="UTF-8"
+ %}
+ {% include custom/cli_option_row.html options="-failOnViolation,--failOnViolation"
+ option_arg="bool"
+ description="Specifies whether PMD exits with non-zero status if violations are found.
+ By default PMD exits with status 4 if violations are found.
+ Disable this feature with `-failOnViolation false` to exit with 0 instead and just output the report."
+ default="true"
+ %}
+ {% include custom/cli_option_row.html options="-filelist"
+ option_arg="filepath"
+ description="Path to file containing a comma delimited list of files to analyze.
+ If this is given, then you don't need to provide `-dir`."
+ %}
+ {% include custom/cli_option_row.html options="-ignorelist"
+ option_arg="filepath"
+ description="Path to file containing a comma delimited list of files to ignore.
+ This option can be combined with `-dir` and `-filelist`.
+ This ignore list takes precedence over any files in the filelist."
+ %}
+ {% include custom/cli_option_row.html options="-help,-h,-H"
+ description="Display help on usage."
+ default="false"
+ %}
+ {% include custom/cli_option_row.html options="-language,-l"
+ option_arg="lang"
+ description="Specify the language PMD should use."
+ %}
+ {% include custom/cli_option_row.html options="-minimumpriority,-min"
+ option_arg="num"
+ description="Rule priority threshold; rules with lower priority than configured here won't be used."
+ default="5"
+ %}
+ {% include custom/cli_option_row.html options="-norulesetcompatibility"
+ description='Disables the ruleset compatibility filter. The filter is active by default and tries to automatically "fix" old ruleset files with old rule names'
+ default="false"
+ %}
+ {% include custom/cli_option_row.html options="-no-cache"
+ description="Explicitly disables incremental analysis. This switch turns off suggestions to use Incremental Analysis,
+ and causes the `-cache` option to be discarded if it is provided."
+ default="false"
+ %}
+ {% include custom/cli_option_row.html options="-property,-P"
+ option_arg="name>=<value"
+ description="Specifies a property for the report renderer. The option can be specified several times."
+ default="[]"
+ %}
+ {% include custom/cli_option_row.html options="-reportfile,-r"
+ option_arg="path"
+ description="Path to a file in which the report output will be sent. By default the report is printed on standard output."
+ %}
+ {% include custom/cli_option_row.html options="-shortnames"
+ description="Prints shortened filenames in the report."
+ default="false"
+ %}
+ {% include custom/cli_option_row.html options="-showsuppressed"
+ description="Causes the suppressed rule violations to be added to the report."
+ default="false"
+ %}
+ {% include custom/cli_option_row.html options="-stress,-S"
+ description="Performs a stress test."
+ default="false"
+ %}
+ {% include custom/cli_option_row.html options="-suppressmarker"
+ option_arg="marker"
+ description="Specifies the comment token that marks lines which PMD should ignore."
+ default="NOPMD"
+ %}
+ {% include custom/cli_option_row.html options="-threads,-t"
+ option_arg="num"
+ description="Sets the number of threads used by PMD.
+ Set threads to `0` to disable multi-threading processing."
+ default="1"
+ %}
+ {% include custom/cli_option_row.html options="-uri,-u"
+ option_arg="uri"
+ description="Database URI for sources. If this is given, then you don't need to provide `-dir`."
+ languages="PLSQL"
+ %}
+ {% include custom/cli_option_row.html options="-version,-v"
+ option_arg="version"
+ description="Specify the version of a language PMD should use."
+ %}
+</table>
+
+## Exit Status
+
+Please note that if PMD detects any violations, it will exit with status 4 (since 5.3).
+This behavior has been introduced to ease PMD integration into scripts or hooks, such as SVN hooks.
+
+<table>
+<tr><td>0</td><td>Everything is fine, no violations found</td></tr>
+<tr><td>1</td><td>Couldn't understand command-line parameters or PMD exited with an exception</td></tr>
+<tr><td>4</td><td>At least one violation has been detected, unless <code>-failOnViolation false</code> is set.</td></tr>
+</table>
+
+
+## Supported Languages
+
+* [apex](pmd_rules_apex.html) (Salesforce Apex)
+* [java](pmd_rules_java.html)
+* [ecmascript](pmd_rules_javascript.html) (JavaScript)
+* [jsp](pmd_rules_jsp.html)
+* [plsql](pmd_rules_plsql.html)
+* [vf](pmd_rules_vf.html) (Salesforce VisualForce)
+* [vm](pmd_rules_vm.html) (Apache Velocity)
+* [xml and xsl](/pmd_rules_xml.html)
+
+
+## Available Report Formats
+
+PMD comes with many different renderers.
+The mnemonics in bold are used to select them on the command line, as
+arguments to the `-format` option. Some formats accept *properties*,
+which can be specified with the `-property` option on the command-line.
+
+* **codeclimate**: Renderer for Code Climate JSON format.
+
+* **csv**: Comma-separated values tabular format.
+
+ Properties:
+
+ * problem: Include problem column. Default: true.
+ * package: Include package column. Default: true.
+ * file: Include file column. Default: true.
+ * priority: Include priority column. Default: true.
+ * line: Include line column. Default: true.
+ * desc: Include description column. Default: true.
+ * ruleSet: Include Rule set column. Default: true.
+ * rule: Include Rule column. Default: true.
+
+* **emacs**: GNU Emacs integration.
+
+* **html**: HTML format.
+
+ Properties:
+
+ * linePrefix: Prefix for line number anchor in the source file.
+ * linkPrefix: Path to HTML source.
+
+* **ideaj**: IntelliJ IDEA integration.
+
+ Properties:
+
+ * classAndMethodName: Class and method name, pass `.method` when processing a directory.
+ * sourcePath:
+ * fileName:
+
+* **summaryhtml**: Summary HTML format.
+
+ Properties:
+
+ * linePrefix: Prefix for line number anchor in the source file.
+ * linkPrefix: Path to HTML source.
+
+* **text**: Text format.
+
+* **textcolor**: Text format, with color support (requires ANSI console support, e.g. xterm, rxvt, etc.).
+
+ Properties:
+
+ * color: Enables colors with anything other than `false` or `0`. Default: yes.
+
+* **textpad**: TextPad integration.
+
+* **vbhtml**: Vladimir Bossicard HTML format.
+
+* **xml**: XML format.
+
+ Properties:
+
+ * encoding: XML encoding format, defaults to UTF-8.
+
+* **xslt**: XML with a XSL transformation applied.
+
+ Properties:
+
+ * encoding: XML encoding format, defaults to UTF-8.
+ * xsltFilename: The XSLT file name.
+
+* **yahtml**: Yet Another HTML format.
+
+ Properties:
+
+ * outputDir: Output directory.
diff --git a/docs/pages/pmd/userdocs/configuring_rules.md b/docs/pages/pmd/userdocs/configuring_rules.md
new file mode 100644
index 00000000000..8db986cf1cf
--- /dev/null
+++ b/docs/pages/pmd/userdocs/configuring_rules.md
@@ -0,0 +1,65 @@
+---
+title: Configuring rules
+short_title: Configuring rules
+keywords: [property, properties, message, priority]
+tags: [userdocs, getting_started]
+summary: "Learn how to configure your rules directly from the ruleset XML."
+last_updated: May 2018 (6.4.0)
+permalink: pmd_userdocs_configuring_rules.html
+author: Hooper Bloob <hooperbloob@users.sourceforge.net>, Romain Pelisse <rpelisse@users.sourceforge.net>, Clément Fournier <clement.fournier76@gmail.com>
+---
+
+## Message and priority overriding
+
+You can change a rule's **message** by specifying a `message`
+attribute on the rule element. This will override the previous
+value and change the message the rule will print on the report.
+
+Similarly, the **priority** of a rule can be changed via a nested
+element. Using priority, you can deactivate some rules based on a
+minimum priority threshold (set using the `-min` CLI option).
+Priority is an integer ranging from 1 to 5, with 1 being the highest
+priority.
+
+
+Putting things together, the following rule reference lowers the priority
+of EmptyCatchBlock to 5, such that e.g. using the `-min 4` CLI parameters
+will cause the rule to be ignored.
+
+```xml
+<rule ref="category/java/errorprone.xml/EmptyCatchBlock"
+ message="Empty catch blocks should be avoided" >
+ <priority>5</priority>
+</rule>
+```
+
+
+## Rule properties
+
+Properties make it easy to customise the behaviour of a rule directly from the xml. They come in several types, which correspond to the type of their values. For example, NPathComplexity declares a property "reportLevel", with an integer value type, and which corresponds to the threshold above which a method will be reported. If you believe that its default value of 200 is too high, you could lower it to e.g. 150 in the following way:
+
+```xml
+<rule ref="category/java/design.xml/NPathComplexity">
+ <properties>
+ <property name="reportLevel">150</property>
+ </properties>
+</rule>
+```
+
+Properties are assigned a value with a `property` element, which should mention the name of a property as an attribute. The value of the property can be specified either in the content of the element, like above, or in the `value` attribute, e.g.
+
+```xml
+<property name="reportLevel" value="150"/>
+```
+
+All property assignements must be enclosed in a `properties` element, which is itself inside a `rule` element.
+
+{%include tip.html content="The properties of a rule are documented with the rule, e.g. [here](pmd_rules_java_design.html#npathcomplexity) for NPathComplexity. Note that **assigning a value to a property that does not exist throws an error!**" %}
+
+Some properties take multiple values (a list), in which case you can provide them all by delimiting them with a delimiter character. It is usually a pipe ('\|'), or a comma (',') for numeric properties, e.g.
+```xml
+ <property name="legalCollectionTypes"
+ value="java.util.ArrayList|java.util.Vector|java.util.HashMap"/>
+```
+
+These properties are referred to as **multivalued properties** in this documentation.
diff --git a/docs/pages/pmd/userdocs/cpd.md b/docs/pages/pmd/userdocs/cpd.md
index e75b3e42721..41ed9e6bb8d 100644
--- a/docs/pages/pmd/userdocs/cpd.md
+++ b/docs/pages/pmd/userdocs/cpd.md
@@ -1,6 +1,7 @@
---
-title: Finding duplicated code
-summary: Or how to find copied and pasted code
+title: Finding duplicated code with CPD
+tags: [cpd, userdocs]
+summary: "Learn how to use CPD, the copy-paste detector shipped with PMD."
permalink: pmd_userdocs_cpd.html
author: Tom Copeland <tom@infoether.com>
---
@@ -8,178 +9,137 @@ author: Tom Copeland <tom@infoether.com>
## Overview
Duplicate code can be hard to find, especially in a large project.
-But PMD's Copy/Paste Detector (CPD) can find it for you!
-CPD has been through three major incarnations:
+But PMD's **Copy/Paste Detector (CPD)** can find it for you!
-* First we wrote it using a variant of Michael Wise's Greedy String Tiling algorithm (our variant is described
- [here](http://www.onjava.com/pub/a/onjava/2003/03/12/pmd_cpd.html)).
-
-* Then it was completely rewritten by Brian Ewins using the
- [Burrows-Wheeler transform](http://dogma.net/markn/articles/bwt/bwt.htm).
-
-* Finally, it was rewritten by Steve Hawkins to use the
- [Karp-Rabin](http://www.nist.gov/dads/HTML/karpRabin.html) string matching algorithm.
+CPD works with Java, JSP, C, C++, C#, Fortran and PHP code and [some more languages](#supported-languages).
+It can be used via [command-line](#cli-usage), or via an [Ant task](#ant-task).
+It can also be run with Maven by using the `cpd-check` goal on the [Maven PMD Plugin](pmd_userdocs_tools_maven.html).
-Each rewrite made it much faster, and now it can process the JDK 1.4 java.* packages in about 4 seconds
-(on my workstation, at least).
-
-Note that CPD works with Java, JSP, C, C++, C#, Fortran and PHP code and some more languages. For the
-full list, see below [Supported Languages](#supported-languages).
Your own language is missing?
See how to add it [here](/pmd_devdocs_adding_new_cpd_language.html).
-CPD is included with PMD, which you can download [here](http://sourceforge.net/projects/pmd/files/pmd/).
-## Command line usage
+### Why should you care about duplicates?
+
+It's certainly important to know where to get CPD, and how to call it, but it's worth stepping back for a moment and asking yourself why you should care about this, being the occurrence of duplicate code blocks.
-### Windows
+Assuming duplicated blocks of code are supposed to do the same thing, any refactoring, even simple, must be duplicated too -- which is unrewarding grunt work, and puts pressure on the developer to find every place in which to perform the refactoring. Automated tools like CPD can help with that to some extent.
-CPD comes with its own starter batch file: `cpd.bat`. It's located in the `bin` subdirectory in the PMD
-binary distribution zip-file. Let's assume, you are in this directory, then you can start CPD this way:
+However, failure to keep the code in sync may mean automated tools will no longer recognise these blocks as duplicates. This means the task of finding duplicates to keep them in sync when doing subsequent refactorings can no longer be entrusted to an automated tool -- adding more burden on the maintainer. Segments of code initially supposed to do the same thing may grow apart undetected upon further refactoring.
- cpd.bat --minimum-tokens 100 --files c:\temp\src\java
+Now, if the code may never change in the future, then this is not a problem.
-The options "minimum-tokens" and "files" are the two required options; there are more options, see below.
+Otherwise, the most viable solution is to not duplicate. If the duplicates are already there, then they should be refactored out. We thus advise developers to use CPD to **help remove duplicates**, not to help keep duplicates in sync.
+### Refactoring duplicates
-### Linux
+Once you have located some duplicates, several refactoring strategies may apply depending of the scope and extent of the duplication. Here's a quick summary:
-For Linux, there is since PMD 5.0 a combined start script for all command line tools. This includes CPD.
-The start script is called `run.sh` and is located in the `bin` subdirectory in the PMD binary distribution
-zip-file. Let's assume, you are in this directory, then you can start CPD this way:
+* If the duplication is local to a method or single class:
+ * Extract a local variable if the duplicated logic is not prohibitively long
+ * Extract the duplicated logic into a private method
+* If the duplication occurs in siblings within a class hierarchy:
+ * Extract a method and pull it up in the class hierarchy, along with common fields
+ * Use the [Template Method](https://sourcemaking.com/design_patterns/template_method) design pattern
+* If the duplication occurs consistently in unrelated hierarchies:
+ * Introduce a common ancestor to those class hierarchies
- ./run.sh cpd --minimum-tokens 100 --files /tmp/src/java
+Novice as much as advanced readers may want to [read on on Refactoring Guru](https://refactoring.guru/smells/duplicate-code) for more in-depth strategies, use cases and explanations.
-The options "minimum-tokens" and "files" are the two required options; there are more options, see below.
+## CLI Usage
-### Options
+### CLI options reference
<table>
<tr>
<th>Option</th>
<th>Description</th>
- <th>Required</th>
- <th>Applies for language</th>
- </tr>
- <tr>
- <td>--minimum-tokens</td>
- <td>The minimum token length which should be reported as a duplicate.</td>
- <td>yes</td>
- <td></td>
- </tr>
- <tr>
- <td>--files</td>
- <td>List of files and directories to process</td>
- <td>yes</td>
- <td></td>
- </tr>
- <tr>
- <td>--filelist</td>
- <td>Path to file containing a comma delimited list of files to analyze. If this is given, then you don't need to provide `--files`.</td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>--language</td>
- <td>Sources code language. Default value is `java`</td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>--encoding</td>
- <td>Character encoding to use when processing files</td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>--skip-duplicate-files</td>
- <td>Ignore multiple copies of files of the same name and length in comparison.</td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>--exclude</td>
- <td>Files to be excluded from CPD check</td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>--non-recursive</td>
- <td>Don't scan subdirectiories</td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>--skip-lexical-errors</td>
- <td>Skip files which can't be tokenized due to invalid characters instead of aborting CPD</td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>--format</td>
- <td>Report format. Default value is `text`.</td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>--failOnViolation {true|false}</td>
- <td>By default CPD exits with status 4 if code duplications are found.
- Disable this option with '--failOnViolation false' to exit with 0 instead and just write the report.</td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>--ignore-literals</td>
- <td>Ignore number values and string contents when comparing text</td>
- <td>no</td>
- <td>java</td>
- </tr>
- <tr>
- <td>--ignore-identifiers</td>
- <td>Ignore constant and variable names when comparing text</td>
- <td>no</td>
- <td>java</td>
- </tr>
- <tr>
- <td>--ignore-annotations</td>
- <td>Ignore language annotations when comparing text</td>
- <td>no</td>
- <td>java</td>
- </tr>
- <tr>
- <td>--ignore-usings</td>
- <td>Ignore using directives in C# when comparing text</td>
- <td>no</td>
- <td>C#</td>
- </tr>
- <tr>
- <td>--no-skip-blocks</td>
- <td>Do not skip code blocks marked with --skip-blocks-pattern (e.g. #if 0 until #endif)</td>
- <td>no</td>
- <td>cpp</td>
- </tr>
- <tr>
- <td>--skip-blocks-pattern</td>
- <td>
- Pattern to find the blocks to skip. Start and End pattern separated by |.
- Default is `#if 0|#endif`.
- </td>
- <td>no</td>
- <td>cpp</td>
- </tr>
- <tr>
- <td>--uri</td>
- <td>URI to process</td>
- <td>no</td>
- <td>plsql</td>
- </tr>
- <tr>
- <td>--help / -h</td>
- <td>Print help text</td>
- <td>no</td>
- <td></td>
+ <th>Default</th>
+ <th>Applies to</th>
</tr>
+ {% include custom/cli_option_row.html options="--minimum-tokens"
+ description="The minimum token length which should be reported as a duplicate."
+ required="yes"
+ %}
+ {% include custom/cli_option_row.html options="--files"
+ description="List of files and directories to process"
+ required="yes"
+ %}
+ {% include custom/cli_option_row.html options="--filelist"
+ description="Path to file containing a comma delimited list of files to analyze. If this is given, then you don't need to provide `--files`."
+ %}
+ {% include custom/cli_option_row.html options="--language"
+ description="Sources code language."
+ default="java"
+ %}
+ {% include custom/cli_option_row.html options="--encoding"
+ description="Character encoding to use when processing files. If not specified, CPD uses the system default encoding."
+ %}
+ {% include custom/cli_option_row.html options="--skip-duplicate-files"
+ description="Ignore multiple copies of files of the same name and length in comparison."
+ default="false"
+ %}
+ {% include custom/cli_option_row.html options="--exclude"
+ description="Files to be excluded from CPD check"
+ %}
+ {% include custom/cli_option_row.html options="--non-recursive"
+ description="Don't scan subdirectories"
+ default="false"
+ %}
+ {% include custom/cli_option_row.html options="--skip-lexical-errors"
+ description="Skip files which can't be tokenized due to invalid characters instead of aborting CPD"
+ default="false"
+ %}
+ {% include custom/cli_option_row.html options="--format"
+ description="Report format."
+ default="text"
+ %}
+ {% include custom/cli_option_row.html options="--failOnViolation"
+ option_arg="bool"
+ description="By default CPD exits with status 4 if code duplications are found.
+ Disable this option with `--failOnViolation false` to exit with 0 instead and just write the report."
+ default="true"
+ %}
+ {% include custom/cli_option_row.html options="--ignore-literals"
+ description="Ignore number values and string contents when comparing text"
+ default="false"
+ languages="Java"
+ %}
+ {% include custom/cli_option_row.html options="--ignore-identifiers"
+ description="Ignore constant and variable names when comparing text"
+ default="false"
+ languages="Java"
+ %}
+ {% include custom/cli_option_row.html options="--ignore-annotations"
+ description="Ignore language annotations when comparing text"
+ default="false"
+ languages="Java"
+ %}
+ {% include custom/cli_option_row.html options="--ignore-usings"
+ description="Ignore `using` directives in C# when comparing text"
+ default="false"
+ languages="C#"
+ %}
+ {% include custom/cli_option_row.html options="--no-skip-blocks"
+ description="Do not skip code blocks matched by `--skip-blocks-pattern`"
+ default="false"
+ languages="C++"
+ %}
+ {% include custom/cli_option_row.html options="--skip-blocks-pattern"
+ description="Pattern to find the blocks to skip. It is a string property and contains of two parts,
+ separated by `|`. The first part is the start pattern, the second part is the ending pattern."
+ default="#if 0|#endif"
+ languages="C++"
+ %}
+ {% include custom/cli_option_row.html options="--uri"
+ description="URI to process"
+ languages="PLSQL"
+ %}
+ {% include custom/cli_option_row.html options="--help,-h"
+ default="false"
+ description="Print help text"
+ %}
</table>
### Examples
@@ -241,26 +201,30 @@ This behavior has been introduced to ease CPD integration into scripts or hooks,
</table>
-### Supported Languages
+## Supported Languages
-* cs
-* cpp
-* ecmascript (JavaScript)
-* fortran
-* go
-* java
-* jsp
-* matlab
-* objectivec
-* php
-* plsql
-* python
-* ruby
-* scala
-* swift
+* Apex
+* C#
+* C/C++
+* EcmaScript (JavaScript)
+* Fortran
+* Go
+* Groovy
+* Java
+* Jsp
+* Matlab
+* Objective-C
+* Perl
+* PHP
+* PL/SQL
+* Python
+* Ruby
+* Scala
+* Swift
+* Visualforce
-### Available formats
+## Available report formats
* text : Default format
* xml
@@ -273,6 +237,7 @@ This behavior has been introduced to ease CPD integration into scripts or hooks,
Andy Glover wrote an Ant task for CPD; here's how to use it:
+```xml
<target name="cpd">
<taskdef name="cpd" classname="net.sourceforge.pmd.cpd.CPDTask" />
<cpd minimumTokenCount="100" outputFile="/home/tom/cpd.txt">
@@ -281,128 +246,87 @@ Andy Glover wrote an Ant task for CPD; here's how to use it:
</fileset>
</cpd>
</target>
+```
+
+<!-- TODO avoid duplicating the descriptions! -->
+
+### Attribute reference
-<table border="1" cellpadding="2" cellspacing="0">
- <tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td valign="top"><b>Applies for language</b></td>
- <td align="center" valign="top"><b>Required</b></td>
- </tr>
- <tr>
- <td valign="top">encoding</td>
- <td valign="top">
- The character set encoding (e.g., UTF-8) to use when reading the source code files, but also when
- producing the report. A piece of warning, even if you set properly the encoding value,
- let's say to UTF-8, but you are running CPD encoded with CP1252, you may end up with not UTF-8 file.
- Indeed, CPD copy piece of source code in its report directly, therefore, the source files
- keep their encoding.<br />
- If not specified, CPD uses the system default encoding.
- </td>
- <td valign="top"></td>
- <td valign="top" align="center">No</td>
- </tr>
- <tr>
- <td valign="top">format</td>
- <td valign="top">The format of the report (e.g. `csv`, `text`, `xml`); defaults to `text`.</td>
- <td valign="top"></td>
- <td valign="top" align="center">No</td>
- </tr>
- <tr>
- <td valign="top">ignoreLiterals</td>
- <td valign="top">
- if `true`, CPD ignores literal
- value differences when evaluating a duplicate block. This means that `foo=42;` and `foo=43;`
- will be seen as equivalent. You may want to run PMD with this option off to start with and
- then switch it on to see what it turns up; defaults to `false`.
- </td>
- <td valign="top">java</td>
- <td valign="top" align="center">No</td>
- </tr>
- <tr>
- <td valign="top">ignoreIdentifiers</td>
- <td valign="top">
- Similar to `ignoreLiterals` but for identifiers; i.e., variable names, methods names,
- and so forth; defaults to `false`.
- </td>
- <td valign="top">java</td>
- <td valign="top" align="center">No</td>
- </tr>
- <tr>
- <td valign="top">ignoreAnnotations</td>
- <td valign="top">
- Ignore annotations. More and more modern frameworks use annotations on classes and methods,
- which can be very redundant and trigger CPD matches. With J2EE (CDI, Transaction Handling, etc)
- and Spring (everything) annotations become very redundant. Often classes or methods have the
- same 5-6 lines of annotations. This causes false positives; defaults to `false`.
- </td>
- <td valign="top">java</td>
- <td valign="top" align="center">No</td>
- </tr>
- <tr>
- <td valign="top">ignoreUsings</td>
- <td valign="top">
- Ignore using directives in C#.
- </td>
- <td valign="top">C#</td>
- <td valign="top" align="center">No</td>
- </tr>
- <tr>
- <td valign="top">skipDuplicateFiles</td>
- <td valign="top">
- Ignore multiple copies of files of the same name and length in comparison; defaults to `false`.
- </td>
- <td valign="top"></td>
- <td valign="top" align="center">No</td>
- </tr>
- <tr>
- <td valign="top">skipLexicalErrors</td>
- <td valign="top">
- Skip files which can't be tokenized due to invalid characters instead of aborting CPD; defaults to `false`.
- </td>
- <td valign="top"></td>
- <td valign="top" align="center">No</td>
- </tr>
- <tr>
- <td valign="top">skipBlocks</td>
- <td valign="top">
- Enables or disabled skipping of blocks like a pre-processor; defaults to `true`.
- See also option skipBlocksPattern.
- </td>
- <td valign="top">cpp</td>
- <td valign="top">No</td>
- </tr>
- <tr>
- <td valign="top">skipBlocksPattern</td>
- <td valign="top">
- Configures the pattern, to find the blocks to skip. It is a string property and contains of two parts,
- separated by `|`. The first part is the start pattern, the second part is the ending pattern.
- The default value is `#if 0|#endif`.
- </td>
- <td valign="top">cpp</td>
- <td valign="top">no</td>
- </tr>
- <tr>
- <td valign="top">language</td>
- <td valign="top">
- Flag to select the appropriate language (e.g. `c`, `cpp`, `cs`, `java`, `jsp`, `php`, `ruby`, `fortran`
- `ecmascript`, and `plsql`); defaults to `java`.
- </td>
- <td valign="top"></td>
- <td valign="top" align="center">No</td>
- </tr>
- <tr>
- <td valign="top">minimumtokencount</td>
- <td valign="top">A positive integer indicating the minimum duplicate size.</td>
- <td valign="top"></td>
- <td valign="top" align="center">Yes</td>
- </tr>
- <tr>
- <td valign="top">outputfile</td>
- <td valign="top">The destination file for the report. If not specified the console will be used instead.</td>
- <td valign="top"></td>
- <td valign="top" align="center">No</td>
- </tr>
+<table>
+ <tr>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Default</th>
+ <th>Applies to</th>
+ </tr>
+ {% include custom/cli_option_row.html options="minimumtokencount"
+ description="A positive integer indicating the minimum duplicate size."
+ required="yes"
+ %}
+ {% include custom/cli_option_row.html options="encoding"
+ description="The character set encoding (e.g., UTF-8) to use when reading the source code files, but also when
+ producing the report. A piece of warning, even if you set properly the encoding value,
+ let's say to UTF-8, but you are running CPD encoded with CP1252, you may end up with not UTF-8 file.
+ Indeed, CPD copy piece of source code in its report directly, therefore, the source files
+ keep their encoding.<br />
+ If not specified, CPD uses the system default encoding."
+ %}
+ {% include custom/cli_option_row.html options="format"
+ description="The format of the report (e.g. `csv`, `text`, `xml`)."
+ default="text"
+ %}
+ {% include custom/cli_option_row.html options="ignoreLiterals"
+ description="if `true`, CPD ignores literal value differences when evaluating a duplicate
+ block. This means that `foo=42;` and `foo=43;` will be seen as equivalent. You may want
+ to run PMD with this option off to start with and then switch it on to see what it turns up."
+ default="false"
+ languages="Java"
+ %}
+ {% include custom/cli_option_row.html options="ignoreIdentifiers"
+ description="Similar to `ignoreLiterals` but for identifiers; i.e., variable names, methods names, and so forth."
+ default="false"
+ languages="Java"
+ %}
+ {% include custom/cli_option_row.html options="ignoreAnnotations"
+ description="Ignore annotations. More and more modern frameworks use annotations on classes and methods,
+ which can be very redundant and trigger CPD matches. With J2EE (CDI, Transaction Handling, etc)
+ and Spring (everything) annotations become very redundant. Often classes or methods have the
+ same 5-6 lines of annotations. This causes false positives."
+ default="false"
+ languages="Java"
+ %}
+ {% include custom/cli_option_row.html options="ignoreUsings"
+ description="Ignore using directives in C#."
+ default="false"
+ languages="C#"
+ %}
+ {% include custom/cli_option_row.html options="skipDuplicateFiles"
+ description="Ignore multiple copies of files of the same name and length in comparison."
+ default="false"
+ %}
+ {% include custom/cli_option_row.html options="skipLexicalErrors"
+ description="Skip files which can't be tokenized due to invalid characters instead of aborting CPD."
+ default="false"
+ %}
+ {% include custom/cli_option_row.html options="skipBlocks"
+ description="Enables or disabled skipping of blocks like a pre-processor. See also option skipBlocksPattern."
+ default="true"
+ languages="C++"
+ %}
+ {% include custom/cli_option_row.html options="skipBlocksPattern"
+ description="Configures the pattern, to find the blocks to skip. It is a string property and contains of two parts,
+ separated by `|`. The first part is the start pattern, the second part is the ending pattern."
+ default="#if 0|#endif"
+ languages="C++"
+ %}
+ {% include custom/cli_option_row.html options="language"
+ description="Flag to select the appropriate language (e.g. `c`, `cpp`, `cs`, `java`, `jsp`, `php`, `ruby`, `fortran`
+ `ecmascript`, and `plsql`)."
+ default="java"
+ %}
+ {% include custom/cli_option_row.html options="outputfile"
+ description="The destination file for the report. If not specified the console will be used instead."
+ %}
</table>
Also, you can get verbose output from this task by running ant with the `-v` flag; i.e.:
@@ -412,7 +336,9 @@ Also, you can get verbose output from this task by running ant with the `-v` fla
Also, you can get an HTML report from CPD by using the XSLT script in pmd/etc/xslt/cpdhtml.xslt. Just run
the CPD task as usual and right after it invoke the Ant XSLT script like this:
+```xml
<xslt in="cpd.xml" style="etc/xslt/cpdhtml.xslt" out="cpd.html" />
+```
## GUI
@@ -433,8 +359,10 @@ Here's a screenshot of CPD after running on the JDK 8 java.lang package:
## Suppression
-Arbitrary blocks of code can be ignored through comments on **Java** by including the keywords `CPD-OFF` and `CPD-ON`.
+Arbitrary blocks of code can be ignored through comments on **Java**, **C/C++**, **Javascript**, **Matlab**,
+**Objective-C**, **PL/SQL** and **Python** by including the keywords `CPD-OFF` and `CPD-ON`.
+```java
public Object someParameterizedFactoryMethod(int x) throws Exception {
// some unignored code
@@ -452,7 +380,7 @@ Arbitrary blocks of code can be ignored through comments on **Java** by includin
// further code will *not* be ignored
}
-
+```
Additionally, **Java** allows to toggle suppression by adding the annotations
**`@SuppressWarnings("CPD-START")`** and **`@SuppressWarnings("CPD-END")`**
@@ -461,6 +389,7 @@ all code within will be ignored by CPD.
This approach however, is limited to the locations were `@SuppressWarnings` is accepted.
It's legacy and the new comment's based approch should be favored.
+```java
//enable suppression
@SuppressWarnings("CPD-START")
public Object someParameterizedFactoryMethod(int x) throws Exception {
@@ -470,7 +399,19 @@ It's legacy and the new comment's based approch should be favored.
@SuppressWarnings("CPD-END)
public void nextMethod() {
}
-
+```
Other languages currently have no support to suppress CPD reports. In the future,
the comment based approach will be extended to those of them that can support it.
+
+## Credits
+CPD has been through three major incarnations:
+
+* First we wrote it using a variant of Michael Wise's Greedy String Tiling algorithm (our variant is described
+ [here](http://www.onjava.com/pub/a/onjava/2003/03/12/pmd_cpd.html)).
+
+* Then it was completely rewritten by Brian Ewins using the
+ [Burrows-Wheeler transform](http://dogma.net/markn/articles/bwt/bwt.htm).
+
+* Finally, it was rewritten by Steve Hawkins to use the
+ [Karp-Rabin](http://www.nist.gov/dads/HTML/karpRabin.html) string matching algorithm.
diff --git a/docs/pages/pmd/userdocs/extending/defining_properties.md b/docs/pages/pmd/userdocs/extending/defining_properties.md
new file mode 100644
index 00000000000..dfa69e98c04
--- /dev/null
+++ b/docs/pages/pmd/userdocs/extending/defining_properties.md
@@ -0,0 +1,173 @@
+---
+title: Defining rule properties
+short_title: Defining rule properties
+tags: [extending, userdocs]
+summary: "Learn how to define your own properties both for Java and XPath rules."
+last_updated: December 2017 (6.0.0)
+permalink: pmd_userdocs_extending_defining_properties.html
+author: Hooper Bloob <hooperbloob@users.sourceforge.net>, Romain Pelisse <rpelisse@users.sourceforge.net>, Clément Fournier <clement.fournier76@gmail.com>
+---
+
+
+## Defining properties
+
+If you're a rule developer, you may want to think about what would be useful for a user of your rule to parameterise. It could be a numeric report level, a boolean flag changing the behaviour of your rule... PMD ships with many types of properties ready to use!
+
+### Overview of properties
+
+The basic thing you need to do as a developer is to define a **property descriptor** and declare that your rule uses it. A property descriptor defines a number of attributes for your property:
+* Its *name*, with which the user will refer to your property;
+* Its *description*, for documentation purposes;
+* Its *default value*
+
+Don't worry, all of these attributes can be specified in a single Java statement (or xml element for XPath rules).
+
+Without further ado, here is the list of available (single-value) properties:
+
+|Class name|Value type|
+|----------|----------|
+|IntegerProperty | int
+|DoubleProperty | double
+|FloatProperty | float
+|LongProperty | long
+|EnumeratedProperty\<*E*\>| *E*
+|StringProperty|String
+|BooleanProperty|boolean
+|CharacterProperty|char
+|FileProperty|java.io.File
+|MethodProperty|java.lang.reflect.Method
+|TypeProperty|java.lang.Class\<?\>
+|RegexProperty|java.util.regex.Pattern
+
+Each of these is complemented by a multivalued variant, whose name ends with "MultiProperty", and which returns a list of values, e.g.
+
+|Class name|Value type|
+|----------|----------|
+|LongMultiProperty | List\<Long\>
+|EnumeratedMultiProperty\<*E*\>| List\<*E*\>
+
+Note that RegexProperty doesn't have a multivalued variant, since the delimiters could be part of a specific value.
+
+### For Java rules
+
+The procedure to define a property is quite straightforward:
+* Create a property descriptor of the type you want, using its builder;
+* Call `definePropertyDescriptor(<your descriptor>)` in the rule's noarg constructor.
+
+You can then retrieve the value of the property at any time using `getProperty(<your descriptor>)`.
+
+#### Creating a descriptor
+
+From version 6.0.0 on, properties can be built using specific **builders**. For example, to build a string property, you'd call
+```java
+StringProperty.named("myProperty")
+ .desc("This is my property")
+ .defaultValue("foo")
+ .build();
+```
+
+This is fairly more readable than a constructor call, but keep in mind the description and the default value are not optional.
+
+{%include note.html content="The constructors may be deprecated in a future release, so please use the builders instead." %}
+
+For **numeric properties**, you'd add a call to `range` to define the range of acceptable values, e.g.
+```java
+IntegerProperty.named("myIntProperty")
+ .desc("This is my property")
+ .defaultValue(3)
+ .range(0, 100)
+ .build();
+```
+
+**Enumerated properties** are a bit less straightforward to define, though they are arguably more powerful. These properties don't have a specific value type, instead, you can choose any type of value, provided the values are from a closed set. To make that actionable, you give string labels to each of the acceptable values, and the user will provide one of those labels as a value in the XML. The property will give you back the associated value, not the label. Here's an example:
+```java
+static Map<String, ModeStrategy> map = new HashMap<>();
+
+static {
+ map.put("easyMode", new EasyStrategy());
+ map.put("hardMode", new HardStrategy());
+}
+
+static EnumeratedProperty<ModeStrategy> modeProperty
+ = EnumeratedProperty.<ModeStrategy>named("modeProperty")
+ .desc("This is my property")
+ .defaultValue(new EasyStrategy())
+ .mappings(map)
+ .type(ModeStrategy.class)
+ .build();
+```
+
+Note that you're required to fill in the type of the values too, using `type()`.
+
+#### Example
+
+You can see an example of properties used in a PMD rule [here](https://github.com/pmd/pmd/blob/ac2ff0f6af8d16f739584ba8d00b7ea1a6311ccc/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/AvoidDeeplyNestedIfStmtsRule.java#L17).
+There are several things to notice here:
+* The property descriptor is declared `static final`, which should generally be the case, as descriptors are immutable and can be shared between instances of the same rule;
+* The property is declared using `definePropertyDescriptor` *in the constructor*, which ensures the property gets recognised by PMD;
+* The value of the property is *not retrieved in the constructor*, but in one of the `visit` methods (typically on the highest node in the tree, since the property doesn't change).
+
+
+
+### For XPath rules
+
+XPath rules can also define their own properties. To do so, you must add a `property` element in the `properties` element of your rule, which **declares the `type` attribute**. This attribute conditions what type the underlying property has, and can have the following values:
+
+| `type` attribute | Property type|
+|----------|----------|
+|Integer|IntegerProperty
+|Double | DoubleProperty
+|Float|FloatProperty
+|Long| LongProperty
+|String|StringProperty
+|Character|CharacterProperty
+|Boolean|BooleanProperty
+|Class|TypeProperty
+|Regex|RegexProperty
+
+Note that enumerated properties are not available in XPath rules (yet?).
+
+Properties defined in XPath also *must* declare the `description` attribute. Numeric properties also expect the `min` and `max` attributes. Here are a few examples to sum it up:
+
+```xml
+<property name="stringProp" type="Boolean" value="true" description="A BooleanProperty."/>
+<property name="intProp" type="Integer" value="3" min="1" max="20" description="An IntegerProperty."/>
+```
+
+You can then use the property in XPath with the syntax `$propertyName`, for example:
+
+```xml
+<rule name="MyXpathRule" ...>
+ <properties>
+ <property name="maxStatements" type="Integer" value="10" min="1" max="40"
+ description="Max number of statements per method"/>
+ <property name="xpath">
+ <![CDATA[
+ //MethodDeclaration/Block[count(//BlockStatement) > $maxStatements]
+ ]]></property>
+ </properties>
+</rule>
+```
+
+#### Multivalued properties
+
+Multivalued properties are also allowed and their `type` attribute has the form `List[Boolean]` or `List[Character]`, with every above type allowed. These properties **require XPath 2.0** to work properly, and make use of the **sequence datatype** provided by that language. You thus need to set the `version` property to `2.0` to use them. Properties can also declare the `delimiter` attribute.
+
+
+
+```xml
+<rule name="MyXpathRule" ...>
+ <properties>
+ <property name="version" value="2.0" />
+ <property name="intProp" type="List[Integer]" value="1,2,5" description="An IntegerMultiProperty." />
+ <property name="reportedIdentifiers" type="List[String]" value="foo$bar" delimiter="$"
+ description="A StringMultiProperty." />
+ <property name="xpath">
+ <![CDATA[
+ //VariableDeclaratorId[@Image = $reportedIdentifiers]
+ ]]></property>
+ </properties>
+</rule>
+```
+
+Notice that in the example above, `@Image = $reportedIdentifiers` doesn't test `@Image` for equality with the whole sequence `('foo', 'bar')`, it tests whether the sequence *contains* `@Image`. That is, the above rule will report all variables named `foo` or `bar`. All other XPath 2.0 [functions operating on sequences](https://www.w3.org/TR/xpath-functions/#sequence-functions) are supported.
diff --git a/docs/pages/pmd/devdocs/metrics_howto.md b/docs/pages/pmd/userdocs/extending/metrics_howto.md
similarity index 90%
rename from docs/pages/pmd/devdocs/metrics_howto.md
rename to docs/pages/pmd/userdocs/extending/metrics_howto.md
index 8c7045e062a..5ccabe03cdb 100644
--- a/docs/pages/pmd/devdocs/metrics_howto.md
+++ b/docs/pages/pmd/userdocs/extending/metrics_howto.md
@@ -1,24 +1,17 @@
---
-title: Using code metrics in custom rules
-tags: [customizing]
-summary: "PMD was recently enhanced with the ability to compute code metrics on Java and Apex source (the so-called
+title: Using and defining code metrics for custom rules
+tags: [extending, userdocs, metrics]
+summary: "Since version 6.0.0, PMD is enhanced with the ability to compute code metrics on Java and Apex source (the so-called
Metrics Framework). This framework provides developers with a straightforward interface to use code metrics in their
rules, and to extend the framework with their own custom metrics."
-last_updated: July 20, 2017
-permalink: pmd_devdocs_metrics_howto.html
+last_updated: December 18, 2017
+permalink: pmd_userdocs_extending_metrics_howto.html
author: Clément Fournier <clement.fournier76@gmail.com>
---
-# Using code metrics in custom rules
## Using the metrics framework
-{%include note.html content="Using the metrics framework is for now restricted to Java rules (with plans to support
-XPath rules later)." %}
-
-To use the metrics framework in a custom rule, the first thing to do would be to **enable metrics by adding the
-`metrics="true"` attribute** to your rule's XML element.
-
-{%include note.html content="The following explains how to use the Java metrics framework. The Apex framework
+{%include note.html content="The following explains how to use the Java metrics framework. The Apex framework
differs only by the name of its classes." %}
In PMD's Metrics framework, a metric is an operation that can be carried out on nodes of a certain type and produces
@@ -57,8 +50,6 @@ or `ConstructorDeclaration`.
## For Java Rules
-First, similarly to XPath rules, you should add the `metrics="true"` attribute to your rule's XML element.
-
The static façade class `JavaMetrics` is the single entry point to compute metrics in the Java framework.
This class provides the method `get` and its overloads. The following sections describes the interface of this class.
@@ -107,7 +98,7 @@ public Object visit(ASTMethodDeclaration method, Object data) {
### Metric options
Some metrics define options that can be used to slightly modify the computation. You'll typically see these options
-gathered inside an enum in the implementation class of the metric, for example `CycloMetric.CycloOptions`. They're
+gathered inside an enum in the implementation class of the metric, for example `CycloMetric.CycloOption`. They're
also documented on the [index of metrics](pmd_java_metrics_index.html).
To use options with a metric, you must first bundle them into a `MetricOptions` object. `MetricOptions` provides the
@@ -126,7 +117,7 @@ public Object visit(ASTMethodDeclaration method, Object data) {
The version of `MetricOptions.ofOptions` using a collection is useful when you're building a `MetricOptions` from eg
the value of an `EnumeratedMultiProperty`, which gives users control of the options they use. See
-[CyclomaticComplexityRule]( https://github.com/pmd/pmd/blob/master/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/metrics/rule/CyclomaticComplexityRule.java)
+[CyclomaticComplexityRule](https://github.com/pmd/pmd/blob/master/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/design/CyclomaticComplexityRule.java#L35)
for an example usage.
### Result options
@@ -153,17 +144,18 @@ option too.
The following is a sample code for a rule reporting methods with a cyclomatic
complexity over 10 and classes with a total cyclo over 50. A metric option can be
user-configured with a rule property. More complete examples can be found in
-[CyclomaticComplexityRule]( https://github.com/pmd/pmd/blob/master/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/metrics/rule/CyclomaticComplexityRule.java),
-[NcssCountRule](https://github.com/pmd/pmd/blob/master/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/metrics/rule/NcssCountRule.java),
-or [GodClassRule](https://github.com/pmd/pmd/blob/master/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/design/GodClassRule.java).
+[CyclomaticComplexityRule](https://github.com/pmd/pmd/blob/master/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/design/CyclomaticComplexityRule.java#L35),
+[NcssCountRule](https://github.com/pmd/pmd/blob/master/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/design/NcssCountRule.java#L30),
+or [GodClassRule](https://github.com/pmd/pmd/blob/master/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/design/GodClassRule.java#L24).
```java
public class CycloRule extends AbstractJavaMetricsRule {
public static final BooleanProperty COUNT_BOOLEAN_PATHS
- = new BooleanProperty("countBooleanPaths", "Count boolean paths",
- true, 0f);
+ = BooleanProperty.named("countBooleanPaths")
+ .desc("Count boolean paths")
+ .defaultValue(true).build();
private static final MetricOptions options;
@@ -275,9 +267,10 @@ concrete node types you can target with class and operation metrics, by language
Language | Java | Apex |
-----------|------|------|
-Operation declaration|`ASTMethodOrConstructorDeclaration`<br/>>: `ASTMethodDeclaration`, `ASTConstructorDeclaration`| `ASTMethod`
+Operation declaration|`ASTMethodOrConstructorDeclaration`<br/>>: `ASTMethodDeclaration`, `ASTConstructorDeclaration`| `ASTMethod`*
Type declaration|`ASTAnyTypeDeclaration` >: `ASTEnumDeclaration`, <br> `ASTAnnotationDeclaration`, `ASTClassOrInterfaceDeclaration`| `ASTUserClassOrInterface` >: `ASTUserClass`, `ASTUserInterface`
+*Apex method metrics are also applied to triggers by default (see [#771](https://github.com/pmd/pmd/pull/771)). Finer capability checking is not available out of the box for now.
What if you don't want such a generalisation? The `supports` method lets you
define a predicate to check that the node is supported by your metric. For example,
@@ -300,5 +293,5 @@ classes. Here's the default behaviour by language and type of metric:
Language | Java | Apex |
-----------|------|------|
-Operation metrics| supports constructors and non abstract methods| supports any non abstract method except `<init>`, `<clinit>`, and `clone`
+Operation metrics| supports constructors and non abstract methods| supports any non abstract method (including triggers), except `<init>`, `<clinit>`, and `clone`
Type declaration|supports classes and enums|supports classes
diff --git a/docs/pages/pmd/devdocs/rule_guidelines.md b/docs/pages/pmd/userdocs/extending/rule_guidelines.md
similarity index 93%
rename from docs/pages/pmd/devdocs/rule_guidelines.md
rename to docs/pages/pmd/userdocs/extending/rule_guidelines.md
index 791830bcc37..91f03f6dba9 100644
--- a/docs/pages/pmd/devdocs/rule_guidelines.md
+++ b/docs/pages/pmd/userdocs/extending/rule_guidelines.md
@@ -1,9 +1,9 @@
---
-title: PMD Rule Guidelines
-tags: [customizing]
+title: Rule guidelines
+tags: [extending, userdocs]
summary: Rule Guidelines
last_updated: July 3, 2016
-permalink: pmd_devdocs_rule_guidelines.html
+permalink: pmd_userdocs_extending_rule_guidelines.html
author: Xavier Le Vourch, Ryan Gustafson, Romain Pelisse
---
@@ -51,8 +51,8 @@ See [Test Framework](pmd_devdocs_testing.html) for the general documentation
### … for a rule I want to submit (in a patch)
-Figure out the ruleset to which you want to the rule. Then add your rule to the appropriate test class for
-the ruleset and add the XML test data in the correct xml subpackage.
+Figure out the category to which you want to the rule. Then add your rule to the appropriate test class for
+the category and add the XML test data in the correct xml subpackage.
### … for something too specific, that I won’t be able to submit
diff --git a/docs/pages/pmd/userdocs/extending/testing.md b/docs/pages/pmd/userdocs/extending/testing.md
new file mode 100644
index 00000000000..d7ac79032c8
--- /dev/null
+++ b/docs/pages/pmd/userdocs/extending/testing.md
@@ -0,0 +1,280 @@
+---
+title: Testing your rules
+tags: [extending, userdocs]
+summary: "Learn how to use PMD's simple test framework for unit testing rules."
+permalink: pmd_userdocs_extending_testing.html
+last_updated: November 2018
+author: Andreas Dangel <andreas.dangel@adangel.org>
+---
+
+## Introduction
+
+Good rules have tests. At least a positive test case - a code example, that triggers the rule and reports
+a violation - and a negative test case - a code example, that doesn't trigger the rule - should be created.
+Of course, the more tests, the better the rule is verified. If the rule is more complex or defines properties,
+with which the behavior can be modified, then these different cases can also be tested.
+
+And if there is a bug fix for a rule, be it a false positive or a false negative case, it should be accompanied
+with an additional test case, so that the bug is not accidentally reintroduced later on.
+
+## How it works
+
+PMD's built-in rules are organized in rulesets, where all rules belonging to the same category are placed
+in a single ruleset, such as "category/java/bestpractices.xml".
+Each category-ruleset has a single abstract base test class, from which the individual test classes inherit.
+We have one test class per rule, which executes all test cases for a single rule. The actual test cases are
+stored in separate XML files, for each rule a separate file is used.
+
+All the test classes inherit from `net.sourceforge.pmd.testframework.PmdRuleTst`,
+which provides the seamless integration with JUnit. This base class determines the language, the category name
+and the rule name from the concrete test class. It then searches the test code on its own.
+E.g. the individual rule test class
+`net.sourceforge.pmd.lang.java.rule.bestpractices.AbstractClassWithoutAbstractMethodTest` tests the
+rule with the name "AbstractClassWithoutAbstractMethod", which is in the category "bestpractices" for the
+language "java".
+
+The test code (see below [Test XML Reference](#test-xml-reference)) describes the test case completely with
+the expected behavior like number of expected rule violations, where the violations are expected, and so on.
+
+When you are running the test class in your IDE (e.g. Eclipse or IntelliJ IDEA) you can also select a single
+test case and just execute this one.
+
+## Where to place the test code
+
+The `PmdRuleTst` class searches the XML file, that describes the test cases for a certain rule
+using the following convention:
+The XML file is a test resource, so it is searched in the tree under `src/test/resources`.
+
+The sub package `xml` of the test class's package should contain a file with the same name as the rule's name
+which is under test.
+
+For example, to test the rule "AbstractClassWithoutAbstractMethod", the fully qualified test class is:
+
+ net.sourceforge.pmd.lang.java.rule.bestpractices.AbstractClassWithoutAbstractMethodTest
+
+The test code for the rule can be found in the file:
+
+ src/test/resources/net/sourceforge/pmd/lang/java/rule/bestpractices/xml/AbstractClassWithoutAbstractMethod.xml
+
+In general, the class name and file name pattern for the test class and data is this:
+
+ net.sourceforge.pmd.lang.<Language Terse Name>.rule.<Category Name>.<Rule Name>Test
+ src/test/resources/net/sourceforge/pmd/lang/<Language Terse Name>/rule/<Category Name>/xml/<Rule Name>.xml
+
+{%include tip.html content="This convention allows you to quickly find the test cases for a given rule:
+Just search in the project for a file `<RuleName>.xml`. Search for a class `<Rule Name>Test` to find the
+unit test class for the given rule." %}
+
+{%include note.html content="If you want to use the test framework with a different package structure,
+see [Using the test framework externally](#using-the-test-framework-externally)." %}
+
+## Simple example
+
+### Test Class: AbstractClassWithoutAbstractMethodTest
+
+This class inherits from `PmdRuleTst` and is located in the package "bestpractices", since the rule
+belongs to the category "Best Practices":
+
+``` java
+package net.sourceforge.pmd.lang.java.rule.bestpractices;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class AbstractClassWithoutAbstractMethodTest extends PmdRuleTst {
+ // no additional unit tests
+}
+```
+
+{%include note.html content="You can also add additionally standard JUnit test methods annotated with `@Test` to
+this test class." %}
+
+### Test Data: AvoidBranchingStatementAsLastInLoop.xml
+
+This is a stripped down example which just contains two test cases.
+
+``` xml
+<?xml version="1.0" encoding="UTF-8"?>
+<test-data
+ xmlns="http://pmd.sourceforge.net/rule-tests"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/rule-tests https://pmd.sourceforge.io/rule-tests_1_0_0.xsd">
+ <test-code>
+ <description>concrete class</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+public class Foo {}
+ ]]></code>
+ </test-code>
+ <test-code>
+ <description>failure case</description>
+ <expected-problems>1</expected-problems>
+ <expected-linenumbers>1</expected-linenumbers>
+ <code><![CDATA[
+public abstract class Foo {}
+ ]]></code>
+ </test-code>
+</test-data>
+```
+
+Each test case is in an own `<test-code>` element. The first defines 0 expected problems, means this code doesn't
+trigger the rule. The second test case expects 1 problem. Since the rule violations also report the exact AST node,
+you can verify the line number, too.
+
+## Test XML Reference
+
+The root element is `<test-data>`. It can contain one or more `<test-code>` and `<code-fragment>` elements.
+Each `<test-code>` element defines a single test case. `<code-fragment>` elements are used to share code snippets
+between different test cases.
+
+{%include note.html content="The XML schema is available at [rule-tests.xsd](https://github.com/pmd/pmd/blob/master/pmd-test/src/main/resources/rule-tests_1_0_0.xsd)." %}
+
+### `<test-code>` attributes
+
+The `<test-code>` elements understands three optional attributes:
+
+* **reinitializeRule**: By default, it's `true`, so each test case starts with a fresh instantiated rule. Set it
+ to `false` to reproduce cases, where the previous run has influences.
+
+* **regressionTest**: By default, it's `true`. Set it to `false`, to ignore and skip a test case.
+
+* **useAuxClasspath**: By default, it's `true`. Set it to `false` to reproduce issues which only
+ appear without type resolution.
+
+### `<test-code>` children
+
+* **`<description>`**: Short description of the test case. This will be the JUnit test name in the report.
+ If applicable, this description should contain a reference to the bug number, this test case reproduces.
+
+* **`<rule-property>`**: Optional rule properties, if the rule is configurable. Just add multiple elements, to
+ set multiple properties for one test case. For an example, see below.
+
+* **`<expected-problems>`**: The the raw number of expected rule violations, that this rule is expected to report.
+ For false-positive test cases, this is always "0". For false-negative test cases, it can be any positive number.
+
+* **`<expected-linenumbers>`**: Optional element. It's a comma separated list of line numbers.
+ If there are rule violations reported, then this allows you to
+ assert the line numbers. Useful if multiple violations should be detected and to be sure that
+ false positives and negatives don't erase each other.
+
+* **`<expected-messages>`**: Optional element, with `<message>` elements as children.
+ Can be used to validate the correct error message, e.g. if the error message references a variable name.
+
+* **`<code>`**: Either the `<code>` element or the `<code-ref>` element is required. It provides the actual code
+ snippet on which the rule is executed. The code itself is usually wrapped in a "CDATA" section, so that no
+ further XML escapes (entity references such as <) are necessary.
+
+* **`<code-ref id=...>`**: Alternative to `<code>`. References a `<code-fragment>` defined earlier in the file.
+ This allows you to share the same code snippet with several test cases. The attribute `id` must match the
+ id of the references code fragment.
+
+* **`<source-type>`**: Optional element that specifies the source code language. This defines the parser that
+ is used for parsing the code snippet. If not given, **java** is used as default.
+
+### `<code-fragment>`
+
+The code fragment has just one required attribute: **id**. This is used to reference it via a `<code-ref>` element
+inside a `<test-code>`. Similar like the `<code>` element, the content of `<code-fragment>` is usually wrapped
+in a "CDATA" section, so that no further XML escapes (entity references such as <) are necessary.
+
+### Complete XML example
+
+``` xml
+<?xml version="1.0" encoding="UTF-8"?>
+<test-data
+ xmlns="http://pmd.sourceforge.net/rule-tests"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/rule-tests https://pmd.sourceforge.io/rule-tests_1_0_0.xsd">
+
+ <test-code reinitializeRule="true" regressionTest="true" useAuxClasspath="true">
+ <description>Just a description, will be used as the test name for JUnit in the reports</description>
+ <rule-property name="somePropName">propValue</rule-property> <!-- optional -->
+ <expected-problems>2</expected-problems>
+ <expected-linenumbers>5,14</expected-linenumbers> <!-- optional -->
+ <expected-messages> <!-- optional -->
+ <message>Violation message 1</message>
+ <message>Violation message 2</message>
+ </expected-messages>
+ <code><![CDATA[
+ public class ConsistentReturn {
+ public Boolean foo() {
+ }
+ }
+ ]]></code>
+ <source-type>apex</source-type> <!-- optional -->
+ </test-code>
+
+ <code-fragment id="codeSnippet1"><![CDATA[
+ public class ConsistentReturn {
+ public Boolean foo() {
+ }
+ }
+ ]]></code-fragment>
+ <test-code>
+ <description>test case using a code fragment</description>
+ <expected-problems>0</expected-problems>
+ <code-ref id="codeSnippet1"/>
+ </test-code>
+ </test-data>
+```
+
+## Using the test framework externally
+
+It is also possible to use the test framework for custom rules developed outside the PMD source base.
+Therefore you just need to reference the dependency `net.sourceforge.pmd:pmd-test`.
+
+For maven, you can use this snippet:
+
+ <dependency>
+ <groupId>net.sourceforge.pmd</groupId>
+ <artifactId>pmd-test</artifactId>
+ <version>{{site.pmd.version}}</version>
+ <scope>test</scope>
+ </dependency>
+
+Then proceed as described earlier: create your test class, create your test cases and run the unit test.
+
+There is one difference however: Since your package structure is probably different, you'll need to register
+the rule test manually, as SimpleAggregatorTst will fail to determine it correctly from the package and class names:
+
+``` java
+package com.example.pmd.rules;
+
+import net.sourceforge.pmd.testframework.SimpleAggregatorTst;
+
+public class CustomRuleTest extends SimpleAggregatorTst {
+ @Override
+ public void setUp() {
+ addRule("com/example/pmd/ruleset.xml", "CustomRule");
+ }
+}
+```
+
+This will then search for a rule named "CustomRule" in the ruleset, that is located in "src/main/resources" under
+the path "com/example/pmd/ruleset.xml".
+
+The test data should be placed in an xml file located in "src/test/resources" under the path
+"com/example/pmd/rules/xml/CustomRule.xml".
+
+## How the test framework is implemented
+
+The framework uses a custom JUnit test runner under the hood, among a couple of utility classes:
+
+* `PmdRuleTst`: This is the base class for tests in PMD's code base. It is a subclass of `RuleTst` and just
+ contains the logic to determine the test resources based on the test class name.
+
+* `SimpleAggregatorTst`: This is a more generic base class for the test classes and defines
+ the custom JUnit test runner. It doesn't register any test cases on its own.
+ It itself is a subclass of `RuleTst`.
+
+* `RuleTst`: contains the logic to parse the XML files and provide a list of `TestDescriptor`s. Each test descriptor
+ describes a single test case. It also contains the logic to execute such a test descriptor and assert the results.
+
+* `PMDTestRunner`: A custom JUnit test runner, that combines two separate test runners: The custom `RuleTestRunner`
+ and the standard `JUnit4` test runner. This combination allows you to add additional standard unit test methods
+ annotated with `@Test` to your test class.
+
+ *Note:* Since the test class is executed through two test runners, it is actually instantiated twice. Be aware
+ of this, if you do any initialization in the constructor. Also, the static hooks `@BeforeClass` and `@AfterClass`
+ will be executed twice.
+
+* `RuleTestRunner`: This test runner executes the test descriptors with the help of `RuleTst`.
diff --git a/docs/pages/pmd/devdocs/writing_pmd_rules.md b/docs/pages/pmd/userdocs/extending/writing_pmd_rules.md
similarity index 76%
rename from docs/pages/pmd/devdocs/writing_pmd_rules.md
rename to docs/pages/pmd/userdocs/extending/writing_pmd_rules.md
index a6ec0ea8937..f19dec13bd3 100644
--- a/docs/pages/pmd/devdocs/writing_pmd_rules.md
+++ b/docs/pages/pmd/userdocs/extending/writing_pmd_rules.md
@@ -1,9 +1,9 @@
---
-title: PMD Writing a Custom Rule
-tags: [customizing]
-summary: Writing a Custom Rule for PMD
+title: Writing a custom rule
+tags: [extending, userdocs]
+summary: "Learn how to write a custom rule for PMD"
last_updated: July 3, 2016
-permalink: pmd_devdocs_writing_pmd_rules.html
+permalink: pmd_userdocs_extending_writing_pmd_rules.html
author: Tom Copeland <tomcopeland@users.sourceforge.net>
---
@@ -72,7 +72,7 @@ CompilationUnit
You can generate this yourself by:
-* Run the batch file bin/designer.bat
+* Run the batch file `bin/designer.bat`
* Paste the code into the left text area and click the “Go†button
* Note that there’s another panel and a textfield to test out XPath expressions; more on that later.
* Here’s a screenshot: {% include image.html file="devdocs/designer_screenshot.png" alt="Designer Screenshot" %}
@@ -154,7 +154,7 @@ We stuck a `println()` in there for now so we can see when our rule gets hit.
## Put the WhileLoopsMustUseBracesRule rule in a ruleset file
-Now our rule is written - at least, the shell of it is - and now we need to tell PMD about it. We need to add it to a ruleset XML file. Look at `pmd-java/src/main/resources/rulesets/java/basic.xml`; it’s got lots of rule definitions in it. Copy and paste one of these rules into a new ruleset - call it `mycustomrules.xml` or something. Then fill in the elements and attributes:
+Now our rule is written - at least, the shell of it is - and now we need to tell PMD about it. We need to add it to a ruleset XML file. Look at `pmd-java/src/main/resources/category/java/bestpractices.xml`; it’s got lots of rule definitions in it. Copy and paste one of these rules into a new ruleset - call it `mycustomrules.xml` or something. Then fill in the elements and attributes:
* name - WhileLoopsMustUseBracesRule
* message - Use braces for while loops
@@ -169,7 +169,7 @@ The whole ruleset file should look something like this:
<ruleset name="My custom rules"
xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
<rule name="WhileLoopsMustUseBracesRule"
message="Avoid using 'while' statements without curly braces"
class="WhileLoopsMustUseBracesRule">
@@ -250,71 +250,23 @@ Note that access modifiers are held as attributes, so, for example,
finds all private fields. You can see the code that determines all the attributes [here](pmd-core/xref/net/sourceforge/pmd/lang/ast/xpath/AttributeAxisIterator.html)
-Thanks to Miguel Griffa for writing a longer [XPath tutorial](xpathruletutorial.html).
-
-## I want to implement a rule that analyze more than the class!
-
-An obvious limitation of the previous mechanism is the “class-centric†focus of the rule. How can you implement a rule that checks stuff across the all source code? Let’s take a dummy example. Let’s say you want to implement a rule that count how many Expression Node you have in your source code (told you, it was a dummy example :) ).
-
-You realize quite simply. You just have to add static field to the RulesContext, as an attribute, and uses Rule.start() and Rule.end() hook to initialized and finalize your rule’s implementation:
-
-```java
-package net.sourceforge.pmd.rules;
-
-import java.util.concurrent.atomic.AtomicLong;
-
-import net.sourceforge.pmd.RuleContext;
-import net.sourceforge.pmd.lang.java.rule.AbstractJavaRule;
-import net.sourceforge.pmd.lang.java.ast.ASTExpression;
-
-public class CountRule extends AbstractJavaRule {
-
- private static final String COUNT = "count";
-
- @Override
- public void start(RuleContext ctx) {
- ctx.setAttribute(COUNT, new AtomicLong());
- super.start(ctx);
- }
-
- @Override
- public Object visit(ASTExpression node, Object data) {
- // How many Expression nodes are there in all files parsed! I must know!
- RuleContext ctx = (RuleContext)data;
- AtomicLong total = (AtomicLong)ctx.getAttribute(COUNT);
- total.incrementAndGet();
- return super.visit(node, data);
- }
-
- @Override
- public void end(RuleContext ctx) {
- AtomicLong total = (AtomicLong)ctx.getAttribute(COUNT);
- addViolation(ctx, null, new Object[] { total });
- ctx.removeAttribute(COUNT);
- super.end(ctx);
- }
-}
-```
-
-As you can see in this example, the method start will be call the first time the rule is going to be used, so you can initialize properly your rule here. Once the rule will have finished to parses the source code, the method end() will be invoke you can assert there if, or not, your rule has been violated.
-
->Note that the example logs a violation **without** a proper classname. This is not really a good idea. Indeed, a lot of aggregating tools that PMD (Such as [XRadar](http://xradar.sourceforge.net), or [Sonar](http://www.sonarsource.com/)) probably uses this kind of meta data on their aggregation processes. So, when implements such a rule, always try to find a way to add classname to the violation report.
+More information about writing XPath rules is [available here](pmd_userdocs_extending_writing_xpath_rules.html).
## I need some kind of Type Resolution for my rule!
### Inside an XPath query
-PMD XPath syntax includes now a new function called `typeof` which determines if a node (ClassOrInterfaceType only right now) is of the provided type. It also scans the type’s hierarchy, so if you extend a class it will also find this out.
+PMD's XPath extensions include two functions called `typeIs` and `typeIsExactly`,
+which determine if a node is of a specific type (either any subtype or exactly,
+respectively).
-Here a an example of use, inside an XPath Query:
+Here a an example of use, inside an XPath query:
-```xpath
-//ClassOrInterfaceDeclaration[
- //ClassOrInterfaceType[typeof(@Image, 'junit.framework.TestCase','TestCase')]
-]
+```ruby
+//ClassOrInterfaceDeclaration/ExtendsList/ClassOrInterfaceType[typeIs('junit.framework.TestCase')]
```
-This query will match on such source code:
+This query will for instance match the following class declaration:
```java
import junit.framework.TestCase;
@@ -322,6 +274,16 @@ import junit.framework.TestCase;
public class Foo extends TestCase { }
```
+It will also match against classes which extend a *subtype* of `junit.framework.TestCase`,
+i.e. a base class itself extending `TestCase` transitively. If you don't want this behaviour,
+then use `typeIsExactly` instead of `typeIs`.
+
+Checking against an array type is possible with the double bracket syntax.
+An array type is denoted by just appending `[]` to the fully qualified class name
+of the component type. These can be repeated for arrays of arrays
+(e.g. `byte[][]` or `java.lang.String[]`).
+
+
### With Java code
Below an other sample of use of type resolution inside a java code:
diff --git a/docs/pages/pmd/devdocs/writing_xpath_rules.md b/docs/pages/pmd/userdocs/extending/writing_xpath_rules.md
similarity index 96%
rename from docs/pages/pmd/devdocs/writing_xpath_rules.md
rename to docs/pages/pmd/userdocs/extending/writing_xpath_rules.md
index ccbc1982c18..39d8bdb802e 100644
--- a/docs/pages/pmd/devdocs/writing_xpath_rules.md
+++ b/docs/pages/pmd/userdocs/extending/writing_xpath_rules.md
@@ -1,9 +1,9 @@
---
-title: Writing XPath Rules
-tags: [customizing]
+title: Writing XPath rules
+tags: [extending, userdocs]
summary: "Writing XPath rules for PMD"
last_updated: July 3, 2016
-permalink: pmd_devdocs_writing_xpath_rules.html
+permalink: pmd_userdocs_extending_writing_xpath_rules.html
author: Miguel Griffa <mikkey@users.sourceforge.net>
---
@@ -160,9 +160,9 @@ the example code and give your rule a useful name and message.
<?xml version="1.0"?>
<ruleset name="Custom Rules"
- xmlns="http://pmd.sourceforge.net/ruleset/3.0.0"
+ xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/3.0.0 http://pmd.sourceforge.net/ruleset_3_0_0.xsd">
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
<description>
Custom rules
</description>
diff --git a/docs/pages/pmd/userdocs/getting_started.md b/docs/pages/pmd/userdocs/getting_started.md
deleted file mode 100644
index 21398decad6..00000000000
--- a/docs/pages/pmd/userdocs/getting_started.md
+++ /dev/null
@@ -1,345 +0,0 @@
----
-title: Getting Started
-permalink: pmd_userdocs_getting_started.html
-author: Tom Copeland <tom@infoether.com>, Xavier Le Vourch <xlv@users.sourceforge.net>
----
-
-## How to install PMD and CPD
-
-### Windows
-
-Requirements:
-
-* [Java JRE](http://www.oracle.com/technetwork/java/javase/downloads/index.html) 1.7 or higher
-* [Winzip](http://winzip.com) or the free [7-zip](http://www.7-zip.org/)
-
-Download the latest binary distribution from [the github releases page](https://github.com/pmd/pmd/releases).
-
-Unzip it into any directory, i.e., c:\pmd\
-
-### Linux / Unix
-
-Requirements:
-
-* [Java JRE](http://www.oracle.com/technetwork/java/javase/downloads/index.html) 1.7 or higher
-* The Unix "zip" utility [InfoZip](http://www.info-zip.org/pub/infozip/)
-
-Download the latest binary distribution from [the github releases page](https://github.com/pmd/pmd/releases).
-
-Unzip it into any directory:
-
- [tom@hal tmp]$ unzip -q pmd-bin-{{site.pmd.version}}.zip
- [tom@hal tmp]$ ls -l
- total 4640
- drwxrwxr-x 5 tom tom 4096 Apr 17 16:38 pmd-bin-{{site.pmd.version}}
- -rw-rw-r-- 1 tom tom 4733312 Jun 9 15:44 pmd-bin-{{site.pmd.version}}.zip
- [tom@hal tmp]$
-
-
-Note that the PMD binary distribution file contains both [PMD](#running-pmd-via-command-line) and [CPD](/pmd_userdocs_cpd.html).
-
-
-## Running PMD via command line
-
-### On Linux and other UNIX based operating system...
-
-PMD comes with several command line utilities. Previously, each of them had its own start up script, but this has been
-greatly simplified since PMD 5.0. ... at least for Unix systems. There is now only one script, called "run.sh", inside
-the `bin/` directory of PMD distribution.
-
-The first argument is the name of the utility you want to execute ('pmd', 'designer', ...) and the other arguments are
-specific to the utility used.
-
- $ ./bin/run.sh pmd -d ../../../src/main/java/ -f text -R rulesets/java/basic.xml -version 1.7 -language java
- .../src/main/java/net/sourceforge/pmd/RuleSet.java:123 These nested if statements could be combined
- .../src/main/java/net/sourceforge/pmd/RuleSet.java:231 Useless parentheses.
- .../src/main/java/net/sourceforge/pmd/RuleSet.java:232 Useless parentheses.
- .../src/main/java/net/sourceforge/pmd/RuleSet.java:357 These nested if statements could be combined
- .../src/main/java/net/sourceforge/pmd/RuleSetWriter.java:66 Avoid empty catch blocks
- .../src/main/java/net/sourceforge/pmd/RuleSetWriter.java:269 Useless parentheses.
-
-Type "./run.sh pmd -d \[filename\|jar or zip file containing source code\|directory] -f \[report format] -R \[ruleset file]", i.e:
-
- /home/user/tmp/pmd-bin-{{site.pmd.version}}/pmd/bin>./run.sh pmd -d /home/user/data/pmd/pmd/test-data/Unused1.java -f xml -R rulesets/java/unusedcode.xml
- <?xml version="1.0"?><pmd>
- <file name="/home/user/data/pmd/pmd/test-data/Unused1.java">
- <violation line="5" rule="UnusedLocalVariable">
- Avoid unused local variables such as 'fr'
- </violation>
- </file></pmd>
-
- /home/user/tmp/pmd-bin-{{site.pmd.version}}/pmd/bin>
-
-
-### Basic usage for Windows
-
-You can find PMD's starter batch file `pmd.bat` in the `bin` subdirectory.
-
-Type "pmd -d \[filename\|jar or zip file containing source code\|directory] -f \[report format] -R \[ruleset file]", i.e:
-
- C:\tmp\pmd-bin-{{site.pmd.version}}<\pmd\bin>pmd -d c:\data\pmd\pmd\test-data\Unused1.java -f xml -R rulesets/java/unusedcode.xml
- <?xml version="1.0"?><pmd>
- <file name="c:\data\pmd\pmd\test-data\Unused1.java">
- <violation line="5" rule="UnusedLocalVariable">
- Avoid unused local variables such as 'fr'
- </violation>
- </file></pmd>
-
- C:\tmp\pmd-bin-{{site.pmd.version}}\pmd\bin>
-
-You can pass a file name, a directory name, or a jar or zip file name containing Java source code to PMD.
-
-Also, the PMD binary distribution includes the ruleset files
-inside the jar file - even though the "rulesets/java/unusedcode.xml" parameter
-above looks like a filesystem reference, it's really being used by a getResourceAsStream() call
-to load it out of the PMD jar file.
-
-### Options
-
-The tool comes with a rather extensive help text, simply running with `-help`!
-
-<table>
- <tr>
- <th>Option</th>
- <th>Description</th>
- <th>Required</th>
- <th>Applies for language</th>
- </tr>
- <tr>
- <td>-rulesets / -R</td>
- <td>Comma separated list of ruleset names to use</td>
- <td>yes</td>
- <td></td>
- </tr>
- <tr>
- <td>-dir / -d</td>
- <td>Root directory for sources</td>
- <td>yes</td>
- <td></td>
- </tr>
- <tr>
- <td>-format / -f</td>
- <td>Report format type. Default format is `text`.</td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>-auxclasspath</td>
- <td>
- Specifies the classpath for libraries used by the source code. This is used by the type resolution.
- Alternatively a `file://` URL to a text file containing path elements on consecutive lines can be
- specified.
- </td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>-uri / -u</td>
- <td>Database URI for sources. If this is given, then you don't need to provide `-dir`.</td>
- <td>no</td>
- <td>plsql</td>
- </tr>
- <tr>
- <td>-filelist</td>
- <td>Path to file containing a comma delimited list of files to analyze. If this is given, then you don't need to provide `-dir`.</td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>-debug / -verbose / -D / -V</td>
- <td>Debug mode. Prints more log output.</td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>-help / -h / -H</td>
- <td>Display help on usage.</td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>-encoding / -e</td>
- <td>Specifies the character set encoding of the source code files PMD is reading (i.e. UTF-8). Default is `UTF-8`.</td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>-threads / -t</td>
- <td>Sets the number of threads used by PMD. Default is `1`. Set threads to '0' to disable multi-threading processing.</td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>-benchmark / -b</td>
- <td>Benchmark mode - output a benchmark report upon completion; defaults to System.err</td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>-stress / -S</td>
- <td>Performs a stress test.</td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>-shortnames</td>
- <td>Prints shortened filenames in the report.</td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>-showsuppressed</td>
- <td>Report should show suppressed rule violations.</td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>-suppressmarker</td>
- <td>Specifies the string that marks the line which PMD should ignore; default is `NOPMD`.</td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>-minimumpriority / -min</td>
- <td>Rule priority threshold; rules with lower priority than configured here won't be used. Default is `5` - which is the lowest priority.</td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>-property / -P</td>
- <td>`{name}={value}`: Define a property for a report format.</td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>-reportfile / -r</td>
- <td>Send report output to a file; default to System.out</td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>-version / -v</td>
- <td>Specify version of a language PMD should use.</td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>-language / -l</td>
- <td>Specify a language PMD should use.</td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>-failOnViolation {true|false}</td>
- <td>By default PMD exits with status 4 if violations are found.
- Disable this option with '-failOnViolation false' to exit with 0 instead and just write the report.
- </td>
- <td>no</td>
- <td></td>
- </tr>
- <tr>
- <td>-cache</td>
- <td>Specify a location for the analysis cache file to use.
- This can greatly improve analysis performance and is <b>highly recommended</b>.</td>
- <td>no</td>
- <td></td>
- </tr>
-</table>
-
-
-### Exit Status
-
-Please note that if PMD detects any violations, it will exit with status 4 (since 5.3).
-This behavior has been introduced to ease PMD integration into scripts or hooks, such as SVN hooks.
-
-<table>
-<tr><td>0</td><td>Everything is fine, now violations found</td></tr>
-<tr><td>1</td><td>Couldn't understand command line parameters or PMD exited with an exception</td></tr>
-<tr><td>4</td><td>At least one violation has been detected unless '-failOnViolation false' is set.</td></tr>
-</table>
-
-
-### Supported Languages
-
-* [apex](/pmd_rules_apex.html)
-* [java](/pmd_rules_java.html)
-* [ecmascript](/pmd_rules_javascript.html) (JavaScript)
-* [jsp](/pmd_rules_jsp.html)
-* [plsql](/pmd_rules_plsql.html)
-* [vm](/pmd_rules_vm.html) (Apache Velocity)
-* [xml and xsl](/pmd_rules_xml.html)
-
-
-### Available Report Formats / Renderers
-
-PMD comes with many different renderer types:
-
-* **codeclimate**: Renderer for Code Climate JSON format.
-
-* **csv**: Comma-separated values tabular format.
-
- Properties:
-
- * problem: Include problem column. Default: true.
- * package: Include package column. Default: true.
- * file: Include file column. Default: true.
- * priority: Include priority column. Default: true.
- * line: Include line column. Default: true.
- * desc: Include description column. Default: true.
- * ruleSet: Include Rule set column. Default: true.
- * rule: Include Rule column. Default: true.
-
-* **emacs**: GNU Emacs integration.
-
-* **html**: HTML format.
-
- Properties:
-
- * linePrefix: Prefix for line number anchor in the source file.
- * linkPrefix: Path to HTML source.
-
-* **ideaj**: IntelliJ IDEA integration.
-
- Properties:
-
- * classAndMethodName: Class and method name, pass '.method' when processing a directory.
- * sourcePath:
- * fileName:
-
-* **summaryhtml**: Summary HTML format.
-
- Properties:
-
- * linePrefix: Prefix for line number anchor in the source file.
- * linkPrefix: Path to HTML source.
-
-* **text**: Text format.
-
-* **textcolor**: Text format, with color support (requires ANSI console support, e.g. xterm, rxvt, etc.).
-
- Properties:
-
- * color: Enables colors with anything other than 'false' or '0'. Default: yes.
-
-* **textpad**: TextPad integration.
-
-* **vbhtml**: Vladimir Bossicard HTML format.
-
-* **xml**: XML format.
-
- Properties:
-
- * encoding: XML encoding format, defaults to UTF-8.
-
-* **xslt**: XML with a XSL transformation applied.
-
- Properties:
-
- * encoding: XML encoding format, defaults to UTF-8.
- * xsltFilename: The XSLT file name.
-
-* **yahtml**: Yet Another HTML format.
-
- Properties:
-
- * outputDir: Output directory.
diff --git a/docs/pages/pmd/userdocs/help.md b/docs/pages/pmd/userdocs/help.md
deleted file mode 100644
index 8ef0a175033..00000000000
--- a/docs/pages/pmd/userdocs/help.md
+++ /dev/null
@@ -1,8 +0,0 @@
----
-title: Getting Help
-sidebar: pmd_sidebar
-permalink: pmd_userdocs_help.html
-folder: pmd/userdocs
----
-
-Asking questions, reporting bugs, ...
diff --git a/docs/pages/pmd/userdocs/incremental_analysis.md b/docs/pages/pmd/userdocs/incremental_analysis.md
new file mode 100644
index 00000000000..8aa117b5a2f
--- /dev/null
+++ b/docs/pages/pmd/userdocs/incremental_analysis.md
@@ -0,0 +1,34 @@
+---
+title: Incremental Analysis
+keywords: [pmd, options, command, incremental, analysis, performance]
+tags: [userdocs]
+summary: "Explains how to use incremental analysis to speed up analysis"
+permalink: pmd_userdocs_incremental_analysis.html
+sidebar: pmd_sidebar
+---
+
+Ever since PMD 5.6.0, PMD has been able to perform Incremental Analysis.
+
+When performing Incremental Analysis for the first time, PMD will cache analysis data and results.
+This allows subsequent analysis to only look into those files that are new / have changed. For
+a typical development environment, where you only change a few files at a time, this can reduce
+analysis time dramatically.
+
+The generated report will be *exactly the same* as it would if running without incremental analysis.
+Files included in the final report will reflect exactly those files in your filesystem. Even if
+untouched, files with violations will be listed with full detail. Therefore, its usage is higly recommended.
+
+
+### Enabling incremental analysis
+
+Incremental analysis is enabled automatically once a location to store the cache has been defined.
+From command-line that is done through the [`-cache`](pmd_userdocs_cli_reference.html#cache) argument, but support for the feature is
+available for tools integrating PMD such as [Ant](pmd_userdocs_tools_ant.html),
+[Maven](pmd_userdocs_tools_maven.html), and Gradle.
+
+
+### Disabling incremental analysis
+
+By default, PMD will suggest to use an analysis cache by logging a warning.
+If you'd like to disable this warning, or ignore the analysis cache for a
+few runs, you can use the [`-no-cache`](pmd_userdocs_cli_reference.html#no-cache) switch.
diff --git a/docs/pages/pmd/userdocs/installation.md b/docs/pages/pmd/userdocs/installation.md
new file mode 100644
index 00000000000..44715742661
--- /dev/null
+++ b/docs/pages/pmd/userdocs/installation.md
@@ -0,0 +1,166 @@
+---
+title: Installation and basic CLI usage
+keywords: [pmd, cpd, options, command, auxclasspath]
+tags: [getting_started, userdocs]
+summary: "Sums up the first steps to set up a CLI installation and get started using PMD"
+permalink: pmd_userdocs_installation.html
+sidebar: pmd_sidebar
+---
+
+## How to install PMD and CPD
+
+### Requirements
+
+* [Java JRE](http://www.oracle.com/technetwork/java/javase/downloads/index.html) 1.7 or higher
+* A zip archiver, e.g.:
+
+ * For Windows: [Winzip](http://winzip.com) or the free [7-zip](http://www.7-zip.org/)
+ * For Linux / Unix: [InfoZip](http://www.info-zip.org/pub/infozip/)
+
+{% include note.html content="For executing the Designer (./run.sh designer) using [OpenJDK](http://jdk.java.net) or Java 11, you need additionally [OpenJFX](http://jdk.java.net). Download it, extract it and set the environment variable JAVAFX_HOME." %}
+
+
+### Installation
+
+PMD is distributed as a zip archive, which includes both [PMD](#running-pmd-via-command-line) and [CPD](/pmd_userdocs_cpd.html).
+You can download the latest binary distribution from [the github releases page](https://github.com/pmd/pmd/releases).
+
+Unzip it into any directory, optionally add the `bin` subdirectory in your `PATH`, and you're good to go!
+
+
+
+## Running PMD via command line
+
+{% include callout.html type="primary"
+ content="PMD comes with several command line utilities, like CPD, the rule designer or PMD itself.
+ On Unix, you can run any of them using the script `run.sh`, located inside the `bin/`
+ directory of the PMD distribution. The first argument is the name of the utility you want
+ to execute ('pmd', 'designer', ...), e.g. PMD is launched via `run.sh pmd`. The rest of
+ the arguments are specific to the utility used.<br/><br/>
+ On Windows, each utility has its own startup script, e.g. `pmd.bat`, `cpd.bat`." %}
+
+The PMD command (`pmd.bat` or `run.sh pmd`) requires two options:
+
+* `-d <path>`: path to the sources to analyse. This can be a file name, a directory, or a jar or zip file containing the
+sources.
+* `-R <path>`: the ruleset file you want to use. PMD uses xml configuration files, called *rulesets*, which specify
+which rules to execute on your sources. You can also run a single rule by referencing it using its *category* and
+name (more details [here](pmd_userdocs_making_rulesets.html#referencing-a-single-rule)). For example, you can check for unnecessary
+modifiers on Java sources with `-R category/java/codestyle.xml/UnnecessaryModifier`.
+
+{% include note.html
+ content="At the moment the formerly provided rulesets (eg `rulesets/java/basic.xml`) are deprecated,
+ though you can still use them. PMD includes a quickstart ruleset for some languages (currently, Java)
+ as base configurations, which you can reference as e.g. `rulesets/java/quickstart.xml`. You're strongly
+ encouraged to [create your own ruleset](pmd_userdocs_making_rulesets.html) from the start though." %}
+
+Additionally, the following options, are specified most of the time even though they're not required:
+* `-f <format>`: report format. PMD supports many report formats out of the box. You may want to start with the basic
+`text` format (default) or `xml` format. The supported formats are [documented here](pmd_userdocs_cli_reference.html#available-report-formats).
+* `-auxclasspath <classpath>`: class path containing the compiled class files of the analysed Java sources, if any.
+ Setting this up correctly allows PMD to do much deeper analysis using reflection. Some rules, such as [MissingOverride](pmd_rules_java_bestpractices.html#missingoverride),
+ require it to function properly.
+
+{%include tip.html content="A full CLI reference, including report formats, is available under [PMD CLI Reference](pmd_userdocs_cli_reference.html)" %}
+
+
+
+### Sample usage
+
+ The following shows a sample run of PMD with the `text` format:
+
+
+<div class="text-left">
+ <ul class="nav nav-tabs" role="tablist">
+ <li role="presentation" class="active"><a href="#linux" aria-controls="linux / unix" role="tab" data-toggle="tab">Linux / Unix</a></li>
+ <li role="presentation"><a href="#windows" aria-controls="windows" role="tab" data-toggle="tab">Windows</a></li>
+ </ul>
+
+ <div class="tab-content">
+ <div role="tabpanel" class="tab-pane active" id="linux">
+<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="gp">~ $ </span><span class="s2">cd</span> ~/bin/pmd-bin-{{site.pmd.version}}/bin
+<span class="gp">~/.../bin $ </span><span class="s2">./run.sh</span> pmd -d ../../../src/main/java/ -f text -R rulesets/java/basic.xml
+
+ .../src/main/java/com/me/RuleSet.java:123 These nested if statements could be combined
+ .../src/main/java/com/me/RuleSet.java:231 Useless parentheses.
+ .../src/main/java/com/me/RuleSet.java:232 Useless parentheses.
+ .../src/main/java/com/me/RuleSet.java:357 These nested if statements could be combined
+ .../src/main/java/com/me/RuleSetWriter.java:66 Avoid empty catch blocks</code></pre></figure>
+ </div>
+ <div role="tabpanel" class="tab-pane" id="windows">
+<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="gp">C:\ > </span><span class="s2">cd</span> C:\pmd-bin-{{site.pmd.version}}\bin
+<span class="gp">C:\...\bin > </span><span class="s2">.\pmd.bat</span> -d ..\..\src\main\java\ -f text -R rulesets/java/basic.xml
+
+ .../src/main/java/com/me/RuleSet.java:123 These nested if statements could be combined
+ .../src/main/java/com/me/RuleSet.java:231 Useless parentheses.
+ .../src/main/java/com/me/RuleSet.java:232 Useless parentheses.
+ .../src/main/java/com/me/RuleSet.java:357 These nested if statements could be combined
+ .../src/main/java/com/me/RuleSetWriter.java:66 Avoid empty catch blocks</code></pre></figure>
+ </div>
+ </div>
+</div>
+
+
+## Running CPD via command line
+
+{% include note.html
+ content="CPD supports Java, JSP, C, C++, C#, Fortran and PHP source code, among other languages.
+ For the full list, see [Supported Languages](pmd_userdocs_cpd#supported-languages)." %}
+
+Like for PMD, CPD is started on Unix by `run.sh cpd` and on Windows by `cpd.bat`.
+
+There are two required parameters:
+* `--files <path>`: path to the sources to analyse. This can be a file name, a
+ directory or a jar or zip file containing the sources.
+* `--minimum-tokens <number>`: the minimum token length which should be reported as a duplicate.
+
+{% include tip.html
+ content="CPD's command-line reference, Ant task usage, and many examples are documented in the
+ [CPD documentation page](pmd_userdocs_cpd.html)" %}
+
+### Sample usage
+
+ The following shows a sample run of CPD with the `text` format:
+
+
+<div class="text-left">
+ <ul class="nav nav-tabs" role="tablist">
+ <li role="presentation" class="active"><a href="#cpd-linux" aria-controls="linux / unix" role="tab" data-toggle="tab">Linux / Unix</a></li>
+ <li role="presentation"><a href="#cpd-windows" aria-controls="windows" role="tab" data-toggle="tab">Windows</a></li>
+ </ul>
+
+ <div class="tab-content">
+ <div role="tabpanel" class="tab-pane active" id="cpd-linux">
+<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="gp">~ $ </span><span class="s2">cd</span> ~/bin/pmd-bin-{{site.pmd.version}}/bin
+<span class="gp">~/.../bin $ </span><span class="s2">./run.sh</span> cpd --minimum-tokens 100 --files /home/me/src
+
+ Found a 7 line (110 tokens) duplication in the following files:
+ Starting at line 579 of /home/me/src/test/java/foo/FooTypeTest.java
+ Starting at line 586 of /home/me/src/test/java/foo/FooTypeTest.java
+
+ assertEquals(Boolean.TYPE, expressions.get(index++).getType());
+ assertEquals(Boolean.TYPE, expressions.get(index++).getType());
+ assertEquals(Boolean.TYPE, expressions.get(index++).getType());
+ assertEquals(Boolean.TYPE, expressions.get(index++).getType());
+ assertEquals(Boolean.TYPE, expressions.get(index++).getType());
+ assertEquals(Boolean.TYPE, expressions.get(index++).getType());
+ assertEquals(Boolean.TYPE, expressions.get(index++).getType());</code></pre></figure>
+ </div>
+ <div role="tabpanel" class="tab-pane" id="cpd-windows">
+<figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="gp">C:\ > </span><span class="s2">cd</span> C:\pmd-bin-{{site.pmd.version}}\bin
+<span class="gp">C:\...\bin > </span><span class="s2">.\cpd.bat</span> --minimum-tokens 100 --files c:\temp\src
+
+ Found a 7 line (110 tokens) duplication in the following files:
+ Starting at line 579 of c:\temp\src\test\java\foo\FooTypeTest.java
+ Starting at line 586 of c:\temp\src\test\java\foo\FooTypeTest.java
+
+ assertEquals(Boolean.TYPE, expressions.get(index++).getType());
+ assertEquals(Boolean.TYPE, expressions.get(index++).getType());
+ assertEquals(Boolean.TYPE, expressions.get(index++).getType());
+ assertEquals(Boolean.TYPE, expressions.get(index++).getType());
+ assertEquals(Boolean.TYPE, expressions.get(index++).getType());
+ assertEquals(Boolean.TYPE, expressions.get(index++).getType());
+ assertEquals(Boolean.TYPE, expressions.get(index++).getType());</code></pre></figure>
+ </div>
+ </div>
+</div>
diff --git a/docs/pages/pmd/userdocs/making_rulesets.md b/docs/pages/pmd/userdocs/making_rulesets.md
new file mode 100644
index 00000000000..272ce53ebc3
--- /dev/null
+++ b/docs/pages/pmd/userdocs/making_rulesets.md
@@ -0,0 +1,110 @@
+---
+title: Making rulesets
+keywords: [rulesets, reference, rule, exclude, include, pattern, filter]
+tags: [getting_started, userdocs]
+summary: Making Custom Rulesets for PMD
+last_updated: November 2017
+summary: "A ruleset is an XML configuration file, which describes a collection of rules to be executed
+ in a PMD run. PMD includes built-in rulesets to run quick analyses with a default configuration, but
+ users are encouraged to make their own rulesets from the start, because they allow for so much
+ configurability. This page walk you through the creation of a ruleset and the multiple configuration
+ features offered by rulesets."
+last_updated: May 2018 (6.4.0)
+permalink: pmd_userdocs_making_rulesets.html
+author: Tom Copeland <tomcopeland@users.sourceforge.net>, Clément Fournier <clement.fournier76@gmail.com>
+---
+
+## Creating a ruleset
+
+The first step is to create a new empty ruleset. You can use the following template:
+
+``` xml
+<?xml version="1.0"?>
+
+<ruleset name="Custom Rules"
+ xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
+
+ <description>
+ My custom rules
+ </description>
+
+
+ <!-- Your rules will come here -->
+
+</ruleset>
+```
+
+### Referencing a single rule
+
+<!-- TODO this could be better explained, eg first explain how a ruleset reference works, then rule reference, then go on showing single rule & bulk addition, then include/exclude patterns -->
+
+To use the built-in rules PMD provides, you need to add some *references* to them. Here's a
+basic rule reference:
+
+```xml
+ <rule ref="category/java/errorprone.xml/EmptyCatchBlock" />
+```
+
+Adding that element into the `ruleset` element adds the rule [EmptyCatchBlock](pmd_rules_java_errorprone.html#emptycatchblock)
+to your ruleset. This is a Java rule, so it will be executed on every Java file PMD encounters in
+its search space.
+
+How to read the `ref` attribute?
+
+* `category/java/errorprone.xml` is a reference to the Java category `errorprone`. Since PMD 6.0.0,
+ all PMD built-in rules are sorted in one of eight categories, which are consistent across languages:
+
+ 1. **Best Practices**: These are rules which enforce generally accepted best practices.<br/>
+ 2. **Code Style**: These rules enforce a specific coding style.<br/>
+ 3. **Design**: Rules that help you discover design issues.<br/>
+ 4. **Documentation**: These rules are related to code documentation.<br/>
+ 5. **Error Prone**: Rules to detect constructs that are either broken, extremely confusing or prone to runtime errors.<br/>
+ 6. **Multithreading**: These are rules that flag issues when dealing with multiple threads of execution.<br/>
+ 7. **Performance**: Rules that flag suboptimal code.<br/>
+ 8. **Security**: Rules that flag potential security flaws."
+
+{% include tip.html content="You can discover the available rules by language and category [from this page](tag_rule_references.html)" %}
+
+
+* `EmptyCatchBlock` is simply the name of the rule. If there were no rule with that name within the specified
+ category, then PMD would fail before starting the analysis.
+
+#### [Configuring individual rules](pmd_userdocs_configuring_rules.html)
+
+### Bulk-adding rules
+
+You can also reference rules in bulk by referencing a complete category or ruleset, possibly excluding certain rules, like in the following:
+
+```xml
+ <rule ref="category/java/codestyle.xml">
+ <exclude name="WhileLoopsMustUseBraces"/>
+ <exclude name="IfElseStmtsMustUseBraces"/>
+ </rule>
+```
+
+Here, the `ref` attribute references a whole category. You can also use a file system path or classpath relative path. In any case, the path must address an accessible ruleset XML file.
+
+{% include note.html content="Path separators in the source file path are normalized to be the `/` character within PMD, so the same ruleset can be used on multiple platforms transparently." %}
+
+### Filtering the processed files
+
+You can exclude some files from being processed by a ruleset using **exclude patterns**, with an optional overridding **include pattern**. A file will be excluded from processing *when there is a matching exclude pattern, but no matching include pattern*. This exclude/include technique works regardless of how PMD is used (e.g. command line, IDE, Ant), making it easier to keep application of your PMD rules consistent throughout your environment. Here is an example:
+
+```xml
+<?xml version="1.0"?>
+<ruleset name="myruleset"
+ xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
+ <description>My ruleset</description>
+
+ <exclude-pattern>.*/some/package/.*</exclude-pattern>
+ <exclude-pattern>.*/some/other/package/FunkyClassNamePrefix.*</exclude-pattern>
+ <include-pattern>.*/some/package/ButNotThisClass.*</include-pattern>
+
+ <!-- Rules here ... -->
+
+</ruleset>
+```
diff --git a/docs/pages/pmd/userdocs/suppressing.md b/docs/pages/pmd/userdocs/suppressing.md
deleted file mode 100644
index d9de8589c7b..00000000000
--- a/docs/pages/pmd/userdocs/suppressing.md
+++ /dev/null
@@ -1,165 +0,0 @@
----
-title: Suppressing warnings
-permalink: pmd_userdocs_suppressing.html
-author: Tom Copeland <tom@infoether.com>
----
-
-PMD provides several methods by which Rule violations can be suppressed.
-Follow these steps to help you determine which expression method works best
-for you:
-
-1. Is the thing you need to suppress universally appealing to other
- users of PMD, or is it a false positive? Can you modify the Rule to
- support this specific suppression via a configuration property, or to
- fix the false positive? If you can do this, then please do so, and
- submit a patch back to the PMD project. Since PMD is built by users
- for users, your help would be greatly appreciated by everyone. If you
- cannot...
-
-2. Can you use Annotations or the NOPMD marker to work around your
- particular issue on a case by case basis? If not...
-
-3. Can a regular expression matching the violation message work
- around your particular issue? If not...
-
-4. Can a XPath query on the violation node work around your particular
- issue? If not...
-
-5. Your last and final option is to see the first point about
- changing the Rule, but you do not need to submit a patch back to the
- PMD project.
-
-If you need to modify the Rule, see [How to write a rule](/pmd_devdocs_writing_pmd_rules.html).
-Otherwise, the other suppression methods are explained in the following sections.
-
-## Annotations
-
-You can use a JDK 1.5 annotation to suppress PMD warnings, like this:
-
- // This will suppress all the PMD warnings in this class
- @SuppressWarnings("PMD")
- public class Bar {
- void bar() {
- int foo;
- }
- }
-
-Or you can suppress one rule with an annotation like this:
-
- // This will suppress UnusedLocalVariable warnings in this class
- @SuppressWarnings("PMD.UnusedLocalVariable")
- public class Bar {
- void bar() {
- int foo;
- }
- }
-
-PMD also obeys the JDK annotation @SuppressWarnings("unused"), which will apply to all rules in the unused ruleset.
-
- // This will suppress UnusedLocalVariable and UnusedPrivateMethod warnings in this class
- @SuppressWarnings("unused")
- public class Bar {
- void bar() {
- int foo;
- }
- private void foobar(){}
- }
-
-
-## NOPMD
-
-Alternatively, you can tell PMD to ignore a specific line by using the "NOPMD" marker, like this:
-
- public class Bar {
- // 'bar' is accessed by a native method, so we want to suppress warnings for it
- private int bar; //NOPMD
- }
-
-You can use whatever text string you want to suppress warnings, for example, here's
-how to use TURN\_OFF\_WARNINGS as the suppressor:
-
- $ cat Foo.java
- public class Foo {
- void bar() {
- int x = 2; // TURN_OFF_WARNINGS
- }
- }
-
- $ ./run.sh pmd -d Foo.java -f text -R java-unusedcode -suppressmarker TURN_OFF_WARNINGS
- No problems found!
- UnusedLocalVariable rule violation suppressed by //NOPMD in /home/tom/pmd/pmd/bin/Foo.java
-
-Note that PMD expects the //NOPMD marker to be on the same line as the violation. So, for
-example, if you want to suppress an "empty if statement" warning, you'll need to place it on
-the line containing the "if" keyword, e.g.:
-
- $ cat ~/tmp/Foo.java
- public class Foo {
- void bar() {
- int x = 42;
- if (x > 5) { // NOPMD
- }
- }
- }
- $ java net.sourceforge.pmd.PMD -d ~/tmp/Foo.java -f text -R java-basic
- No problems found!
- $
-
-A message placed after the NOPMD marker will get placed in the report, e.g.:
-
- public class Foo {
- void bar() {
- try {
- bar();
- } catch (FileNotFoundException e) {} // NOPMD - this surely will never happen
- }
- }
-
-## Violation Suppress Regex
-
-If a particular Rule does not provide a property to customize behavior
-sufficiently, you can fall back to using the global 'violationSuppressRegex'
-property. This property defines a regular expression to match against the
-message of the violation. If the regular expression matches,
-then the violation will be suppressed.
-
-When using a Rule reference in a RuleSet XML, you can customize the
-Rule by adding the 'violationSuppressRegex' property. For example, to
-suppress reporting specifically named parameters which are unused:
-
-
- <rule ref="rulesets/java/unusedcode.xml/UnusedFormalParameter">
- <properties>
- <property name="violationSuppressRegex" value=".*'mySpecialParameterName'.*"/>
- </properties>
- </rule>
-
-Note for message based suppression to work, you must know who to write
-a regular expression that matches the message of violations you wish to
-suppress. Regular expressions are explained in the JavaDoc for standard
-Java class java.util.regex.Pattern.
-
-## Violation Suppress XPath
-
-If a particular Rule does not provide a property to customize behavior
-sufficiently, you can fall back to using the global 'violationSuppressXPath'
-property. This property defines an XPath query to be executed using the
-violation node as the starting point. If the XPath query matches anything,
-then the violation will be suppressed.
-
-When using a Rule reference in a RuleSet XML, you can customize the
-Rule by adding the 'violationSuppressXPath' property. For example, to
-suppress reporting specifically typed parameters which are unused:
-
- <rule ref="rulesets/java/unusedcode.xml/UnusedFormalParameter">
- <properties>
- <property name="violationSuppressXPath" value=".[typeof('java.lang.String')]"/>
- </properties>
- </rule>
-
-Note for XPath based suppression to work, you must know how to write
-an XPath query that matches the AST structure of the nodes of the
-violations you wish to suppress. XPath queries are explained in
-[XPath Rule tutorial](/pmd_devdocs_writing_xpath_rules.html).
-
-Suggestions? Comments? Post them [here](https://github.com/pmd/pmd/issues). Thanks!
diff --git a/docs/pages/pmd/userdocs/suppressing_warnings.md b/docs/pages/pmd/userdocs/suppressing_warnings.md
new file mode 100644
index 00000000000..5b19ccab1ca
--- /dev/null
+++ b/docs/pages/pmd/userdocs/suppressing_warnings.md
@@ -0,0 +1,206 @@
+---
+title: Suppressing warnings
+keywords: [suppressing, warnings, suppresswarnings, nopmd, violationSuppressXPath, violationSuppressRegex]
+tags: [userdocs]
+summary: "Learn how to suppress some rule violations, from the source code using annotations or comments, or globally from the ruleset"
+permalink: pmd_userdocs_suppressing_warnings.html
+author: Tom Copeland <tom@infoether.com>
+---
+
+PMD provides several methods by which Rule violations can be suppressed.
+Follow these steps to help you determine which expression method works best
+for you:
+
+1. Is the thing you need to suppress universally appealing to other
+ users of PMD, or is it a false positive? Can you modify the Rule to
+ support this specific suppression via a configuration property, or to
+ fix the false positive? If you can do this, then please do so, and
+ submit a patch back to the PMD project. Since PMD is built by users
+ for users, your help would be greatly appreciated by everyone. If you
+ cannot...
+
+2. Can you use Annotations or the NOPMD marker to work around your
+ particular issue on a case by case basis? If not...
+
+3. Can a regular expression matching the violation message work
+ around your particular issue? If not...
+
+4. Can a XPath query on the violation node work around your particular
+ issue? If not...
+
+5. Your last and final option is to see the first point about
+ changing the Rule, but you do not need to submit a patch back to the
+ PMD project.
+
+If you need to modify the Rule, see [How to write a rule](pmd_devdocs_writing_pmd_rules.html).
+Otherwise, the other suppression methods are explained in the following sections.
+
+## Annotations
+
+When using Java 1.5 or later, you can use annotations to suppress PMD warnings, like this:
+
+```java
+// This will suppress all the PMD warnings in this class
+@SuppressWarnings("PMD")
+public class Bar {
+ void bar() {
+ int foo;
+ }
+}
+```
+
+When using Apex make sure to use single quotes instead of double quotes
+
+```java
+// This will suppress all the PMD warnings in this class
+@SuppressWarnings('PMD')
+```
+
+
+Or you can suppress one rule with an annotation like this:
+
+```java
+// This will suppress UnusedLocalVariable warnings in this class
+@SuppressWarnings("PMD.UnusedLocalVariable")
+public class Bar {
+ void bar() {
+ int foo;
+ }
+}
+```
+
+Multiple rules can be suppressed by providing multiple values, ie:
+
+```java
+@SuppressWarnings({"PMD.UnusedLocalVariable", "PMD.UnusedPrivateMethod"})
+```
+
+For Apex, the syntax for this is slightly different:
+
+```java
+@SuppressWarnings('PMD.UnusedLocalVariable, PMD.UnusedPrivateMethod')
+```
+
+PMD Java also obeys the JDK annotation @SuppressWarnings("unused"), which will apply to all rules in the unused ruleset.
+
+```java
+// This will suppress UnusedLocalVariable and UnusedPrivateMethod warnings in this class
+@SuppressWarnings("unused")
+public class Bar {
+ void bar() {
+ int foo;
+ }
+ private void foobar(){}
+}
+```
+
+## NOPMD comment
+
+Alternatively, you can tell PMD to ignore a specific line by using the "NOPMD" marker in a comment, like this:
+
+```java
+public class Bar {
+ // 'bar' is accessed by a native method, so we want to suppress warnings for it
+ private int bar; //NOPMD
+}
+```
+
+You can use whatever text string you want to suppress warnings, by using the `-suppressmarker` CLI option.
+For example, here's how to use `TURN_OFF_WARNINGS` as the suppressor:
+
+```java
+$ cat Foo.java
+public class Foo {
+ void bar() {
+ int x = 2; // TURN_OFF_WARNINGS
+ }
+}
+
+$ ./run.sh pmd -d Foo.java -f text -R java-unusedcode -suppressmarker TURN_OFF_WARNINGS
+No problems found!
+UnusedLocalVariable rule violation suppressed by //NOPMD in /home/tom/pmd/pmd/bin/Foo.java
+```
+Note that PMD expects the //NOPMD marker to be on the same line as the violation. So, for
+example, if you want to suppress an "empty `if` statement" warning, you'll need to place it on
+the line containing the `if` keyword, e.g.:
+
+```java
+$ cat ~/tmp/Foo.java
+public class Foo {
+ void bar() {
+ int x = 42;
+ if (x > 5) { // NOPMD
+ }
+ }
+}
+$ java net.sourceforge.pmd.PMD -d ~/tmp/Foo.java -f text -R java-basic
+No problems found!
+```
+
+A message placed after the NOPMD marker will get placed in the report, e.g.:
+
+```java
+public class Foo {
+ void bar() {
+ try {
+ bar();
+ } catch (FileNotFoundException e) {} // NOPMD - this surely will never happen
+ }
+}
+```
+
+## XPath and Regex message suppression
+
+If a particular rule consistently reports a warning in a particular context, you can fall
+back to disabling the rule for all these contexts using one of two rule properties
+that are defined on every rule. Depending on what you're after, you can suppress
+violations for **specific messages** using regular expressions, or **specific nodes**
+using an XPath expression.
+
+
+### The property `violationSuppressRegex`
+
+This property defines a regular expression to match against the
+message of the violation. If the regular expression matches,
+then the violation will be suppressed.
+
+For example, to suppress reporting specifically named parameters which
+are unused:
+
+```xml
+<rule ref="rulesets/java/unusedcode.xml/UnusedFormalParameter">
+ <properties>
+ <property name="violationSuppressRegex" value=".*'mySpecialParameterName'.*"/>
+ </properties>
+</rule>
+```
+
+Note for message based suppression to work, you must know how to write
+a regular expression that matches the message of violations you wish to
+suppress. Regular expressions are explained in the JavaDoc for standard
+Java class java.util.regex.Pattern.
+
+This technique of course relies on how the rule's message is implemented.
+Some rules always report the same message, in which case this property is
+of no use.
+
+### The property `violationSuppressXPath`
+
+This property defines an XPath query to be executed *using the
+violation node as the starting point*. If the XPath query matches anything,
+then the violation will be suppressed.
+
+For example, to suppress reporting specifically typed parameters which are unused:
+
+```xml
+<rule ref="rulesets/java/unusedcode.xml/UnusedFormalParameter">
+ <properties>
+ <property name="violationSuppressXPath" value=".[typeIs('java.lang.String')]"/>
+ </properties>
+</rule>
+```
+
+Note for XPath based suppression to work, you must know how to write
+an XPath query that matches the AST structure of the nodes of the
+violations you wish to suppress. XPath queries are explained in
+[XPath Rule tutorial](pmd_userdocs_extending_writing_xpath_rules.html).
diff --git a/docs/pages/pmd/userdocs/tools/ant.md b/docs/pages/pmd/userdocs/tools/ant.md
index eb2ff5f42e7..d85c588782b 100644
--- a/docs/pages/pmd/userdocs/tools/ant.md
+++ b/docs/pages/pmd/userdocs/tools/ant.md
@@ -1,5 +1,6 @@
---
title: Ant Task Usage
+tags: [userdocs, tools]
permalink: pmd_userdocs_tools_ant.html
author: >
David Dixon-Peugh <dpeugh@users.sourceforge.net>,
@@ -76,8 +77,16 @@ Runs a set of static code analysis rules on some source code files and generates
<td>cacheLocation</td>
<td>
The location of the analysis cache file to be used.
- The cache can greatly improve analysis time without loosing analysis quality.
- <b>It's use is strongly recommended.</b>
+ Setting this property enables Incremental Analysis, which can greatly improve analysis time without loosing analysis quality.
+ <b>Its use is strongly recommended.</b>
+ </td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>noCache</td>
+ <td>
+ Setting this property to true disables Incremental Analysis, even if <i>cacheLocation</i> is provided.
+ You can use this to explicitly turn off suggestions to use incremental analysis, or for testing purposes.
</td>
<td>No</td>
</tr>
@@ -151,8 +160,7 @@ and the associated version (1.5, 1.6,...)
The specific version of a language to be used for parsing is selected via the `sourceLanguage`
nested element. Possible values are:
- <sourceLanguage name="cpp" version=""/>
- <sourceLanguage name="fortran" version=""/>
+ <sourceLanguage name="apex" version=""/>
<sourceLanguage name="ecmascript" version="3"/>
<sourceLanguage name="java" version="1.3"/>
<sourceLanguage name="java" version="1.4"/>
@@ -160,12 +168,13 @@ nested element. Possible values are:
<sourceLanguage name="java" version="1.6"/>
<sourceLanguage name="java" version="1.7"/>
<sourceLanguage name="java" version="1.8"/>
+ <sourceLanguage name="java" version="9"/>
<sourceLanguage name="jsp" version=""/>
- <sourceLanguage name="php" version=""/>
- <sourceLanguage name="ruby" version=""/>
+ <sourceLanguage name="pom" version=""/>
<sourceLanguage name="plsql" version=""/>
<sourceLanguage name="xsl" version=""/>
<sourceLanguage name="xml" version=""/>
+ <sourceLanguage name="vf" version=""/>
<sourceLanguage name="vm" version=""/>
### Postprocessing the report file with XSLT
diff --git a/docs/pages/pmd/userdocs/ci.md b/docs/pages/pmd/userdocs/tools/ci.md
similarity index 91%
rename from docs/pages/pmd/userdocs/ci.md
rename to docs/pages/pmd/userdocs/tools/ci.md
index c84cff056af..5f2c6ea616b 100644
--- a/docs/pages/pmd/userdocs/ci.md
+++ b/docs/pages/pmd/userdocs/tools/ci.md
@@ -1,6 +1,7 @@
---
title: Continuous Integrations plugins
-permalink: pmd_userdocs_ci.html
+tags: [userdocs, tools]
+permalink: pmd_userdocs_tools_ci.html
author: Romain PELISSE <belaran@gmail.com>
---
diff --git a/docs/pages/pmd/userdocs/tools/maven.md b/docs/pages/pmd/userdocs/tools/maven.md
index 06057b1b2d0..1e184ba2046 100644
--- a/docs/pages/pmd/userdocs/tools/maven.md
+++ b/docs/pages/pmd/userdocs/tools/maven.md
@@ -1,5 +1,6 @@
---
title: Maven PMD Plugin
+tags: [userdocs, tools]
permalink: /pmd_userdocs_tools_maven.html
last_updated: August 2017
author: >
@@ -112,6 +113,20 @@ writing a ruleset can be found [here](pmd_userdocs_understanding_rulesets.html).
Note that if you include other rulesets in your own rulesets, you have to be sure that the plugin
will be able to resolve those other ruleset references.
+#### Enabling Incremental Analysis
+
+When using the Maven PMD plugin 3.8 or later along with PMD 5.6.0 or later, you can enable incremental analysis to
+speed up PMD's execution while retaining the quality of the analysis. You can additionally customize where the cache is stored::
+
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-pmd-plugin</artifactId>
+ <configuration>
+ <analysisCache>true</analysisCache> <!-- enable incremental analysis -->
+ <analysisCacheLocation>${project.build.directory}/pmd/pmd.cache</analysisCacheLocation> <!-- Optional: points to this location by default -->
+ </configuration>
+ </plugin>
+
#### Other configurations
The Maven PMD plugin allows you to configure CPD, targetJDK, and the use of XRef to link
@@ -139,7 +154,7 @@ Maven plugin will use and benefit from the latest bugfixes and enhancements:
``` xml
<project>
<properties>
- <pmdVersion>...choose your version...</version>
+ <pmdVersion>...choose your version...</pmdVersion>
</properties>
...
<build>
diff --git a/docs/pages/pmd/userdocs/tools.md b/docs/pages/pmd/userdocs/tools/tools.md
similarity index 95%
rename from docs/pages/pmd/userdocs/tools.md
rename to docs/pages/pmd/userdocs/tools/tools.md
index c76c5be90b3..37b9e32943f 100644
--- a/docs/pages/pmd/userdocs/tools.md
+++ b/docs/pages/pmd/userdocs/tools/tools.md
@@ -1,14 +1,24 @@
---
title: Tools / Integrations
+tags: [userdocs, tools]
+
permalink: pmd_userdocs_tools.html
author: David Dixon-Peugh <dpeugh@users.sourceforge.net>
---
-* IDE plugins
-* [Continuous Integrations plugins](/pmd_userdocs_ci.html)
-* GUIs
+## Automated Code Review
+
+### Codacy
+
+[Codacy](https://www.codacy.com/) automates code reviews and monitors code quality on every commit and pull request.
+It gives visibility into the technical debt and it can track code style and security issues, code coverage, code duplication, cyclomatic complexity and enforce best practices.
+Codacy is static analysis without the hassle.
+With Codacy you have PMDJava analysis out-of-the-box, and it is free for open source projects.
+* Homepage: [https://www.codacy.com/](https://www.codacy.com/)
+* Source code: [https://github.com/codacy/codacy-pmdjava](https://github.com/codacy/codacy-pmdjava)
+* Maintainer: Codacy
## IDE Integrations
@@ -29,13 +39,6 @@ author: David Dixon-Peugh <dpeugh@users.sourceforge.net>
<td><a href="http://tomcopeland.blogs.com/">Tom Copeland</a></td>
</tr>
- <tr>
- <td><a href="#codacy">Codacy</a></td>
- <td></td>
- <td><a class="externalLink" href="https://github.com/codacy/codacy-pmdjava">github: codacy/codacy-pmdjava</a></td>
- <td>Codacy</td>
- </tr>
-
<tr>
<td><a href="#code-guide">CodeGuide</a></td>
<td></td>
@@ -49,6 +52,13 @@ author: David Dixon-Peugh <dpeugh@users.sourceforge.net>
<td><a href="https://github.com/pmd/pmd-eclipse-plugin">github: pmd/pmd-eclipse</a></td>
<td>Philippe Herlin</td>
</tr>
+
+ <tr>
+ <td>qa-Eclipse</td>
+ <td></td>
+ <td><a href="https://github.com/ChristianWulf/qa-eclipse-plugin">qa-Eclipse</a></td>
+ <td>Christian Wulf</td>
+ </tr>
<tr>
<td>eclipse-pmd</td>
@@ -158,12 +168,6 @@ the [PMDExtension jar file](http://sourceforge.net/projects/pmd/files/pmd-bluej/
and place it in your `bluej/lib/extensions/` directory.
-### Codacy
-
-Although it is not an IDE, with [Codacy](https://www.codacy.com/) you have PMDJava analysis out-of-the-box,
-and it is free for open source projects.
-
-
### Code Guide
Here's how to set up PMD with Omnicore's CodeGuide:
diff --git a/docs/pages/pmd/userdocs/understanding_rulesets.md b/docs/pages/pmd/userdocs/understanding_rulesets.md
deleted file mode 100644
index cf9ea363c6e..00000000000
--- a/docs/pages/pmd/userdocs/understanding_rulesets.md
+++ /dev/null
@@ -1,69 +0,0 @@
----
-title: Understanding Rulesets
-permalink: pmd_userdocs_understanding_rulesets.html
-summary: Rulesets are collections of rules
-last_updated: September 2017
----
-
-There are two major use cases:
-
-1. When defining a new rule, the rule needs to be defined in a ruleset. PMD's built-in rules
- are defined in specific rulesets from which the rule reference documentation is generated,
- see [Java Rules](pmd_rules_java.html) for an example.
-
- Similar rules are grouped together into the same ruleset, like the [Java Braces Ruleset](pmd_rules_java_braces.html)
- which contains rules that all deal with missing braces.
-
-2. When executing PMD you need to tell, which rules should be executed. You could directly point to the
- built-in rulesets, but then you might be overwhelmed by the found violations. As described
- in [Best Practices](pmd_userdocs_best_practices.html), it's better to define an own custom ruleset.
-
- With an own custom ruleset, you can:
-
- * Select the rules, that should be executed
- * Adjust the rule properties to exactly meet your needs
-
-## Create a custom ruleset
-
-You start by creating a new XML file with the following contents:
-
-``` xml
-<?xml version="1.0"?>
-
-<ruleset name="Custom Rules"
- xmlns="http://pmd.sourceforge.net/ruleset/3.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/3.0.0 http://pmd.sourceforge.net/ruleset_3_0_0.xsd">
- <description>
-Custom rules
- </description>
-
-</ruleset>
-```
-
-Now start to add rule by **referencing** them. Let's say, you want to start with finding
-[Empty Catch Blocks](pmd_rules_java_empty.html#emptycatchblock). Then you'd add the following
-rule reference inside the `ruleset` elements:
-
-```xml
- <rule ref="rulesets/java/empty.xml/EmptyCatchBlock" />
-```
-
-## Adjusting rule properties
-
-If you want to be less strict with empty catch blocks, you could define that an exception variable name
-of `ignored` will not raise a violation. Therefore you would reference the rule **and** define
-the appropriate property value:
-
-```xml
- <rule ref="rulesets/java/empty.xml/EmptyCatchBlock">
- <properties>
- <property name="allowExceptionNameRegex">
- <value>^ignored$</value>
- </property>
- </properties>
- </rule>
-```
-
-
-{% include note.html content="More information about rulesets can be found on [Making Rulesets](pmd_devdocs_making_rulesets.html)." %}
diff --git a/docs/pages/release_notes.md b/docs/pages/release_notes.md
index c5dbb293eca..5baf27eb744 100644
--- a/docs/pages/release_notes.md
+++ b/docs/pages/release_notes.md
@@ -4,299 +4,46 @@ permalink: pmd_release_notes.html
keywords: changelog, release notes
---
-## ????? - 6.0.0-SNAPSHOT
+## {{ site.pmd.date }} - {{ site.pmd.version }}
-The PMD team is pleased to announce PMD 6.0.0.
+The PMD team is pleased to announce PMD {{ site.pmd.version }}.
-This is a major release.
+This is a {{ site.pmd.release_type }} release.
-### Table Of Contents
-
-* [New and noteworthy](#new-and-noteworthy)
- * [Revamped Apex CPD](#revamped-apex-cpd)
- * [Java Type Resolution](#java-type-resolution)
- * [Metrics Framework](#metrics-framework)
- * [Error Reporting](#error-reporting)
- * [Java Symbol Table](#java-symbol-table)
- * [Apex Parser Update](#apex-parser-update)
- * [New Rules](#new-rules)
- * [Modified Rules](#modified-rules)
- * [Deprecated Rules](#deprecated-rules)
- * [Removed Rules](#removed-rules)
-* [Fixed Issues](#fixed-issues)
-* [API Changes](#api-changes)
-* [External Contributions](#external-contributions)
+{% tocmaker is_release_notes_processor %}
### New and noteworthy
-#### Revamped Apex CPD
-
-We are now using the Apex Jorje Lexer to tokenize Apex code for CPD. This change means:
-
-* All comments are now ignored for CPD. This is consistent with how other languages such as Java and Groovy work.
-* Tokenization honors the language specification, which improves accuracy.
-
-CPD will therefore have less false positives and false negatives.
-
-#### Java Type Resolution
-
-As part of Google Summer of Code 2017, [Bendegúz Nagy](https://github.com/WinterGrascph)'s work on type resolution for Java continues.
-For this release he has extended support for method calls for both instance and static methods.
-
-Method shadowing and overloading are supported, as are varargs. However, the selection of the target method upon the presence
-of generics and type inference is still work in progress. Expect it in forecoming releases.
-
-As for fields, the basic support was in place for release 5.8.0, but has now been expanded to support static fields.
-
-#### Metrics Framework
-
-As part of Google Summer of Code 2017, [Clément Fournier](https://github.com/oowekyala) is continuing his work
-on the new metrics framework for object-oriented metrics.
-
-There are already a couple of metrics (e.g. ATFD, WMC, Cyclo, LoC) implemented. More metrics are planned.
-Based on those metrics, rules like "GodClass" detection can be implemented more easily.
-
-The Metrics framework has been abstracted and is available in `pmd-core` for other languages. With this
-PMD release, the metrics framework is supported for both Java and Apex.
-
-#### Error Reporting
-
-A number of improvements on error reporting have taken place, meaning changes to some of the report formats.
-
-Also of note, the xml report now provides a XML Schema definition, allowing easier parsing and validation.
-
-##### Processing Errors
-
-Processing errors can now provide not only the message previously included on some reports, but also a full stacktrace.
-This will allow better error reports when providing feedback to the PMD team and help in debugging issues.
-
-The report formats providing full stacktrace of errors are:
-
-* html
-* summaryhtml
-* textcolor
-* vbhtml
-* xml
-
-#####Â Configuration Errors
-
-For a long time reports have been notified of configuration errors on rules, but they have remained hidden.
-On a push to make these more evident to users, and help them get the best results out of PMD, we have started
-to include them on the reports.
-
-So far, only reports that include processing errors are showing configuration errors. In other words, the report formats
-providing configuration error reporting are:
-
-* csv
-* html
-* summaryhtml
-* text
-* textcolor
-* vbhtml
-* xml
-
-As we move forward we will be able to detect and report more configuration errors (ie: incomplete `auxclasspath`)
-and include them to such reports.
-
#### New Rules
-* The rule `NcssCount` (ruleset `java-codesize`) replaces the three rules "NcssConstructorCount", "NcssMethodCount",
- and "NcssTypeCount". The new rule uses the metrics framework to achieve the same. It has two properties, to
- define the report level for method and class sizes separately. Constructors and methods are considered the same.
-
-* The new rule `ForLoopCanBeForeach` (ruleset `java-migration`) helps to identify those for-loops that can
- be safely refactored into for-each-loops available since java 1.5.
-
-#### Modified Rules
-
-* The rule `UnnecessaryFinalModifier` (ruleset `java-unnecessarycode`) has been revamped to detect more cases.
- It will now flag anonymous class' methods marked as final (can't be overridden, so it's pointless), along with
- final methods overridden / defined within enum instances.
-
-* The rule `UnnecessaryParentheses` (ruleset `java-controversial`) has been merged into `UselessParentheses`
- (ruleset `java-unnecessary`). The rule covers all scenarios previously covered by either rule.
-
-* The rule `UncommentedEmptyConstructor` (ruleset `java-design`) will now ignore empty constructors annotated with
- `javax.inject.Inject`.
-
-* The rule `AbstractClassWithoutAnyMethod` (ruleset `java-design`) will now ignore classes annotated with
- `com.google.auto.value.AutoValue`.
-
-* The rule `GodClass` (ruleset `java-design`) has been revamped to use the new metrics framework.
-
-#### Deprecated Rules
-
-* The rules `NcssConstructorCount`, `NcssMethodCount`, and `NcssTypeCount` (ruleset `java-codesize`) have been
- deprecated. They will be replaced by the new rule `NcssCount` in the same ruleset.
-
-#### Removed Rules
-
-* The deprecated rule `UseSingleton` has been removed from the ruleset `java-design`. The rule has been renamed
- long time ago to `UseUtilityClass`.
-
-#### Java Symbol Table
-
-A [bug in symbol table](https://github.com/pmd/pmd/pull/549/commits/0958621ca884a8002012fc7738308c8dfc24b97c) prevented
-the symbol table analysis to properly match primitive arrays types. The issue [affected the `java-unsedcode/UnusedPrivateMethod`](https://github.com/pmd/pmd/issues/521)
-rule, but other rules may now produce improved results as consequence of this fix.
-
-#### Apex Parser Update
-
-The Apex parser version was bumped, from `1.0-sfdc-187` to `1.0-sfdc-224`. This update let us take full advantage
-of the latest improvements from Salesforce, but introduces some breaking changes:
-
-* `BlockStatements` are now created for all control structures, even if no brace is used. We have therefore added
- a `hasCurlyBrace` method to differentiate between both scenarios.
-* New AST node types are available. In particular `CastExpression`, `ConstructorPreamble`, `IllegalStoreExpression`,
- `MethodBlockStatement`, `Modifier`, `MultiStatement`, `NestedExpression`, `NestedStoreExpression`,
- `NewKeyValueObjectExpression` and `StatementExecuted`
-* Some nodes have been removed. Such is the case of `TestNode`, `DottedExpression` and `NewNameValueObjectExpression`
- (replaced by `NewKeyValueObjectExpression`)
-
-All existing rules have been updated to reflect these changes. If you have custom rules, be sure to update them.
+* The new Java rule {% rule "java/codestyle/UseUnderscoresInNumericLiterals" %} (`java-codestyle`)
+ verifies that numeric literals over a given length (4 chars by default, but configurable) are using
+ underscores every 3 digits for readability. The rule only applies to Java 7+ codebases.
### Fixed Issues
+* all
+ * [#1284](https://github.com/pmd/pmd/issues/1284): \[doc] Keep record of every currently deprecated API
* all
- * [#532](https://github.com/pmd/pmd/issues/532): \[core] security concerns on URL-based rulesets
- * [#538](https://github.com/pmd/pmd/issues/538): \[core] Provide an XML Schema for XML reports
- * [#600](https://github.com/pmd/pmd/issues/600): \[core] Nullpointer while creating cache File
-* apex
- * [#488](https://github.com/pmd/pmd/pull/488): \[apex] Use Apex lexer for CPD
- * [#489](https://github.com/pmd/pmd/pull/489): \[apex] Update Apex compiler
- * [#500](https://github.com/pmd/pmd/issues/500): \[apex] Running through CLI shows jorje optimization messages
-* cpp
- * [#448](https://github.com/pmd/pmd/issues/448): \[cpp] Write custom CharStream to handle continuation characters
-* java
- * [#1513](https://sourceforge.net/p/pmd/bugs/1513/): \[java] Remove deprecated rule UseSingleton
- * [#487](https://github.com/pmd/pmd/pull/487): \[java] Fix typeresolution for anonymous extending object
- * [#496](https://github.com/pmd/pmd/issues/496): \[java] processing error on generics inherited from enclosing class
- * [#527](https://github.com/pmd/pmd/issues/527): \[java] Lombok getter annotation on enum is not recognized correctly
-* java-basic
- * [#565](https://github.com/pmd/pmd/pull/565): \[java] False negative on DontCallThreadRun when extending Thread
-* java-comments
- * [#536](https://github.com/pmd/pmd/issues/536): \[java] CommentDefaultAccessModifierRule ignores constructors
-* java-controversial
- * [#388](https://github.com/pmd/pmd/issues/388): \[java] controversial.AvoidLiteralsInIfCondition 0.0 false positive
- * [#408](https://github.com/pmd/pmd/issues/408): \[java] DFA not analyzing asserts
- * [#537](https://github.com/pmd/pmd/issues/537): \[java] UnnecessaryParentheses fails to detect obvious scenario
-* java-design
- * [#357](https://github.com/pmd/pmd/issues/357): \[java] UncommentedEmptyConstructor consider annotations on Constructor
- * [#438](https://github.com/pmd/pmd/issues/438): \[java] Relax AbstractClassWithoutAnyMethod when class is annotated by @AutoValue
- * [#590](https://github.com/pmd/pmd/issues/590): \[java] False positive on MissingStaticMethodInNonInstantiatableClass
-* java-sunsecure
- * [#468](https://github.com/pmd/pmd/issues/468): \[java] ArrayIsStoredDirectly false positive
-* java-unusedcode
- * [#521](https://github.com/pmd/pmd/issues/521): \[java] UnusedPrivateMethod returns false positives with primitive data type in map argument
-* java-unnecessarycode
- * [#412](https://github.com/pmd/pmd/issues/412): \[java] java-unnecessarycode/UnnecessaryFinalModifier missing cases
+ * [#1318](https://github.com/pmd/pmd/issues/1318): \[test] Kotlin DSL to ease test writing
+ * [#1341](https://github.com/pmd/pmd/issues/1341): \[doc] Documentation Error with Regex Properties
+* java-codestyle
+ * [#1232](https://github.com/pmd/pmd/issues/1232): \[java] Detector for large numbers not separated by _
+ * [#1372](https://github.com/pmd/pmd/issues/1372): \[java] false positive for UselessQualifiedThis
### API Changes
-* The class `net.sourceforge.pmd.lang.dfa.NodeType` has been converted to an enum.
- All node types are enum members now instead of int constants. The names for node types are retained.
-
-* The properties API (rule and report properties) have been revamped to be fully typesafe. This is everything
- around `net.sourceforge.pmd.PropertyDescriptor`.
-
-* The rule classes `net.sourceforge.pmd.lang.apex.rule.apexunit.ApexUnitTestClassShouldHaveAsserts`
- and `net.sourceforge.pmd.lang.apex.rule.apexunit.ApexUnitTestShouldNotUseSeeAllDataTrue` have been
- renamed to `ApexUnitTestClassShouldHaveAssertsRule` and `ApexUnitTestShouldNotUseSeeAllDataTrueRule`,
- respectively. This is to comply with the naming convention, that each rule class should be suffixed with "Rule".
- This change has no impact on custom rulesets, since the rule names themselves didn't change.
-
-* The never implemented method `PMD.processFiles(PMDConfiguration, RuleSetFactory, Collection<File>, RuleContext, ProgressMonitor)` along with the interface `ProgressMonitor` has been removed.
-
-* All APIs deprecated in older versions are now removed. This includes:
- * `Renderer.getPropertyDefinitions`
- * `AbstractRenderer.defineProperty(String, String)`
- * `AbstractRenderer.propertyDefinitions`
- * `ReportListener`
- * `Report.addListener(ReportListener)`
- * `SynchronizedReportListener`
- * `CPDConfiguration.CPDConfiguration(int, Language, String)`
- * `CPDConfiguration.getRendererFromString(String)`
- * `StreamUtil`
- * `StringUtil.appendXmlEscaped(StringBuilder, String)`
- * `StringUtil.htmlEncode(String)`
-
-
-* Several methods in `net.sourceforge.pmd.util.CollectionUtil` have been deprecated and will be removed in PMD 7.0.0. In particular:
- * `CollectionUtil.addWithoutDuplicates(T[], T)`
- * `CollectionUtil.addWithoutDuplicates(T[], T[])`
- * `CollectionUtil.areSemanticEquals(T[], T[])`
- * `CollectionUtil.areEqual(Object, Object)`
- * `CollectionUtil.arraysAreEqual(Object, Object)`
- * `CollectionUtil.valuesAreTransitivelyEqual(Object[], Object[])`
+* The implementation of the adapters for the XPath engines Saxon and Jaxen (package `net.sourceforge.pmd.lang.ast.xpath`)
+ are now deprecated. They'll be moved to an internal package come 7.0.0. Only `Attribute` remains public API.
+### External Contributions
-* Several methods in `net.sourceforge.pmd.util.StringUtil` have been deprecated and will be removed in PMD 7.0.0. In particular:
- * `StringUtil.startsWithAny(String, String[])`
- * `StringUtil.isNotEmpty(String)`
- * `StringUtil.isEmpty(String)`
- * `StringUtil.isMissing(String)`
- * `StringUtil.areSemanticEquals(String, String)`
- * `StringUtil.replaceString(String, String, String)`
- * `StringUtil.replaceString(String, char, String)`
- * `StringUtil.substringsOf(String, char)`
- * `StringUtil.substringsOf(String, String)`
- * `StringUtil.asStringOn(StringBuffer, Iterator, String)`
- * `StringUtil.asStringOn(StringBuilder, Object[], String)`
- * `StringUtil.lpad(String, int)`
+* [#1384](https://github.com/pmd/pmd/pull/1384): \[java] New Rule - UseUnderscoresInNumericLiterals - [RajeshR](https://github.com/rajeshggwp)
+* [#1424](https://github.com/pmd/pmd/pull/1424): \[doc] #1341 Updating Regex Values in default Value Property - [avishvat](https://github.com/vishva007)
+* [#1428](https://github.com/pmd/pmd/pull/1428): \[core] Upgrading JCommander from 1.48 to 1.72 - [Thunderforge](https://github.com/Thunderforge)
+* [#1430](https://github.com/pmd/pmd/pull/1430): \[doc] Who really knows regex? - [Dem Pilafian](https://github.com/dpilafian)
-* The class `net.sourceforge.pmd.lang.java.typeresolution.typedefinition.JavaTypeDefinition` is now abstract, and has been enhanced
- to provide several new methods.
+{% endtocmaker %}
-### External Contributions
+{% include note.html content="The release notes of previous versions are available [here](pmd_release_notes_old.html)" %}
-* [#420](https://github.com/pmd/pmd/pull/420): \[java] Fix UR anomaly in assert statements - [Clément Fournier](https://github.com/oowekyala)
-* [#482](https://github.com/pmd/pmd/pull/482): \[java] Metrics testing framework + improved capabilities for metrics - [Clément Fournier](https://github.com/oowekyala)
-* [#484](https://github.com/pmd/pmd/pull/484): \[core] Changed linux usage to a more unix like path - [patriksevallius](https://github.com/patriksevallius)
-* [#486](https://github.com/pmd/pmd/pull/486): \[java] Add basic method typeresolution - [Bendegúz Nagy](https://github.com/WinterGrascph)
-* [#492](https://github.com/pmd/pmd/pull/492): \[java] Typeresolution for overloaded methods - [Bendegúz Nagy](https://github.com/WinterGrascph)
-* [#495](https://github.com/pmd/pmd/pull/495): \[core] Custom rule reinitialization code - [Clément Fournier](https://github.com/oowekyala)
-* [#479](https://github.com/pmd/pmd/pull/479): \[core] Typesafe and immutable properties - [Clément Fournier](https://github.com/oowekyala)
-* [#499](https://github.com/pmd/pmd/pull/499): \[java] Metrics memoization tests - [Clément Fournier](https://github.com/oowekyala)
-* [#501](https://github.com/pmd/pmd/pull/501): \[java] Add support for most specific vararg method type resolution - [Bendegúz Nagy](https://github.com/WinterGrascph)
-* [#502](https://github.com/pmd/pmd/pull/502): \[java] Add support for static field type resolution - [Bendegúz Nagy](https://github.com/WinterGrascph)
-* [#505](https://github.com/pmd/pmd/pull/505): \[java] Followup on metrics - [Clément Fournier](https://github.com/oowekyala)
-* [#506](https://github.com/pmd/pmd/pull/506): \[java] Add reduction rules to type inference - [Bendegúz Nagy](https://github.com/WinterGrascph)
-* [#511](https://github.com/pmd/pmd/pull/511): \[core] Prepare abstraction of the metrics framework - [Clément Fournier](https://github.com/oowekyala)
-* [#512](https://github.com/pmd/pmd/pull/512): \[java] Add incorporation to type inference - [Bendegúz Nagy](https://github.com/WinterGrascph)
-* [#513](https://github.com/pmd/pmd/pull/513): \[java] Fix for maximally specific method selection - [Bendegúz Nagy](https://github.com/WinterGrascph)
-* [#514](https://github.com/pmd/pmd/pull/514): \[java] Add static method type resolution - [Bendegúz Nagy](https://github.com/WinterGrascph)
-* [#517](https://github.com/pmd/pmd/pull/517): \[doc] Metrics documentation - [Clément Fournier](https://github.com/oowekyala)
-* [#518](https://github.com/pmd/pmd/pull/518): \[core] Properties refactoring: factorized enumerated property - [Clément Fournier](https://github.com/oowekyala)
-* [#523](https://github.com/pmd/pmd/pull/523): \[java] Npath complexity metric and rule - [Clément Fournier](https://github.com/oowekyala)
-* [#524](https://github.com/pmd/pmd/pull/524): \[java] Add support for explicit type arguments with method invocation - [Bendegúz Nagy](https://github.com/WinterGrascph)
-* [#525](https://github.com/pmd/pmd/pull/525): \[core] Fix line ending and not ignored files issues - [Matias Comercio](https://github.com/MatiasComercio)
-* [#528](https://github.com/pmd/pmd/pull/528): \[core] Fix typo - [Ayoub Kaanich](https://github.com/kayoub5)
-* [#529](https://github.com/pmd/pmd/pull/529): \[java] Abstracted the Java metrics framework - [Clément Fournier](https://github.com/oowekyala)
-* [#530](https://github.com/pmd/pmd/pull/530): \[java] Fix issue #527: Lombok getter annotation on enum is not recognized correctly - [Clément Fournier](https://github.com/oowekyala)
-* [#533](https://github.com/pmd/pmd/pull/533): \[core] improve error message - [Dennis Kieselhorst](https://github.com/deki)
-* [#535](https://github.com/pmd/pmd/pull/535): \[apex] Fix broken Apex visitor adapter - [Clément Fournier](https://github.com/oowekyala)
-* [#542](https://github.com/pmd/pmd/pull/542): \[java] Metrics abstraction - [Clément Fournier](https://github.com/oowekyala)
-* [#545](https://github.com/pmd/pmd/pull/545): \[apex] Apex metrics framework - [Clément Fournier](https://github.com/oowekyala)
-* [#548](https://github.com/pmd/pmd/pull/548): \[java] Metrics documentation - [Clément Fournier](https://github.com/oowekyala)
-* [#550](https://github.com/pmd/pmd/pull/550): \[java] Add basic resolution to type inference - [Bendegúz Nagy](https://github.com/WinterGrascph)
-* [#553](https://github.com/pmd/pmd/pull/553): \[java] Refactored ParserTst into a static utility class + add getSourceFromClass - [Clément Fournier](https://github.com/oowekyala)
-* [#554](https://github.com/pmd/pmd/pull/554): \[java] Fix #537: UnnecessaryParentheses fails to detect obvious scenario - [Clément Fournier](https://github.com/oowekyala)
-* [#555](https://github.com/pmd/pmd/pull/555): \[java] Changed metrics/CyclomaticComplexityRule to use WMC when reporting classes - [Clément Fournier](https://github.com/oowekyala)
-* [#556](https://github.com/pmd/pmd/pull/556): \[java] Fix #357: UncommentedEmptyConstructor consider annotations on Constructor - [Clément Fournier](https://github.com/oowekyala)
-* [#557](https://github.com/pmd/pmd/pull/557): \[java] Fix NPath metric not counting ternaries correctly - [Clément Fournier](https://github.com/oowekyala)
-* [#563](https://github.com/pmd/pmd/pull/563): \[java] Add support for basic method type inference for strict invocation - [Bendegúz Nagy](https://github.com/WinterGrascph)
-* [#566](https://github.com/pmd/pmd/pull/566): \[java] New rule in migrating ruleset: ForLoopCanBeForeach - [Clément Fournier](https://github.com/oowekyala)
-* [#567](https://github.com/pmd/pmd/pull/567): \[java] Last API change for metrics (metric options) - [Clément Fournier](https://github.com/oowekyala)
-* [#570](https://github.com/pmd/pmd/pull/570): \[java] Model lower, upper and intersection types - [Bendegúz Nagy](https://github.com/WinterGrascph)
-* [#573](https://github.com/pmd/pmd/pull/573): \[java] Data class rule - [Clément Fournier](https://github.com/oowekyala)
-* [#576](https://github.com/pmd/pmd/pull/576): \[doc]\[java] Add hint for Guava users in InefficientEmptyStringCheck - [mmoehring](https://github.com/mmoehring)
-* [#578](https://github.com/pmd/pmd/pull/578): \[java] Refactored god class rule - [Clément Fournier](https://github.com/oowekyala)
-* [#579](https://github.com/pmd/pmd/pull/579): \[java] Update parsing to produce upper and lower bounds - [Bendegúz Nagy](https://github.com/WinterGrascph)
-* [#580](https://github.com/pmd/pmd/pull/580): \[core] Add AbstractMetric to topple the class hierarchy of metrics - [Clément Fournier](https://github.com/oowekyala)
-* [#581](https://github.com/pmd/pmd/pull/581): \[java] Relax AbstractClassWithoutAnyMethod when class is annotated by @AutoValue - [Niklas Baudy](https://github.com/vanniktech)
-* [#583](https://github.com/pmd/pmd/pull/583): \[java] Documentation about writing metrics - [Clément Fournier](https://github.com/oowekyala)
-* [#585](https://github.com/pmd/pmd/pull/585): \[java] Moved NcssCountRule to codesize.xml - [Clément Fournier](https://github.com/oowekyala)
-* [#587](https://github.com/pmd/pmd/pull/587): \[core] Properties refactoring: Move static constants of ValueParser to class ValueParserConstants - [Clément Fournier](https://github.com/oowekyala)
-* [#588](https://github.com/pmd/pmd/pull/588): \[java] XPath function to compute metrics - [Clément Fournier](https://github.com/oowekyala)
-* [#598](https://github.com/pmd/pmd/pull/598): \[java] Fix #388: controversial.AvoidLiteralsInIfCondition 0.0 false positive - [Clément Fournier](https://github.com/oowekyala)
-* [#620](https://github.com/pmd/pmd/pull/620): \[core] Moved properties to n.s.pmd.properties - [Clément Fournier](https://github.com/oowekyala)
diff --git a/docs/pages/release_notes_old.md b/docs/pages/release_notes_old.md
index 4278cd080db..d7110b64736 100644
--- a/docs/pages/release_notes_old.md
+++ b/docs/pages/release_notes_old.md
@@ -3,8 +3,1743 @@ title: Old Release Notes
permalink: pmd_release_notes_old.html
---
-Previous versions of PMD can be downloaded here:
-http://sourceforge.net/projects/pmd/files/pmd/
+Previous versions of PMD can be downloaded here: https://github.com/pmd/pmd/releases
+
+## 28-October-2018 - 6.9.0
+
+The PMD team is pleased to announce PMD 6.9.0.
+
+This is a minor release.
+
+### Table Of Contents
+
+* [New and noteworthy](#new-and-noteworthy)
+ * [Improved Golang CPD Support](#improved-golang-cpd-support)
+ * [New Rules](#new-rules)
+* [Fixed Issues](#fixed-issues)
+* [API Changes](#api-changes)
+* [External Contributions](#external-contributions)
+
+### New and noteworthy
+
+#### Improved Golang CPD Support
+
+Thanks to the work of [ITBA](https://www.itba.edu.ar/) students [MatÃas Fraga](https://github.com/matifraga),
+[Tomi De Lucca](https://github.com/tomidelucca) and [Lucas Soncini](https://github.com/lsoncini),
+Golang is now backed by a proper Antlr Grammar. This means CPD is now better at detecting duplicates,
+as comments are recognized as such and ignored.
+
+#### New Rules
+
+* The new PLSQL rule [`CodeFormat`](https://pmd.github.io/pmd-6.9.0/pmd_rules_plsql_codestyle.html#codeformat) (`plsql-codestyle`) verifies that
+ PLSQL code is properly formatted. It checks e.g. for correct indentation in select statements and verifies
+ that each parameter is defined on a separate line.
+
+### Fixed Issues
+
+* all
+ * [#649](https://github.com/pmd/pmd/issues/649): \[core] Exclude specific files from command line
+ * [#1272](https://github.com/pmd/pmd/issues/1272): \[core] Could not find or load main class when using symlinked run.sh
+ * [#1377](https://github.com/pmd/pmd/issues/1377): \[core] LanguageRegistry uses default class loader when invoking ServiceLocator
+ * [#1394](https://github.com/pmd/pmd/issues/1394): \[doc] How to configure "-cache <path>"
+ * [#1412](https://github.com/pmd/pmd/issues/1412): \[doc] Broken link to adding new cpd language documentation
+* apex
+ * [#1396](https://github.com/pmd/pmd/issues/1396): \[apex] ClassCastException caused by Javadoc
+* java
+ * [#1330](https://github.com/pmd/pmd/issues/1330): \[java] PMD crashes with java.lang.ClassFormatError: Absent Code attribute in method that is not native or abstract in class file javax/xml/ws/Service
+* java-bestpractices
+ * [#1202](https://github.com/pmd/pmd/issues/1202): \[java] GuardLogStatement: "There is log block not surrounded by if" doesn't sound right
+ * [#1209](https://github.com/pmd/pmd/issues/1209): \[java] UnusedImports false positive for static import with package-private method usage
+ * [#1343](https://github.com/pmd/pmd/issues/1343): \[java] Update CommentDefaultAccessModifierRule to extend AbstractIgnoredAnnotationRule
+ * [#1365](https://github.com/pmd/pmd/issues/1365): \[java] JUnitTestsShouldIncludeAssert false positive
+ * [#1404](https://github.com/pmd/pmd/issues/1404): \[java] UnusedImports false positive with static ondemand import with method call
+* java-codestyle
+ * [#1199](https://github.com/pmd/pmd/issues/1199): \[java] UnnecessaryFullyQualifiedName doesn't flag same package FQCNs
+ * [#1356](https://github.com/pmd/pmd/issues/1356): \[java] UnnecessaryModifier wrong message public-\>static
+* java-design
+ * [#1369](https://github.com/pmd/pmd/issues/1369): \[java] Processing error (ClassCastException) if a TYPE\_USE annotation is used on a base class in the "extends" clause
+* jsp
+ * [#1402](https://github.com/pmd/pmd/issues/1402): \[jsp] JspTokenManager has a problem about jsp scriptlet
+* documentation
+ * [#1349](https://github.com/pmd/pmd/pull/1349): \[doc] Provide some explanation for WHY duplicate code is bad, like mutations
+
+### API Changes
+
+* PMD has a new CLI option `-ignorelist`. With that, you can provide a file containing a comma-delimit list of files,
+ that should be excluded during analysis. The ignorelist is applied after the files have been selected
+ via `-dir` or `-filelist`, which means, if the file is in both lists, then it will be ignored.
+ Note: there is no corresponding option for the Ant task, since the feature is already available via
+ Ant's FileSet include/exclude filters.
+
+### External Contributions
+
+* [#1338](https://github.com/pmd/pmd/pull/1338): \[core] \[cpd] Generalize ANTLR tokens preparing support for ANTLR token filter - [MatÃas Fraga](https://github.com/matifraga) and [Tomi De Lucca](https://github.com/tomidelucca)
+* [#1361](https://github.com/pmd/pmd/pull/1361): \[doc] Update cpd.md with information about risks - [David M. Karr](https://github.com/davidmichaelkarr)
+* [#1366](https://github.com/pmd/pmd/pull/1366): \[java] Static Modifier on Internal Interface pmd #1356 - [avishvat](https://github.com/vishva007)
+* [#1368](https://github.com/pmd/pmd/pull/1368): \[doc] Updated outdated note in the building documentation. - [Maikel Steneker](https://github.com/maikelsteneker)
+* [#1374](https://github.com/pmd/pmd/pull/1374): \[java] Simplify check for 'Test' annotation in JUnitTestsShouldIncludeAssertRule. - [Will Winder](https://github.com/winder)
+* [#1375](https://github.com/pmd/pmd/pull/1375): \[java] Add missing null check AbstractJavaAnnotatableNode - [Will Winder](https://github.com/winder)
+* [#1376](https://github.com/pmd/pmd/pull/1376): \[all] Upgrading Apache Commons IO from 2.4 to 2.6 - [Thunderforge](https://github.com/Thunderforge)
+* [#1378](https://github.com/pmd/pmd/pull/1378): \[all] Upgrading Apache Commons Lang 3 from 3.7 to 3.8.1 - [Thunderforge](https://github.com/Thunderforge)
+* [#1382](https://github.com/pmd/pmd/pull/1382): \[all] Replacing deprecated IO methods with ones that specify a charset - [Thunderforge](https://github.com/Thunderforge)
+* [#1383](https://github.com/pmd/pmd/pull/1383): \[java] Improved message for GuardLogStatement rule - [Felix Lampe](https://github.com/fblampe)
+* [#1386](https://github.com/pmd/pmd/pull/1386): \[go] \[cpd] Add CPD support for Antlr based grammar on Golang - [MatÃas Fraga](https://github.com/matifraga)
+* [#1398](https://github.com/pmd/pmd/pull/1398): \[all] Upgrading SLF4J from 1.7.12 to 1.7.25 - [Thunderforge](https://github.com/Thunderforge)
+* [#1400](https://github.com/pmd/pmd/pull/1400): \[java] Fix Issue 1343: Update CommentDefaultAccessModifierRule - [CrazyUnderdog](https://github.com/CrazyUnderdog)
+* [#1401](https://github.com/pmd/pmd/pull/1401): \[all] Replacing IOUtils.closeQuietly(foo) with try-with-resources statements - [Thunderforge](https://github.com/Thunderforge)
+* [#1406](https://github.com/pmd/pmd/pull/1406): \[jsp] Fix issue 1402: JspTokenManager has a problem about jsp scriptlet - [JustPRV](https://github.com/JustPRV)
+* [#1411](https://github.com/pmd/pmd/pull/1411): \[core] Add ignore file path functionality - [Jon Moroney](https://github.com/darakian)
+* [#1414](https://github.com/pmd/pmd/pull/1414): \[doc] Fix broken link. Fixes #1412 - [Johan Hammar](https://github.com/johanhammar)
+
+
+## 30-September-2018 - 6.8.0
+
+The PMD team is pleased to announce PMD 6.8.0.
+
+This is a minor release.
+
+### Table Of Contents
+
+* [New and noteworthy](#new-and-noteworthy)
+ * [Drawing a line between private and public API](#drawing-a-line-between-private-and-public-api)
+ * [`.internal` packages and `@InternalApi` annotation](#`.internal`-packages-and-`@internalapi`-annotation)
+ * [`@ReservedSubclassing`](#`@reservedsubclassing`)
+ * [`@Experimental`](#`@experimental`)
+ * [`@Deprecated`](#`@deprecated`)
+ * [The transition](#the-transition)
+ * [Quickstart Ruleset](#quickstart-ruleset)
+ * [New Rules](#new-rules)
+ * [Modified Rules](#modified-rules)
+ * [PLSQL](#plsql)
+* [Fixed Issues](#fixed-issues)
+* [API Changes](#api-changes)
+* [External Contributions](#external-contributions)
+
+### New and noteworthy
+
+#### Drawing a line between private and public API
+
+Until now, all released public members and types were implicitly considered part
+of PMD's public API, including inheritance-specific members (protected members, abstract methods).
+We have maintained those APIs with the goal to preserve full binary compatibility between minor releases,
+only breaking those APIs infrequently, for major releases.
+
+In order to allow PMD to move forward at a faster pace, this implicit contract will
+be invalidated with PMD 7.0.0. We now introduce more fine-grained distinctions between
+the type of compatibility support we guarantee for our libraries, and ways to make
+them explicit to clients of PMD.
+
+###### `.internal` packages and `@InternalApi` annotation
+
+*Internal API* is meant for use *only* by the main PMD codebase. Internal types and methods
+may be modified in any way, or even removed, at any time.
+
+Any API in a package that contains an `.internal` segment is considered internal.
+The `@InternalApi` annotation will be used for APIs that have to live outside of
+these packages, e.g. methods of a public type that shouldn't be used outside of PMD (again,
+these can be removed anytime).
+
+###### `@ReservedSubclassing`
+
+Types marked with the `@ReservedSubclassing` annotation are only meant to be subclassed
+by classes within PMD. As such, we may add new abstract methods, or remove protected methods,
+at any time. All published public members remain supported. The annotation is *not* inherited, which
+means a reserved interface doesn't prevent its implementors to be subclassed.
+
+###### `@Experimental`
+
+APIs marked with the `@Experimental` annotation at the class or method level are subject to change.
+They can be modified in any way, or even removed, at any time. You should not use or rely
+ on them in any production code. They are purely to allow broad testing and feedback.
+
+###### `@Deprecated`
+
+APIs marked with the `@Deprecated` annotation at the class or method level will remain supported
+until the next major release but it is recommended to stop using them.
+
+###### The transition
+
+*All currently supported APIs will remain so until 7.0.0*. All APIs that are to be moved to
+`.internal` packages or hidden will be tagged `@InternalApi` before that major release, and
+the breaking API changes will be performed in 7.0.0.
+
+
+#### Quickstart Ruleset
+
+PMD 6.8.0 provides a first quickstart ruleset for Java, which you can use as a base ruleset to get your
+custom ruleset started. You can reference it with `rulesets/java/quickstart.xml`.
+You are strongly encouraged to [create your own ruleset](https://pmd.github.io/pmd-6.7.0/pmd_userdocs_making_rulesets.html)
+though.
+
+The quickstart ruleset has the intention, to be useful out-of-the-box for many projects. Therefore it
+references only rules, that are most likely to apply everywhere.
+
+Any feedback would be greatly appreciated.
+
+
+#### New Rules
+
+* The new Apex rule [`ApexDoc`](https://pmd.github.io/pmd-6.8.0/pmd_rules_apex_documentation.html#apexdoc) (`apex-documentation`)
+ enforces the inclusion of ApexDoc on classes, interfaces, properties and methods; as well as some
+ sanity rules for such docs (no missing parameters, parameters' order, and return value). By default,
+ method overrides and test classes are allowed to not include ApexDoc.
+
+
+#### Modified Rules
+
+* The rule [`MissingSerialVersionUID`](https://pmd.github.io/pmd-6.8.0/pmd_rules_java_errorprone.html#missingserialversionuid) (`java-errorprone`) has been modified
+ in order to recognize also missing `serialVersionUID` fields in abstract classes, if they are serializable.
+ Each individual class in the inheritance chain needs an own serialVersionUID field. See also [Should an abstract class have a serialVersionUID](https://stackoverflow.com/questions/893259/should-an-abstract-class-have-a-serialversionuid).
+ This change might lead to additional violations in existing code bases.
+
+
+#### PLSQL
+
+The grammar for PLSQL has been revamped in order to fully parse `SELECT INTO`, `UPDATE`, and `DELETE`
+statements. Previously such statements have been simply skipped ahead, now PMD is parsing them, giving access
+to the individual parts of a SELECT-statement, such as the Where-Clause. This might produce new parsing errors
+where PMD previously could successfully parse PLSQL code. If this happens, please report a new [issue](https://github.com/pmd/pmd/issues/new) to get this problem fixed.
+
+
+### Fixed Issues
+
+* apex-bestpractices
+ * [#1348](https://github.com/pmd/pmd/issues/1348): \[apex] AvoidGlobalModifierRule gives warning even when its a webservice - false positive
+* java-codestyle
+ * [#1329](https://github.com/pmd/pmd/issues/1329): \[java] FieldNamingConventions: false positive in serializable class with serialVersionUID
+ * [#1334](https://github.com/pmd/pmd/issues/1334): \[java] LinguisticNaming should support AtomicBooleans
+* java-errorprone
+ * [#1350](https://github.com/pmd/pmd/issues/1350): \[java] MissingSerialVersionUID false-positive on interfaces
+ * [#1352](https://github.com/pmd/pmd/issues/1352): \[java] MissingSerialVersionUID false-negative with abstract classes
+* java-performance
+ * [#1325](https://github.com/pmd/pmd/issues/1325): \[java] False positive in ConsecutiveLiteralAppends
+* plsql
+ * [#1279](https://github.com/pmd/pmd/pull/1279): \[plsql] Support for SELECT INTO
+
+
+### API Changes
+
+* A couple of methods and fields in `net.sourceforge.pmd.properties.AbstractPropertySource` have been
+ deprecated, as they are replaced by already existing functionality or expose internal implementation
+ details: `propertyDescriptors`, `propertyValuesByDescriptor`,
+ `copyPropertyDescriptors()`, `copyPropertyValues()`, `ignoredProperties()`, `usesDefaultValues()`,
+ `useDefaultValueFor()`.
+
+* Some methods in `net.sourceforge.pmd.properties.PropertySource` have been deprecated as well:
+ `usesDefaultValues()`, `useDefaultValueFor()`, `ignoredProperties()`.
+
+* The class `net.sourceforge.pmd.lang.rule.AbstractDelegateRule` has been deprecated and will
+ be removed with PMD 7.0.0. It is internally only in use by RuleReference.
+
+* The default constructor of `net.sourceforge.pmd.lang.rule.RuleReference` has been deprecated
+ and will be removed with PMD 7.0.0. RuleReferences should only be created by providing a Rule and
+ a RuleSetReference. Furthermore the following methods are deprecated: `setRuleReference()`,
+ `hasOverriddenProperty()`, `usesDefaultValues()`, `useDefaultValueFor()`.
+
+
+### External Contributions
+
+* [#1309](https://github.com/pmd/pmd/pull/1309): \[core] \[CPD] Decouple Antlr Tokenizer implementation from any CPD language supported with Antlr - [MatÃas Fraga](https://github.com/matifraga)
+* [#1314](https://github.com/pmd/pmd/pull/1314): \[apex] Add validation of ApexDoc comments - [Jeff Hube](https://github.com/jeffhube)
+* [#1339](https://github.com/pmd/pmd/pull/1339): \[ci] Improve danger message - [BBG](https://github.com/djydewang)
+* [#1340](https://github.com/pmd/pmd/pull/1340): \[java] Derive correct classname for non-public non-classes - [kris-scheibe](https://github.com/kris-scheibe)
+* [#1357](https://github.com/pmd/pmd/pull/1357): \[doc] Improve Codacy description - [Daniel Reigada](https://github.com/DReigada)
+
+
+## 02-September-2018 - 6.7.0
+
+The PMD team is pleased to announce PMD 6.7.0.
+
+This is a minor release.
+
+### Table Of Contents
+
+* [New and noteworthy](#new-and-noteworthy)
+ * [Modified Rules](#modified-rules)
+ * [New Rules](#new-rules)
+ * [Deprecated Rules](#deprecated-rules)
+* [Fixed Issues](#fixed-issues)
+* [API Changes](#api-changes)
+* [External Contributions](#external-contributions)
+
+### New and noteworthy
+
+#### Modified Rules
+
+* The Java rule {% rule java/bestpractices/OneDeclarationPerLine %} (`java-bestpractices`) has been revamped to
+ consider not only local variable declarations, but field declarations too.
+
+#### New Rules
+
+* The new Java rule {% rule java/codestyle/LinguisticNaming %} (`java-codestyle`)
+ detects cases, when a method name indicates it returns a boolean (such as `isSmall()`) but it doesn't.
+ Besides method names, the rule also checks field and variable names. It also checks, that getters return
+ something but setters won't. The rule has several properties with which it can be customized.
+
+* The new PL/SQL rule {% rule plsql/codestyle/ForLoopNaming %} (`plsql-codestyle`)
+ enforces a naming convention for "for loops". Both "cursor for loops" and "index for loops" are covered.
+ The rule can be customized via patterns. By default, short variable names are reported.
+
+* The new Java rule {% rule java/codestyle/FieldNamingConventions %} (`java-codestyle`)
+ detects field names that don't comply to a given convention. It defaults to standard Java convention of using camelCase,
+ but can be configured with ease for e.g. constants or static fields.
+
+* The new Apex rule {% rule apex/codestyle/OneDeclarationPerLine %} (`apex-codestyle`) enforces declaring a
+ single field / variable per line; or per statement if the `strictMode` property is set.
+ It's an Apex equivalent of the already existing Java rule of the same name.
+
+#### Deprecated Rules
+
+* The Java rules {% rule java/codestyle/VariableNamingConventions %}, {% rule java/codestyle/MIsLeadingVariableName %},
+ {% rule java/codestyle/SuspiciousConstantFieldName %}, and {% rule java/codestyle/AvoidPrefixingMethodParameters %} are
+ now deprecated, and will be removed with version 7.0.0. They are replaced by the more general
+ {% rule java/codestyle/FieldNamingConventions %}, {% rule java/codestyle/FormalParameterNamingConventions %}, and
+ {% rule java/codestyle/LocalVariableNamingConventions %}.
+
+### Fixed Issues
+
+* core
+ * [#1191](https://github.com/pmd/pmd/issues/1191): \[core] Test Framework: Sort violations by line/column
+ * [#1283](https://github.com/pmd/pmd/issues/1283): \[core] Deprecate ReportTree
+ * [#1288](https://github.com/pmd/pmd/issues/1288): \[core] No supported build listeners found with Gradle
+ * [#1300](https://github.com/pmd/pmd/issues/1300): \[core] PMD stops processing file completely, if one rule in a rule chain fails
+ * [#1317](https://github.com/pmd/pmd/issues/1317): \[ci] Coveralls hasn't built the project since June 25th
+* java-bestpractices
+ * [#940](https://github.com/pmd/pmd/issues/940): \[java] JUnit 4 false positives for JUnit 5 tests
+ * [#1267](https://github.com/pmd/pmd/pull/1267): \[java] MissingOverrideRule: Avoid NoClassDefFoundError with incomplete classpath
+ * [#1323](https://github.com/pmd/pmd/issues/1323): \[java] AvoidUsingHardCodedIP ignores match pattern
+ * [#1327](https://github.com/pmd/pmd/pull/1327): \[java] AvoidUsingHardCodedIP false positive for ":bee"
+* java-codestyle
+ * [#1255](https://github.com/pmd/pmd/issues/1255): \[java] UnnecessaryFullyQualifiedName false positive: static method on shadowed implicitly imported class
+ * [#1258](https://github.com/pmd/pmd/issues/1285): \[java] False positive "UselessParentheses" for parentheses that contain assignment
+* java-errorprone
+ * [#1078](https://github.com/pmd/pmd/issues/1078): \[java] MissingSerialVersionUID rule does not seem to catch inherited classes
+* java-performance
+ * [#1291](https://github.com/pmd/pmd/issues/1291): \[java] InvalidSlf4jMessageFormat false positive: too many arguments with string concatenation operator
+ * [#1298](https://github.com/pmd/pmd/issues/1298): \[java] RedundantFieldInitializer - NumberFormatException with Long
+* jsp
+ * [#1274](https://github.com/pmd/pmd/issues/1274): \[jsp] Support EL in tag attributes
+ * [#1276](https://github.com/pmd/pmd/issues/1276): \[jsp] add support for jspf and tag extensions
+* plsql
+ * [#681](https://github.com/pmd/pmd/issues/681): \[plsql] Parse error with Cursor For Loop
+
+### API Changes
+
+* All classes in the package `net.sourceforge.pmd.lang.dfa.report` have been deprecated and will be removed
+ with PMD 7.0.0. This includes the class `net.sourceforge.pmd.lang.dfa.report.ReportTree`. The reason is,
+ that this class is very specific to Java and not suitable for other languages. It has only been used for
+ `YAHTMLRenderer`, which has been rewritten to work without these classes.
+
+* The nodes RUNSIGNEDSHIFT and RSIGNEDSHIFT are deprecated and will be removed from the AST with PMD 7.0.0.
+ These represented the operator of ShiftExpression in two cases out of three, but they're not needed and
+ make ShiftExpression inconsistent. The operator of a ShiftExpression is now accessible through
+ ShiftExpression#getOperator.
+
+### External Contributions
+
+* [#109](https://github.com/pmd/pmd/pull/109): \[java] Add two linguistics rules under naming - [Arda Aslan](https://github.com/ardaasln)
+* [#1254](https://github.com/pmd/pmd/pull/1254): \[ci] \[GSoC] Integrating the danger and pmdtester to travis CI - [BBG](https://github.com/djydewang)
+* [#1258](https://github.com/pmd/pmd/pull/1258): \[java] Use typeof in MissingSerialVersionUID - [krichter722](https://github.com/krichter722)
+* [#1264](https://github.com/pmd/pmd/pull/1264): \[cpp] Fix NullPointerException in CPPTokenizer:99 - [Rafael Cortês](https://github.com/mrfyda)
+* [#1277](https://github.com/pmd/pmd/pull/1277): \[jsp] #1276 add support for jspf and tag extensions - [Jordi Llach](https://github.com/jordillachmrf)
+* [#1275](https://github.com/pmd/pmd/pull/1275): \[jsp] Issue #1274 - Support EL in tag attributes - [Jordi Llach](https://github.com/jordillachmrf)
+* [#1278](https://github.com/pmd/pmd/pull/1278): \[ci] \[GSoC] Use pmdtester 1.0.0.pre.beta3 - [BBG](https://github.com/djydewang)
+* [#1289](https://github.com/pmd/pmd/pull/1289): \[java] UselessParentheses: Fix false positive with assignments - [cobratbq](https://github.com/cobratbq)
+* [#1290](https://github.com/pmd/pmd/pull/1290): \[docs] \[GSoC] Create the documentation about pmdtester - [BBG](https://github.com/djydewang)
+* [#1256](https://github.com/pmd/pmd/pull/1256): \[java] #940 Avoid JUnit 4 false positives for JUnit 5 tests - [Alex Shesterov](https://github.com/vovkss)
+* [#1315](https://github.com/pmd/pmd/pull/1315): \[apex] Add OneDeclarationPerStatement rule - [Jeff Hube](https://github.com/jeffhube)
+
+
+## 29-July-2018 - 6.6.0
+
+The PMD team is pleased to announce PMD 6.6.0.
+
+This is a minor release.
+
+### Table Of Contents
+
+* [New and noteworthy](#new-and-noteworthy)
+ * [Java 11 Support](#java-11-support)
+ * [New Rules](#new-rules)
+ * [Modified Rules](#modified-rules)
+* [Fixed Issues](#fixed-issues)
+* [API Changes](#api-changes)
+* [External Contributions](#external-contributions)
+
+### New and noteworthy
+
+#### Java 11 Support
+
+PMD is now able to parse the local-variable declaration syntax `var xxx`, that has been
+extended for lambda parameters with Java 11 via
+[JEP 323: Local-Variable Syntax for Lambda Parameters](http://openjdk.java.net/jeps/323).
+
+#### New Rules
+
+* The new Java rule [`LocalVariableNamingConventions`](pmd_rules_java_codestyle.html#localvariablenamingconventions)
+ (`java-codestyle`) detects local variable names that don't comply to a given convention. It defaults to standard
+ Java convention of using camelCase, but can be configured. Special cases can be configured for final variables
+ and caught exceptions' names.
+
+* The new Java rule [`FormalParameterNamingConventions`](pmd_rules_java_codestyle.html#formalparameternamingconventions)
+ (`java-codestyle`) detects formal parameter names that don't comply to a given convention. It defaults to
+ standard Java convention of using camelCase, but can be configured. Special cases can be configured for final
+ parameters and lambda parameters (considering whether they are explicitly typed or not).
+
+#### Modified Rules
+
+* The Java rules [`AccessorClassGeneration`](pmd_rules_java_bestpracices.html#accessorclassgeneration) and
+ [`AccessorMethodGeneration`](pmd_rules_java_bestpracices.html#accessormethodgeneration) (both in category
+ `java-bestpractices`) have been modified to be only valid up until Java 10. Java 11 adds support for
+ [JEP 181: Nest-Based Access Control](http://openjdk.java.net/jeps/181) which avoids the generation of
+ accessor classes / methods altogether.
+
+### Fixed Issues
+
+* core
+ * [#1178](https://github.com/pmd/pmd/issues/1178): \[core] "Unsupported build listener" in gradle build
+ * [#1225](https://github.com/pmd/pmd/issues/1225): \[core] Error in sed expression on line 82 of run.sh while detecting installed version of Java
+* doc
+ * [#1215](https://github.com/pmd/pmd/issues/1215): \[doc] TOC links don't work?
+* java-codestyle
+ * [#1211](https://github.com/pmd/pmd/issues/1211): \[java] CommentDefaultAccessModifier false positive with nested interfaces (regression from 6.4.0)
+ * [#1216](https://github.com/pmd/pmd/issues/1216): \[java] UnnecessaryFullyQualifiedName false positive for the same name method
+* java-design
+ * [#1217](https://github.com/pmd/pmd/issues/1217): \[java] CyclomaticComplexityRule counts ?-operator twice
+ * [#1226](https://github.com/pmd/pmd/issues/1226): \[java] NPath complexity false negative due to overflow
+* plsql
+ * [#980](https://github.com/pmd/pmd/issues/980): \[plsql] ParseException for CREATE TABLE
+ * [#981](https://github.com/pmd/pmd/issues/981): \[plsql] ParseException when parsing VIEW
+ * [#1047](https://github.com/pmd/pmd/issues/1047): \[plsql] ParseException when parsing EXECUTE IMMEDIATE
+* ui
+ * [#1233](https://github.com/pmd/pmd/issues/1233): \[ui] XPath autocomplete arrows on first and last items
+
+### API Changes
+
+* The `findDescendantsOfType` methods in `net.sourceforge.pmd.lang.ast.AbstractNode` no longer search for
+ exact type matches, but will match subclasses, too. That means, it's now possible to look for abstract node
+ types such as `AbstractJavaTypeNode` and not only for it's concrete subtypes.
+
+### External Contributions
+
+* [#1182](https://github.com/pmd/pmd/pull/1182): \[ui] XPath AutoComplete - [Akshat Bahety](https://github.com/akshatbahety)
+* [#1231](https://github.com/pmd/pmd/pull/1231): \[doc] Minor typo fix in installation.md - [Ashish Rana](https://github.com/ashishrana160796)
+* [#1250](https://github.com/pmd/pmd/pull/1250): \[ci] \[GSoC] Upload baseline of pmdtester automatically - [BBG](https://github.com/djydewang)
+
+
+## 26-June-2018 - 6.5.0
+
+The PMD team is pleased to announce PMD 6.5.0.
+
+This is a minor release.
+
+### Table Of Contents
+
+* [New and noteworthy](#new-and-noteworthy)
+ * [New Rules](#new-rules)
+ * [Modified Rules](#modified-rules)
+* [Fixed Issues](#fixed-issues)
+* [API Changes](#api-changes)
+* [External Contributions](#external-contributions)
+
+### New and noteworthy
+
+#### New Rules
+
+* The new Apex rule [`AvoidNonExistentAnnotations`](pmd_rules_apex_errorprone.html#avoidnonexistentannotations) (`apex-errorprone`)
+ detects usages non-officially supported annotations. Apex supported non existent annotations for legacy reasons.
+ In the future, use of such non-existent annotations could result in broken Apex code that will not compile.
+ A full list of supported annotations can be found [here](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_classes_annotation.htm)
+
+#### Modified Rules
+
+* The Java rule [UnnecessaryModifier](pmd_rules_java_codestyle.html#unnecessarymodifier) (`java-codestyle`)
+ now detects enum constrcutors with explicit `private` modifier. The rule now produces better error messages
+ letting you know exactly which modifiers are redundant at each declaration.
+
+### Fixed Issues
+* all
+ * [#1119](https://github.com/pmd/pmd/issues/1119): \[doc] Make the landing page of the documentation website more useful
+ * [#1168](https://github.com/pmd/pmd/issues/1168): \[core] xml renderer schema definitions (#538) break included xslt files
+ * [#1173](https://github.com/pmd/pmd/issues/1173): \[core] Some characters in CPD are not shown correctly.
+ * [#1193](https://github.com/pmd/pmd/issues/1193): \[core] Designer doesn't start with run.sh
+* ecmascript
+ * [#861](https://github.com/pmd/pmd/issues/861): \[ecmascript] InnaccurateNumericLiteral false positive with hex literals
+* java
+ * [#1074](https://github.com/pmd/pmd/issues/1074): \[java] MissingOverrideRule exception when analyzing PMD under Java 9
+ * [#1174](https://github.com/pmd/pmd/issues/1174): \[java] CommentUtil.multiLinesIn() could lead to StringIndexOutOfBoundsException
+* java-bestpractices
+ * [#651](https://github.com/pmd/pmd/issues/651): \[java] SwitchStmtsShouldHaveDefault should be aware of enum types
+ * [#869](https://github.com/pmd/pmd/issues/869): \[java] GuardLogStatement false positive on return statements and Math.log
+* java-codestyle
+ * [#667](https://github.com/pmd/pmd/issues/667): \[java] Make AtLeastOneConstructor Lombok-aware
+ * [#1154](https://github.com/pmd/pmd/pull/1154): \[java] CommentDefaultAccessModifierRule FP with nested enums
+ * [#1158](https://github.com/pmd/pmd/issues/1158): \[java] Fix IdenticalCatchBranches false positive
+ * [#1186](https://github.com/pmd/pmd/issues/1186): \[java] UnnecessaryFullyQualifiedName doesn't detect java.lang FQ names as violations
+* java-design
+ * [#1200](https://github.com/pmd/pmd/issues/1200): \[java] New default NcssCount method report level is drastically reduced from values of deprecated NcssMethodCount and NcssTypeCount
+* xml
+ * [#715](https://github.com/pmd/pmd/issues/715): \[xml] ProjectVersionAsDependencyVersion false positive
+
+### API Changes
+
+* The utility class `net.sourceforge.pmd.lang.java.ast.CommentUtil` has been deprecated and will be removed
+ with PMD 7.0.0. Its methods have been intended to parse javadoc tags. A more useful solution will be added
+ around the AST node `FormalComment`, which contains as children `JavadocElement` nodes, which in
+ turn provide access to the `JavadocTag`.
+
+ All comment AST nodes (`FormalComment`, `MultiLineComment`, `SingleLineComment`) have a new method
+ `getFilteredComment()` which provide access to the comment text without the leading `/*` markers.
+
+* The method `AbstractCommentRule.tagsIndicesIn()` has been deprecated and will be removed with
+ PMD 7.0.0. It is not very useful, since it doesn't extract the information
+ in a useful way. You would still need check, which tags have been found, and with which
+ data they might be accompanied.
+
+### External Contributions
+
+* [#836](https://github.com/pmd/pmd/pull/836): \[apex] Add a rule to prevent use of non-existent annotations - [anand13s](https://github.com/anand13s)
+* [#1159](https://github.com/pmd/pmd/pull/1159): \[ui] Allow to setup the auxclasspath in the designer - [Akshat Bahety](https://github.com/akshatbahety)
+* [#1169](https://github.com/pmd/pmd/pull/1169): \[core] Update stylesheets with a default namespace - [Matthew Duggan](https://github.com/mduggan)
+* [#1183](https://github.com/pmd/pmd/pull/1183): \[java] fixed typos in rule remediation - [Jake Hemmerle](https://github.com/jakehemmerle)
+* [#1206](https://github.com/pmd/pmd/pull/1206): \[java] Recommend StringBuilder next to StringBuffer - [krichter722](https://github.com/krichter722)
+
+
+## 29-May-2018 - 6.4.0
+
+The PMD team is pleased to announce PMD 6.4.0.
+
+This is a minor release.
+
+### Table Of Contents
+
+* [New and noteworthy](#new-and-noteworthy)
+ * [Java 10 Support](#java-10-support)
+ * [XPath Type Resolution Functions](#xpath-type-resolution-functions)
+ * [New Rules](#new-rules)
+ * [Modified Rules](#modified-rules)
+* [Fixed Issues](#fixed-issues)
+* [API Changes](#api-changes)
+* [External Contributions](#external-contributions)
+
+### New and noteworthy
+
+#### Java 10 Support
+
+PMD is now able to understand local-variable type inference as introduced by Java 10.
+Simple type resolution features are available, e.g. the type of the variable `s` is inferred
+correctly as `String`:
+
+ var s = "Java 10";
+
+#### XPath Type Resolution Functions
+
+For some time now PMD has supported Type Resolution, and exposed this functionality to XPath rules for the Java language
+with the `typeof` function. This function however had a number of shortcomings:
+
+* It would take a first arg with the name to match if types couldn't be resolved. In all cases this was `@Image`
+ but was still required.
+* It required 2 separate arguments for the Fully Qualified Class Name and the simple name of the class against
+ which to test.
+* If only the Fully Qualified Class Name was provided, no simple name check was performed (not documented,
+ but abused on some rules to "fix" some false positives).
+
+In this release we are deprecating `typeof` in favor of a simpler `typeIs` function, which behaves exactly as the
+old `typeof` when given all 3 arguments.
+
+`typeIs` receives a single parameter, which is the fully qualified name of the class to test against.
+
+So, calls such as:
+
+```ruby
+//ClassOrInterfaceType[typeof(@Image, 'junit.framework.TestCase', 'TestCase')]
+```
+
+can now we expressed much more concisely as:
+
+```ruby
+//ClassOrInterfaceType[typeIs('junit.framework.TestCase')]
+```
+
+With this change, we also allow to check against array types by just appending `[]` to the fully qualified class name.
+These can be repeated for arrays of arrays (e.g. `byte[][]` or `java.lang.String[]`).
+
+Additionally, we introduce the companion function `typeIsExactly`, that receives the same parameters as `typeIs`,
+but checks for exact type matches, without considering the type hierarchy. That is, the test
+`typeIsExactly('junit.framework.TestCase')` will match only if the context node is an instance of `TestCase`, but
+not if it's an instance of a subclass of `TestCase`. Be aware then, that using that method with abstract types will
+never match.
+
+#### New Rules
+
+* The new Java rule [`HardCodedCryptoKey`](pmd_rules_java_security.html#hardcodedcryptokey) (`java-security`)
+ detects hard coded keys used for encryption. It is recommended to store keys outside of the source code.
+
+* The new Java rule [`IdenticalCatchBranches`](pmd_rules_java_codestyle.html#identicalcatchbranches) (`java-codestyle`)
+ finds catch blocks,
+ that catch different exception but perform the same exception handling and thus can be collapsed into a
+ multi-catch try statement.
+
+#### Modified Rules
+
+* The Java rule [JUnit4TestShouldUseTestAnnotation](pmd_rules_java_bestpractices.html#junit4testshouldusetestannotation) (`java-bestpractices`)
+ has a new parameter "testClassPattern". It is used to distinguish test classes from other classes and
+ avoid false positives. By default, any class, that has "Test" in its name, is considered a test class.
+
+* The Java rule [CommentDefaultAccessModifier](pmd_rules_java_codestyle.html#commentdefaultaccessmodifier) (`java-codestyle`)
+ allows now by default the comment "`/* package */` in addition to "`/* default */`. This behavior can
+ still be adjusted by setting the property `regex`.
+
+### Fixed Issues
+
+* all
+ * [#1018](https://github.com/pmd/pmd/issues/1018): \[java] Performance degradation of 250% between 6.1.0 and 6.2.0
+ * [#1145](https://github.com/pmd/pmd/issues/1145): \[core] JCommander's help text for option -min is wrong
+* java
+ * [#672](https://github.com/pmd/pmd/issues/672): \[java] Support exact type matches for type resolution from XPath
+ * [#743](https://github.com/pmd/pmd/issues/743): \[java] Prepare for Java 10
+ * [#1077](https://github.com/pmd/pmd/issues/1077): \[java] Analyzing enum with lambda passed in constructor fails with "The enclosing scope must exist."
+ * [#1115](https://github.com/pmd/pmd/issues/1115): \[java] Simplify xpath typeof syntax
+ * [#1131](https://github.com/pmd/pmd/issues/1131): \[java] java.lang.ClassFormatError: Absent Code attribute in method that is not native or abstract in class file javax/faces/application/FacesMessage$Severity
+* java-bestpractices
+ * [#527](https://github.com/pmd/pmd/issues/572): \[java] False Alarm of JUnit4TestShouldUseTestAnnotation on Predicates
+ * [#1063](https://github.com/pmd/pmd/issues/1063): \[java] MissingOverride is triggered in illegal places
+* java-codestyle
+ * [#720](https://github.com/pmd/pmd/issues/720): \[java] ShortVariable should whitelist lambdas
+ * [#955](https://github.com/pmd/pmd/issues/955): \[java] Detect identical catch statements
+ * [#1114](https://github.com/pmd/pmd/issues/1114): \[java] Star import overwritten by explicit import is not correctly handled
+ * [#1064](https://github.com/pmd/pmd/issues/1064): \[java] ClassNamingConventions suggests to add Util suffix for simple exception wrappers
+ * [#1065](https://github.com/pmd/pmd/issues/1065): \[java] ClassNamingConventions shouldn't prohibit numbers in class names
+ * [#1067](https://github.com/pmd/pmd/issues/1067): \[java] \[6.3.0] PrematureDeclaration false-positive
+ * [#1096](https://github.com/pmd/pmd/issues/1096): \[java] ClassNamingConventions is too ambitious on finding utility classes
+* java-design
+ * [#824](https://github.com/pmd/pmd/issues/824): \[java] UseUtilityClass false positive when extending
+ * [#1021](https://github.com/pmd/pmd/issues/1021): \[java] False positive for `DoNotExtendJavaLangError`
+ * [#1097](https://github.com/pmd/pmd/pull/1097): \[java] False negative in AvoidThrowingRawExceptionTypes
+* java-performance
+ * [#1051](https://github.com/pmd/pmd/issues/1051): \[java] ConsecutiveAppendsShouldReuse false-negative
+ * [#1098](https://github.com/pmd/pmd/pull/1098): \[java] Simplify LongInstantiation, IntegerInstantiation, ByteInstantiation, and ShortInstantiation using type resolution
+ * [#1125](https://github.com/pmd/pmd/issues/1125): \[java] Improve message of InefficientEmptyStringCheck for String.trim().isEmpty()
+* doc
+ * [#999](https://github.com/pmd/pmd/issues/999): \[doc] Add a header before the XPath expression in rules
+ * [#1082](https://github.com/pmd/pmd/issues/1082): \[doc] Multifile analysis doc is invalid
+* vf-security
+ * [#1100](https://github.com/pmd/pmd/issues/1100): \[vf] URLENCODE is ignored as valid escape method
+
+### API Changes
+
+* The following classes in package `net.sourceforge.pmd.benchmark` have been deprecated: `Benchmark`, `Benchmarker`,
+ `BenchmarkReport`, `BenchmarkResult`, `RuleDuration`, `StringBuilderCR` and `TextReport`. Their API is not supported anymore
+ and is disconnected from the internals of PMD. Use the newer API based around `TimeTracker` instead, which can be found
+ in the same package.
+* The class `net.sourceforge.pmd.lang.java.xpath.TypeOfFunction` has been deprecated. Use the newer `TypeIsFunction` in the same package.
+* The `typeof` methdos in `net.sourceforge.pmd.lang.java.xpath.JavaFunctions` have been deprecated.
+ Use the newer `typeIs` method in the same class instead..
+* The methods `isA`, `isEither` and `isNeither` of `net.sourceforge.pmd.lang.java.typeresolution.TypeHelper`.
+ Use the new `isExactlyAny` and `isExactlyNone` methods in the same class instead.
+
+
+### External Contributions
+
+* [#966](https://github.com/pmd/pmd/pull/966): \[java] Issue #955: add new rule to detect identical catch statement - [Clément Fournier](https://github.com/oowekyala) and [BBG](https://github.com/djydewang)
+* [#1046](https://github.com/pmd/pmd/pull/1046): \[java] New security rule for finding hard-coded keys used for cryptographic operations - [Sergey Gorbaty](https://github.com/sgorbaty)
+* [#1101](https://github.com/pmd/pmd/pull/1101): \[java] Fixes false positive for `DoNotExtendJavaLangError` - [Akshat Bahety](https://github.com/akshatbahety)
+* [#1106](https://github.com/pmd/pmd/pull/1106): \[vf] URLENCODE is ignored as valid escape method - [Robert Sösemann](https://github.com/rsoesemann)
+* [#1126](https://github.com/pmd/pmd/pull/1126): \[java] Improve implementation hint in InefficientEmptyStringCheck - [krichter722](https://github.com/krichter722)
+* [#1129](https://github.com/pmd/pmd/pull/1129): \[java] Adjust InefficientEmptyStringCheck documentation - [krichter722](https://github.com/krichter722)
+* [#1137](https://github.com/pmd/pmd/pull/1137): \[ui] Removes the need for RefreshAST - [Akshat Bahety](https://github.com/akshatbahety)
+
+
+
+## 29-April-2018 - 6.3.0
+
+The PMD team is pleased to announce PMD 6.3.0.
+
+This is a minor release.
+
+### Table Of Contents
+
+* [New and noteworthy](#new-and-noteworthy)
+ * [Tree Traversal Revision](#tree-traversal-revision)
+ * [Naming Rules Enhancements](#naming-rules-enhancements)
+ * [CPD Suppression](#cpd-suppression)
+ * [Swift 4.1 Support](#swift-41-support)
+ * [New Rules](#new-rules)
+ * [Modified Rules](#modified-rules)
+ * [Deprecated Rules](#deprecated-rules)
+* [Fixed Issues](#fixed-issues)
+* [External Contributions](#external-contributions)
+
+### New and noteworthy
+
+#### Tree Traversal Revision
+
+As described in [#904](https://github.com/pmd/pmd/issues/904), when searching for child nodes of the AST methods
+such as `hasDescendantOfType`, `getFirstDescendantOfType` and `findDescendantsOfType` were found to behave inconsistently,
+not all of them honoring find boundaries; that is, nodes that define a self-contained entity which should be considered separately
+(think of lambdas, nested classes, anonymous classes, etc.). We have modified these methods to ensure all of them honor
+find boundaries.
+
+This change implies several false positives / unexpected results
+(ie: `ASTBlockStatement` falsely returning `true` to `isAllocation()`)
+have been fixed; and lots of searches are now restricted to smaller search areas, which improves performance
+(depending on the project, we have measured up to 10% improvements during Type Resolution, Symbol Table analysis,
+and some rules' application).
+
+#### Naming Rules Enhancements
+
+* [ClassNamingConventions](pmd_rules_java_codestyle.html#classnamingconventions) (`java-codestyle`)
+ has been enhanced to allow granular configuration of naming
+ conventions for different kinds of type declarations (eg enum or abstract
+ class). Each kind of declaration can use its own naming convention
+ using a regex property. See the rule's documentation for more info about
+ configuration and default conventions.
+
+* [MethodNamingConventions](pmd_rules_java_codestyle.html#methodnamingconventions) (`java-codestyle`)
+ has been enhanced in the same way.
+
+#### CPD Suppression
+
+Back in PMD 5.6.0 we introduced the ability to suppress CPD warnings in Java using comments, by
+including `CPD-OFF` (to start ignoring code), or `CPD-ON` (to resume analysis) during CPD execution.
+This has proved to be much more flexible and versatile than the old annotation-based approach,
+and has since been the preferred way to suppress CPD warnings.
+
+On this occasion, we are extending support for comment-based suppressions to many other languages:
+
+* C/C++
+* Ecmascript / Javascript
+* Matlab
+* Objective-C
+* PL/SQL
+* Python
+
+So for instance, in Python we could now do:
+
+```python
+class BaseHandler(object):
+ def __init__(self):
+ # some unignored code
+
+ # tell cpd to start ignoring code - CPD-OFF
+
+ # mission critical code, manually loop unroll
+ GoDoSomethingAwesome(x + x / 2);
+ GoDoSomethingAwesome(x + x / 2);
+ GoDoSomethingAwesome(x + x / 2);
+ GoDoSomethingAwesome(x + x / 2);
+ GoDoSomethingAwesome(x + x / 2);
+ GoDoSomethingAwesome(x + x / 2);
+
+ # resume CPD analysis - CPD-ON
+
+ # further code will *not* be ignored
+```
+
+Other languages are equivalent.
+
+#### Swift 4.1 Support
+
+Thanks to major contributions from [kenji21](https://github.com/kenji21) the Swift grammar has been updated to
+support Swift 4.1. This is a major update, since the old grammar was quite dated, and we are sure all iOS
+developers will enjoy it.
+
+Unfortunately, this change is not compatible. The grammar elements that have been removed (ie: the keywords `__FILE__`,
+`__LINE__`, `__COLUMN__` and `__FUNCTION__`) are no longer supported. We don't usually introduce such
+drastic / breaking changes in minor releases, however, given that the whole Swift ecosystem pushes hard towards
+always using the latest versions, and that Swift needs all code and libraries to be currently compiling against
+the same Swift version, we felt strongly this change was both safe and necessary to be shipped as soon as possible.
+We had great feedback from the community during the process but if you have a legitimate use case for older Swift
+versions, please let us know [on our Issue Tracker](https://github.com/pmd/pmd/issues).
+
+#### New Rules
+
+* The new Java rule [InsecureCryptoIv](pmd_rules_java_security.html#insecurecryptoiv) (`java-security`)
+ detects hard coded initialization vectors used in cryptographic operations. It is recommended to use
+ a randomly generated IV.
+
+#### Modified Rules
+
+* The Java rule [UnnecessaryConstructor](pmd_rules_java_codestyle.html#unnecessaryconstructor) (`java-codestyle`)
+ has been rewritten as a Java rule (previously it was a XPath-based rule). It supports a new property
+ `ignoredAnnotations` and ignores by default empty constructors,
+ that are annotated with `javax.inject.Inject`. Additionally, it detects now also unnecessary private constructors
+ in enums.
+
+* The property `checkNativeMethods` of the Java rule [MethodNamingConventions](pmd_rules_java_codestyle.html#methodnamingconventions) (`java-codestyle`)
+ is now deprecated, as it is now superseded by `nativePattern`. Support for that property will be maintained until
+ 7.0.0.
+
+* The Java rule [ControlStatementBraces](pmd_rules_java_codestyle.html#controlstatementbraces) (`java-codestyle`)
+ supports a new boolean property `checkSingleIfStmt`. When unset, the rule won't report `if` statements which lack
+ braces, if the statement is not part of an `if ... else if` chain. This property defaults to true.
+
+#### Deprecated Rules
+
+* The Java rule [AbstractNaming](pmd_rules_java_codestyle.html#abstractnaming) (`java-codestyle`) is deprecated
+ in favour of [ClassNamingConventions](pmd_rules_java_codestyle.html#classnamingconventions).
+ See [Naming rules enhancements](#naming-rules-enhancements).
+
+### Fixed Issues
+
+* all
+ * [#695](https://github.com/pmd/pmd/issues/695): \[core] Extend comment-based suppression to all JavaCC languages
+ * [#988](https://github.com/pmd/pmd/issues/988): \[core] FileNotFoundException for missing classes directory with analysis cache enabled
+ * [#1036](https://github.com/pmd/pmd/issues/1036): \[core] Non-XML output breaks XML-based CLI integrations
+* apex-errorprone
+ * [#776](https://github.com/pmd/pmd/issues/776): \[apex] AvoidHardcodingId false positives
+* documentation
+ * [#994](https://github.com/pmd/pmd/issues/994): \[doc] Delete duplicate page contributing.md on the website
+ * [#1057](https://github.com/pmd/pmd/issues/1057): \[doc] Documentation of ignoredAnnotations property is misleading
+* java
+ * [#894](https://github.com/pmd/pmd/issues/894): \[java] Maven PMD plugin fails to process some files without any explanation
+ * [#899](https://github.com/pmd/pmd/issues/899): \[java] JavaTypeDefinitionSimple.toString can cause NPEs
+ * [#1020](https://github.com/pmd/pmd/issues/1020): \[java] The CyclomaticComplexity rule runs forever in 6.2.0
+ * [#1030](https://github.com/pmd/pmd/pull/1030): \[java] NoClassDefFoundError when analyzing PMD with PMD
+ * [#1061](https://github.com/pmd/pmd/issues/1061): \[java] Update ASM to handle Java 10 bytecode
+* java-bestpractices
+ * [#370](https://github.com/pmd/pmd/issues/370): \[java] GuardLogStatementJavaUtil not considering lambdas
+ * [#558](https://github.com/pmd/pmd/issues/558): \[java] ProperLogger Warnings for enums
+ * [#719](https://github.com/pmd/pmd/issues/719): \[java] Unused Code: Java 8 receiver parameter with an internal class
+ * [#1009](https://github.com/pmd/pmd/issues/1009): \[java] JUnitAssertionsShouldIncludeMessage - False positive with assertEquals and JUnit5
+* java-codestyle
+ * [#1003](https://github.com/pmd/pmd/issues/1003): \[java] UnnecessaryConstructor triggered on required empty constructor (Dagger @Inject)
+ * [#1023](https://github.com/pmd/pmd/issues/1023): \[java] False positive for useless parenthesis
+ * [#1004](https://github.com/pmd/pmd/issues/1004): \[java] ControlStatementBraces is missing checkIfStmt property
+* java-design
+ * [#1056](https://github.com/pmd/pmd/issues/1056): \[java] Property ignoredAnnotations does not work for SingularField and ImmutableField
+* java-errorprone
+ * [#629](https://github.com/pmd/pmd/issues/629): \[java] NullAssignment false positive
+ * [#816](https://github.com/pmd/pmd/issues/816): \[java] SingleMethodSingleton false positives with inner classes
+* java-performance
+ * [#586](https://github.com/pmd/pmd/issues/586): \[java] AvoidUsingShortType erroneously triggered on overrides of 3rd party methods
+* swift
+ * [#678](https://github.com/pmd/pmd/issues/678): \[swift]\[cpd] Exception when running for Swift 4 code (KeyPath)
+
+### External Contributions
+
+* [#778](https://github.com/pmd/pmd/pull/778): \[swift] Support Swift 4 grammar - [kenji21](https://github.com/kenji21)
+* [#1002](https://github.com/pmd/pmd/pull/1002): \[doc] Delete duplicate page contributing.md on the website - [Ishan Srivastava](https://github.com/ishanSrt)
+* [#1008](https://github.com/pmd/pmd/pull/1008): \[core] DOC: fix closing tag for <pmdVersion> - [stonio](https://github.com/stonio)
+* [#1010](https://github.com/pmd/pmd/pull/1010): \[java] UnnecessaryConstructor triggered on required empty constructor (Dagger @Inject) - [BBG](https://github.com/djydewang)
+* [#1012](https://github.com/pmd/pmd/pull/1012): \[java] JUnitAssertionsShouldIncludeMessage - False positive with assertEquals and JUnit5 - [BBG](https://github.com/djydewang)
+* [#1024](https://github.com/pmd/pmd/pull/1024): \[java] Issue 558: Properlogger for enums - [Utku Cuhadaroglu](https://github.com/utkuc)
+* [#1041](https://github.com/pmd/pmd/pull/1041): \[java] Make BasicProjectMemoizer thread safe. - [bergander](https://github.com/bergander)
+* [#1042](https://github.com/pmd/pmd/pull/1042): \[java] New security rule: report usage of hard coded IV in crypto operations - [Sergey Gorbaty](https://github.com/sgorbaty)
+* [#1044](https://github.com/pmd/pmd/pull/1044): \[java] Fix for issue #816 - [Akshat Bahety](https://github.com/akshatbahety)
+* [#1048](https://github.com/pmd/pmd/pull/1048): \[core] Make MultiThreadProcessor more space efficient - [Gonzalo Exequiel Ibars Ingman](https://github.com/gibarsin)
+* [#1062](https://github.com/pmd/pmd/pull/1062): \[core] Update ASM to version 6.1.1 - [Austin Shalit](https://github.com/AustinShalit)
+
+
+## 26-March-2018 - 6.2.0
+
+The PMD team is pleased to announce PMD 6.2.0.
+
+This is a minor release.
+
+### Table Of Contents
+
+* [New and noteworthy](#new-and-noteworthy)
+ * [Ecmascript (JavaScript)](#ecmascript-javascript)
+ * [Disable Incremental Analysis](#disable-incremental-analysis)
+ * [New Rules](#new-rules)
+ * [Modified Rules](#modified-rules)
+* [Fixed Issues](#fixed-issues)
+* [API Changes](#api-changes)
+* [External Contributions](#external-contributions)
+
+### New and noteworthy
+
+#### Ecmascript (JavaScript)
+
+The [Rhino Library](https://github.com/mozilla/rhino) has been upgraded from version 1.7.7 to version 1.7.7.2.
+
+Detailed changes for changed in Rhino can be found:
+* [For 1.7.7.2](https://github.com/mozilla/rhino/blob/master/RELEASE-NOTES.md#rhino-1772)
+* [For 1.7.7.1](https://github.com/mozilla/rhino/blob/master/RELEASE-NOTES.md#rhino-1771)
+
+Both are bugfixing releases.
+
+#### Disable Incremental Analysis
+
+Some time ago, we added support for [Incremental Analysis](pmd_userdocs_getting_started.html). On PMD 6.0.0, we
+started to add warns when not using it, as we strongly believe it's a great improvement to our user's experience as
+analysis time is greatly reduced; and in the future we plan to have it enabled by default. However, we realize some
+scenarios don't benefit from it (ie: CI jobs), and having the warning logged can be noisy and cause confusion.
+
+To this end, we have added a new flag to allow you to explicitly disable incremental analysis. On CLI, this is
+the new `-no-cache` flag. On Ant, there is a `noCache` attribute for the `<pmd>` task.
+
+On both scenarios, disabling the cache takes precedence over setting a cache location.
+
+#### New Rules
+
+* The new Java rule [`MissingOverride`](pmd_rules_java_bestpractices.html#missingoverride)
+ (category `bestpractices`) detects overridden and implemented methods, which are not marked with the
+ `@Override` annotation. Annotating overridden methods with `@Override` ensures at compile time that
+ the method really overrides one, which helps refactoring and clarifies intent.
+
+* The new Java rule [`UnnecessaryAnnotationValueElement`](pmd_rules_java_codestyle.html#unnecessaryannotationvalueelement)
+ (category `codestyle`) detects annotations with a single element (`value`) that explicitely names it.
+ That is, doing `@SuppressWarnings(value = "unchecked")` would be flagged in favor of
+ `@SuppressWarnings("unchecked")`.
+
+* The new Java rule [`ControlStatementBraces`](pmd_rules_java_codestyle.html#controlstatementbraces)
+ (category `codestyle`) enforces the presence of braces on control statements where they are optional.
+ Properties allow to customize which statements are required to have braces. This rule replaces the now
+ deprecated rules `WhileLoopMustUseBraces`, `ForLoopMustUseBraces`, `IfStmtMustUseBraces`, and
+ `IfElseStmtMustUseBraces`. More than covering the use cases of those rules, this rule also supports
+ `do ... while` statements and `case` labels of `switch` statements (disabled by default).
+
+#### Modified Rules
+
+* The Java rule `CommentContentRule` (`java-documentation`) previously had the property `wordsAreRegex`. But this
+ property never had been implemented and is removed now.
+
+* The Java rule `UnusedPrivateField` (`java-bestpractices`) now has a new `ignoredAnnotations` property
+ that allows to configure annotations that imply the field should be ignored. By default `@java.lang.Deprecated`
+ and `@javafx.fxml.FXML` are ignored.
+
+* The Java rule `UnusedPrivateMethod` (`java-bestpractices`) now has a new `ignoredAnnotations` property
+ that allows to configure annotations that imply the method should be ignored. By default `@java.lang.Deprecated`
+ is ignored.
+
+* The Java rule `ImmutableField` (`java-design`) now has a new `ignoredAnnotations` property
+ that allows to configure annotations that imply the method should be ignored. By default several `lombok`
+ annotations are ignored
+
+* The Java rule `SingularField` (`java-design`) now has a new `ignoredAnnotations` property
+ that allows to configure annotations that imply the method should be ignored. By default several `lombok`
+ annotations are ignored
+
+#### Deprecated Rules
+
+* The Java rules `WhileLoopMustUseBraces`, `ForLoopMustUseBraces`, `IfStmtMustUseBraces`, and `IfElseStmtMustUseBraces`
+ are deprecated. They will be replaced by the new rule `ControlStatementBraces`, in the category `codestyle`.
+
+### Fixed Issues
+
+* all
+ * [#928](https://github.com/pmd/pmd/issues/928): \[core] PMD build failure on Windows
+* java-bestpracrtices
+ * [#907](https://github.com/pmd/pmd/issues/907): \[java] UnusedPrivateField false-positive with @FXML
+ * [#963](https://github.com/pmd/pmd/issues/965): \[java] ArrayIsStoredDirectly not triggered from variadic functions
+* java-codestyle
+ * [#974](https://github.com/pmd/pmd/issues/974): \[java] Merge \*StmtMustUseBraces rules
+ * [#983](https://github.com/pmd/pmd/issues/983): \[java] Detect annotations with single value element
+* java-design
+ * [#832](https://github.com/pmd/pmd/issues/832): \[java] AvoidThrowingNullPointerException documentation suggestion
+ * [#837](https://github.com/pmd/pmd/issues/837): \[java] CFGs of declared but not called lambdas are treated as parts of an enclosing method's CFG
+ * [#839](https://github.com/pmd/pmd/issues/839): \[java] SignatureDeclareThrowsException's IgnoreJUnitCompletely property not honored for constructors
+ * [#968](https://github.com/pmd/pmd/issues/968): \[java] UseUtilityClassRule reports false positive with lombok NoArgsConstructor
+* documentation
+ * [#978](https://github.com/pmd/pmd/issues/978): \[core] Broken link in CONTRIBUTING.md
+ * [#992](https://github.com/pmd/pmd/issues/992): \[core] Include info about rule doc generation in "Writing Documentation" md page
+
+### API Changes
+
+* A new CLI switch, `-no-cache`, disables incremental analysis and the related suggestion. This overrides the
+ `-cache` option. The corresponding Ant task parameter is `noCache`.
+
+* The static method `PMDParameters.transformParametersIntoConfiguration(PMDParameters)` is now deprecated,
+ for removal in 7.0.0. The new instance method `PMDParameters.toConfiguration()` replaces it.
+
+* The method `ASTConstructorDeclaration.getParameters()` has been deprecated in favor of the new method
+ `getFormalParameters()`. This method is available for both `ASTConstructorDeclaration` and
+ `ASTMethodDeclaration`.
+
+### External Contributions
+
+* [#941](https://github.com/pmd/pmd/pull/941): \[java] Use char notation to represent a character to improve performance - [reudismam](https://github.com/reudismam)
+* [#943](https://github.com/pmd/pmd/pull/943): \[java] UnusedPrivateField false-positive with @FXML - [BBG](https://github.com/djydewang)
+* [#951](https://github.com/pmd/pmd/pull/951): \[java] Add ignoredAnnotations property to unusedPrivateMethod rule - [BBG](https://github.com/djydewang)
+* [#952](https://github.com/pmd/pmd/pull/952): \[java] SignatureDeclareThrowsException's IgnoreJUnitCompletely property not honored for constructors - [BBG](https://github.com/djydewang)
+* [#958](https://github.com/pmd/pmd/pull/958): \[java] Refactor how we ignore annotated elements in rules - [BBG](https://github.com/djydewang)
+* [#965](https://github.com/pmd/pmd/pull/965): \[java] Make Varargs trigger ArrayIsStoredDirectly - [Stephen](https://github.com/pmd/pmd/issues/907)
+* [#967](https://github.com/pmd/pmd/pull/967): \[doc] Issue 959: fixed broken link to XPath Rule Tutorial - [Andrey Mochalov](https://github.com/epidemia)
+* [#969](https://github.com/pmd/pmd/pull/969): \[java] Issue 968 Add logic to handle lombok private constructors with utility classes - [Kirk Clemens](https://github.com/clem0110)
+* [#970](https://github.com/pmd/pmd/pull/970): \[java] Fixed inefficient use of keySet iterator instead of entrySet iterator - [Andrey Mochalov](https://github.com/epidemia)
+* [#984](https://github.com/pmd/pmd/pull/984): \[java] issue983 Add new UnnecessaryAnnotationValueElement rule - [Kirk Clemens](https://github.com/clem0110)
+* [#989](https://github.com/pmd/pmd/pull/989): \[core] Update Contribute.md to close Issue #978 - [Bolarinwa Saheed Olayemi](https://github.com/refactormyself)
+* [#990](https://github.com/pmd/pmd/pull/990): \[java] Updated Doc on AvoidThrowingNullPointerException to close Issue #832 - [Bolarinwa Saheed Olayemi](https://github.com/refactormyself)
+* [#993](https://github.com/pmd/pmd/pull/993): \[core] Update writing_documentation.md to fix Issue #992 - [Bolarinwa Saheed Olayemi](https://github.com/refactormyself)
+
+
+## 25-February-2018 - 6.1.0
+
+The PMD team is pleased to announce PMD 6.1.0.
+
+This is a minor release.
+
+### Table Of Contents
+
+* [New and noteworthy](#new-and-noteworthy)
+ * [Designer UI](#designer-ui)
+* [Fixed Issues](#fixed-issues)
+* [API Changes](#api-changes)
+ * [Changes to the Node interface](#changes-to-the-node-interface)
+ * [Changes to CPD renderers](#changes-to-cpd-renderers)
+* [External Contributions](#external-contributions)
+
+### New and noteworthy
+
+#### Designer UI
+
+The Designer now supports configuring properties for XPath based rule development.
+The Designer is still under development and any feedback is welcome.
+
+You can start the designer via `run.sh designer` or `designer.bat`.
+
+### Fixed Issues
+
+* all
+ * [#569](https://github.com/pmd/pmd/issues/569): \[core] XPath support requires specific toString implementations
+ * [#795](https://github.com/pmd/pmd/issues/795): \[cpd] java.lang.OutOfMemoryError
+ * [#848](https://github.com/pmd/pmd/issues/848): \[doc] Test failures when building pmd-doc under Windows
+ * [#872](https://github.com/pmd/pmd/issues/872): \[core] NullPointerException at FileDataSource.glomName()
+ * [#854](https://github.com/pmd/pmd/issues/854): \[ci] Use Java9 for building PMD
+* doc
+ * [#791](https://github.com/pmd/pmd/issues/791): \[doc] Documentation site reorganisation
+ * [#891](https://github.com/pmd/pmd/issues/891): \[doc] Apex @SuppressWarnings should use single quotes instead of double quotes
+ * [#909](https://github.com/pmd/pmd/issues/909): \[doc] Please add new PMD Eclipse Plugin to tool integration section
+* java
+ * [#825](https://github.com/pmd/pmd/issues/825): \[java] Excessive\*Length ignores too much
+ * [#888](https://github.com/pmd/pmd/issues/888): \[java] ParseException occurs with valid '<>' in Java 1.8 mode
+ * [#920](https://github.com/pmd/pmd/pull/920): \[java] Update valid identifiers in grammar
+* java-bestpractices
+ * [#784](https://github.com/pmd/pmd/issues/784): \[java] ForLoopCanBeForeach false-positive
+ * [#925](https://github.com/pmd/pmd/issues/925): \[java] UnusedImports false positive for static import
+* java-design
+ * [#855](https://github.com/pmd/pmd/issues/855): \[java] ImmutableField false-positive with lambdas
+* java-documentation
+ * [#877](https://github.com/pmd/pmd/issues/877): \[java] CommentRequired valid rule configuration causes PMD error
+* java-errorprone
+ * [#885](https://github.com/pmd/pmd/issues/885): \[java] CompareObjectsWithEqualsRule trigger by enum1 != enum2
+* java-performance
+ * [#541](https://github.com/pmd/pmd/issues/541): \[java] ConsecutiveLiteralAppends with types other than string
+* scala
+ * [#853](https://github.com/pmd/pmd/issues/853): \[scala] Upgrade scala version to support Java 9
+* xml
+ * [#739](https://github.com/pmd/pmd/issues/739): \[xml] IllegalAccessException when accessing attribute using Saxon on JRE 9
+
+
+### API Changes
+
+#### Changes to the Node interface
+
+The method `getXPathNodeName` is added to the `Node` interface, which removes the
+use of the `toString` of a node to get its XPath element name (see [#569](https://github.com/pmd/pmd/issues/569)).
+A default implementation is provided in `AbstractNode`, to stay compatible
+with existing implementors.
+
+The `toString` method of a Node is not changed for the time being, and still produces
+the name of the XPath node. That behaviour may however change in future major releases,
+e.g. to produce a more useful message for debugging.
+
+#### Changes to CPD renderers
+
+The interface `net.sourceforge.pmd.cpd.Renderer` has been deprecated. A new interface `net.sourceforge.pmd.cpd.renderer.CPDRenderer`
+has been introduced to replace it. The main difference is that the new interface is meant to render directly to a `java.io.Writer`
+rather than to a String. This allows to greatly reduce the memory footprint of CPD, as on large projects, with many duplications,
+it was causing `OutOfMemoryError`s (see [#795](https://github.com/pmd/pmd/issues/795)).
+
+`net.sourceforge.pmd.cpd.FileReporter` has also been deprecated as part of this change, as it's no longer needed.
+
+### External Contributions
+
+* [#790](https://github.com/pmd/pmd/pull/790): \[java] Added some comments for JDK 9 - [Tobias Weimer](https://github.com/tweimer)
+* [#803](https://github.com/pmd/pmd/pull/803): \[doc] Added SpotBugs as successor of FindBugs - [Tobias Weimer](https://github.com/tweimer)
+* [#828](https://github.com/pmd/pmd/pull/828): \[core] Add operations to manipulate a document - [Gonzalo Ibars Ingman](https://github.com/gibarsin)
+* [#830](https://github.com/pmd/pmd/pull/830): \[java] UseArraysAsList: Description added - [Tobias Weimer](https://github.com/tweimer)
+* [#845](https://github.com/pmd/pmd/pull/845): \[java] Fix false negative PreserveStackTrace on string concatenation - [Alberto Fernández](https://github.com/albfernandez)
+* [#868](https://github.com/pmd/pmd/pull/868): \[core] Improve XPath documentation && make small refactors - [Gonzalo Ibars Ingman](https://github.com/gibarsin)
+* [#875](https://github.com/pmd/pmd/pull/875): \[core] Support shortnames when using filelist - [John Zhang](https://github.com/johnjiabinzhang)
+* [#886](https://github.com/pmd/pmd/pull/886): \[java] Fix #885 - [Matias Comercio](https://github.com/MatiasComercio)
+* [#900](https://github.com/pmd/pmd/pull/900): \[core] Use the isEmpty method instead of comparing the value of size() to 0 - [reudismam](https://github.com/reudismam)
+* [#914](https://github.com/pmd/pmd/pull/914): \[doc] Apex @SuppressWarnings documentation updated - [Akshat Bahety](https://github.com/akshatbahety)
+* [#918](https://github.com/pmd/pmd/pull/918): \[doc] Add qa-eclipse as new tool - [Akshat Bahety](https://github.com/akshatbahety)
+* [#927](https://github.com/pmd/pmd/pull/927): \[java]\[doc] Fix example of AbstractClassWithoutAnyMethod - [Kazuma Watanabe](https://github.com/wata727)
+
+
+## 21-January-2018 - 6.0.1
+
+The PMD team is pleased to announce PMD 6.0.1.
+
+This is a bug fixing release.
+
+### Table Of Contents
+
+* [Additional information about the new introduced rule categories](#additional-information-about-the-new-introduced-rule-categories)
+* [Fixed Issues](#fixed-issues)
+* [API Changes](#api-changes)
+* [External Contributions](#external-contributions)
+
+### Additional information about the new introduced rule categories
+
+With the release of PMD 6.0.0, all rules have been sorted into one of the following eight categories:
+
+1. **Best Practices**: These are rules which enforce generally accepted best practices.
+2. **Code Style**: These rules enforce a specific coding style.
+3. **Design**: Rules that help you discover design issues.
+4. **Documentation**: These rules are related to code documentation.
+5. **Error Prone**: Rules to detect constructs that are either broken, extremely confusing or prone to runtime errors.
+6. **Multithreading**: These are rules that flag issues when dealing with multiple threads of execution.
+7. **Performance**: Rules that flag suboptimal code.
+8. **Security**: Rules that flag potential security flaws.
+
+Please note, that not every category in every language may have a rule. There might be categories with no
+rules at all, such as `category/java/security.xml`, which has currently no rules.
+There are even languages, which only have rules of one category (e.g. `category/xml/errorprone.xml`).
+
+You can find the information about available rules in the generated rule documentation, available
+at <https://pmd.github.io/6.0.1/>.
+
+In order to help migrate to the new category scheme, the new name for the old, deprecated rule names will
+be logged as a warning. See [PR #865](https://github.com/pmd/pmd/pull/865). Please note, that the deprecated
+rule names will keep working throughout PMD 6. You can upgrade to PMD 6 without the immediate need
+to migrate your current ruleset. That backwards compatibility will be maintained until PMD 7.0.0 is released.
+
+### Fixed Issues
+
+* all
+ * [#842](https://github.com/pmd/pmd/issues/842): \[core] Use correct java bootclasspath for compiling
+* apex-errorprone
+ * [#792](https://github.com/pmd/pmd/issues/792): \[apex] AvoidDirectAccessTriggerMap incorrectly detects array access in classes
+* apex-security
+ * [#788](https://github.com/pmd/pmd/issues/788): \[apex] Method chaining breaks ApexCRUDViolation
+* doc
+ * [#782](https://github.com/pmd/pmd/issues/782): \[doc] Wrong information in the Release Notes about the Security ruleset
+ * [#794](https://github.com/pmd/pmd/issues/794): \[doc] Broken documentation links for 6.0.0
+* java
+ * [#793](https://github.com/pmd/pmd/issues/793): \[java] Parser error with private method in nested classes in interfaces
+ * [#814](https://github.com/pmd/pmd/issues/814): \[java] UnsupportedClassVersionError is failure instead of a warning
+ * [#831](https://github.com/pmd/pmd/issues/831): \[java] StackOverflow in JavaTypeDefinitionSimple.toString
+* java-bestpractices
+ * [#783](https://github.com/pmd/pmd/issues/783): \[java] GuardLogStatement regression
+ * [#800](https://github.com/pmd/pmd/issues/800): \[java] ForLoopCanBeForeach NPE when looping on `this` object
+* java-codestyle
+ * [#817](https://github.com/pmd/pmd/issues/817): \[java] UnnecessaryModifierRule crashes on valid code
+* java-design
+ * [#785](https://github.com/pmd/pmd/issues/785): \[java] NPE in DataClass rule
+ * [#812](https://github.com/pmd/pmd/issues/812): \[java] Exception applying rule DataClass
+ * [#827](https://github.com/pmd/pmd/issues/827): \[java] GodClass crashes with java.lang.NullPointerException
+* java-performance
+ * [#841](https://github.com/pmd/pmd/issues/841): \[java] InsufficientStringBufferDeclaration NumberFormatException
+* java-typeresolution
+ * [#866](https://github.com/pmd/pmd/issues/866): \[java] rulesets/java/typeresolution.xml lists non-existent rules
+
+### API Changes
+
+* The constant `net.sourceforge.pmd.PMD.VERSION` has been deprecated and will be removed with PMD 7.0.0.
+ Please use `net.sourceforge.pmd.PMDVersion.VERSION` instead.
+
+### External Contributions
+
+* [#796](https://github.com/pmd/pmd/pull/796): \[apex] AvoidDirectAccessTriggerMap incorrectly detects array access in classes - [Robert Sösemann](https://github.com/up2go-rsoesemann)
+* [#799](https://github.com/pmd/pmd/pull/799): \[apex] Method chaining breaks ApexCRUDViolation - [Robert Sösemann](https://github.com/up2go-rsoesemann)
+
+
+## 15-December-2017 - 6.0.0
+
+The PMD team is pleased to announce PMD 6.0.0.
+
+This is a major release.
+
+### Table Of Contents
+
+* [New and noteworthy](#new-and-noteworthy)
+ * [New Rule Designer](#new-rule-designer)
+ * [Java 9 support](#java-9-support)
+ * [Revamped Apex CPD](#revamped-apex-cpd)
+ * [Java Type Resolution](#java-type-resolution)
+ * [Metrics Framework](#metrics-framework)
+ * [Error Reporting](#error-reporting)
+ * [Apex Rule Suppression](#apex-rule-suppression)
+ * [Rule Categories](#rule-categories)
+ * [New Rules](#new-rules)
+ * [Modified Rules](#modified-rules)
+ * [Deprecated Rules](#deprecated-rules)
+ * [Removed Rules](#removed-rules)
+ * [Java Symbol Table](#java-symbol-table)
+ * [Apex Parser Update](#apex-parser-update)
+ * [Incremental Analysis](#incremental-analysis)
+ * [Rule and Report Properties](#rule-and-report-properties)
+* [Fixed Issues](#fixed-issues)
+* [API Changes](#api-changes)
+* [External Contributions](#external-contributions)
+
+### New and noteworthy
+
+#### New Rule Designer
+
+Thanks to [Clément Fournier](https://github.com/oowekyala), we now have a new rule designer GUI, which
+is based on JavaFX. It replaces the old designer and can be started via
+
+* `bin/run.sh designer` (on Unix-like platform such as Linux and Mac OS X)
+* `bin\designer.bat` (on Windows)
+
+Note: At least Java8 is required for the designer. The old designer is still available
+as `designerold` but will be removed with the next major release.
+
+#### Java 9 support
+
+The Java grammar has been updated to support analyzing Java 9 projects:
+
+* private methods in interfaces are possible
+* The underscore "\_" is considered an invalid identifier
+* Diamond operator for anonymous classes
+* The module declarations in `module-info.java` can be parsed
+* Concise try-with-resources statements are supported
+
+Java 9 support is enabled by default. You can switch back to an older java version
+via the command line, e.g. `-language java -version 1.8`.
+
+#### Revamped Apex CPD
+
+We are now using the Apex Jorje Lexer to tokenize Apex code for CPD. This change means:
+
+* All comments are now ignored for CPD. This is consistent with how other languages such as Java and Groovy work.
+* Tokenization honors the language specification, which improves accuracy.
+
+CPD will therefore have less false positives and false negatives.
+
+#### Java Type Resolution
+
+As part of Google Summer of Code 2017, [Bendegúz Nagy](https://github.com/WinterGrascph) worked on type resolution
+for Java. For this release he has extended support for method calls for both instance and static methods.
+
+Method shadowing and overloading are supported, as are varargs. However, the selection of the target method upon
+the presence of generics and type inference is still work in progress. Expect it in forecoming releases.
+
+As for fields, the basic support was in place for release 5.8.0, but has now been expanded to support static fields.
+
+#### Metrics Framework
+
+As part of Google Summer of Code 2017, [Clément Fournier](https://github.com/oowekyala) is worked
+on the new metrics framework for object-oriented metrics.
+
+There are already a couple of metrics (e.g. ATFD, WMC, Cyclo, LoC) implemented. More metrics are planned.
+Based on those metrics, rules like "GodClass" detection could be implemented more easily.
+The following rules benefit from the metrics framework: NcssCount (java), NPathComplexity (java),
+CyclomaticComplexity (both java and apex).
+
+The Metrics framework has been abstracted and is available in `pmd-core` for other languages. With this
+PMD release, the metrics framework is supported for both Java and Apex.
+
+#### Error Reporting
+
+A number of improvements on error reporting have taken place, meaning changes to some of the report formats.
+
+Also of note, the xml report now provides a XML Schema definition, allowing easier parsing and validation.
+
+##### Processing Errors
+
+Processing errors can now provide not only the message previously included on some reports, but also a full stacktrace.
+This will allow better error reports when providing feedback to the PMD team and help in debugging issues.
+
+The report formats providing full stacktrace of errors are:
+
+* html
+* summaryhtml
+* textcolor
+* vbhtml
+* xml
+
+##### Configuration Errors
+
+For a long time reports have been notified of configuration errors on rules, but they have remained hidden.
+On a push to make these more evident to users, and help them get the best results out of PMD, we have started
+to include them on the reports.
+
+So far, only reports that include processing errors are showing configuration errors. In other words, the report formats
+providing configuration error reporting are:
+
+* csv
+* html
+* summaryhtml
+* text
+* textcolor
+* vbhtml
+* xml
+
+As we move forward we will be able to detect and report more configuration errors (ie: incomplete `auxclasspath`)
+and include them to such reports.
+
+#### Apex Rule Suppression
+
+Apex violations can now be suppressed very similarly to how it's done in Java, by making use of a
+`@SuppressWarnings` annotation.
+
+Supported syntax includes:
+
+```
+@SupressWarnings('PMD') // to supress all Apex rules
+@SupressWarnings('all') // to supress all Apex rules
+@SupressWarnings('PMD.ARuleName') // to supress only the rule named ARuleName
+@SupressWarnings('PMD.ARuleName, PMD.AnotherRuleName') // to supress only the rule named ARuleName or AnotherRuleName
+```
+
+Notice this last scenario is slightly different to the Java syntax. This is due to differences in the Apex grammar for annotations.
+
+#### Rule Categories
+
+All built-in rules have been sorted into one of eight categories:
+
+1. **Best Practices**: These are rules which enforce generally accepted best practices.
+2. **Code Style**: These rules enforce a specific coding style.
+3. **Design**: Rules that help you discover design issues.
+4. **Documentation**: These rules are related to code documentation.
+5. **Error Prone**: Rules to detect constructs that are either broken, extremely confusing or prone to runtime errors.
+6. **Multithreading**: These are rules that flag issues when dealing with multiple threads of execution.
+7. **Performance**: Rules that flag suboptimal code.
+8. **Security**: Rules that flag potential security flaws.
+
+These categories help you to find rules and figure out the relevance and impact for your project.
+
+All rules have been moved accordingly, e.g. the rule "JumbledIncrementer", which was previously defined in the
+ruleset "java-basic" has now been moved to the "Error Prone" category. The new rule reference to be used is
+`<rule ref="category/java/errorprone.xml/JumbledIncrementer"/>`.
+
+The old rulesets like "java-basic" are still kept for backwards-compatibility but will be removed eventually.
+The rule reference documentation has been updated to reflect these changes.
+
+#### New Rules
+
+* The new Java rule `NcssCount` (category `design`) replaces the three rules "NcssConstructorCount", "NcssMethodCount",
+ and "NcssTypeCount". The new rule uses the metrics framework to achieve the same. It has two properties, to
+ define the report level for method and class sizes separately. Constructors and methods are considered the same.
+
+* The new Java rule `DoNotExtendJavaLangThrowable` (category `errorprone`) is a companion for the
+ `java-strictexception.xml/DoNotExtendJavaLangError`, detecting direct extensions of `java.lang.Throwable`.
+
+* The new Java rule `ForLoopCanBeForeach` (category `errorprone`) helps to identify those for-loops that can
+ be safely refactored into for-each-loops available since java 1.5.
+
+* The new Java rule `AvoidFileStream` (category `performance`) helps to identify code relying on `FileInputStream` / `FileOutputStream`
+ which, by using a finalizer, produces extra / unnecessary overhead to garbage collection, and should be replaced with
+ `Files.newInputStream` / `Files.newOutputStream` available since java 1.7.
+
+* The new Java rule `DataClass` (category `design`) detects simple data-holders without behaviour. This might indicate
+ that the behaviour is scattered elsewhere and the data class exposes the internal data structure,
+ which breaks encapsulation.
+
+* The new Apex rule `AvoidDirectAccessTriggerMap` (category `errorprone`) helps to identify direct array access to triggers,
+ which can produce bugs by either accessing non-existing indexes, or leaving them out. You should use for-each-loops
+ instead.
+
+* The new Apex rule `AvoidHardcodingId` (category `errorprone`) detects hardcoded strings that look like identifiers
+ and flags them. Record IDs change between environments, meaning hardcoded ids are bound to fail under a different
+ setup.
+
+* The new Apex rule `CyclomaticComplexity` (category `design`) detects overly complex classes and methods. The
+ report threshold can be configured separately for classes and methods.
+
+* A whole bunch of new rules has been added to Apex. They all fit into the category `errorprone`.
+ The 5 rules are migrated for Apex from the equivalent Java rules and include:
+ * `EmptyCatchBlock` to detect catch blocks completely ignoring exceptions.
+ * `EmptyIfStmt` for if blocks with no content, that can be safely removed.
+ * `EmptyTryOrFinallyBlock` for empty try / finally blocks that can be safely removed.
+ * `EmptyWhileStmt` for empty while loops that can be safely removed.
+ * `EmptyStatementBlock` for empty code blocks that can be safely removed.
+
+* The new Apex rule `AvoidSoslInLoops` (category `performance`) is the companion of the old
+ `AvoidSoqlInLoops` rule, flagging SOSL (Salesforce Object Search Language) queries when within
+ loops, to avoid governor issues, and hitting the database too often.
+
+#### Modified Rules
+
+* The Java rule `UnnecessaryFinalModifier` (category `codestyle`, former ruleset `java-unnecessarycode`)
+ has been merged into the rule `UnnecessaryModifier`. As part of this, the rule has been revamped to detect more cases.
+ It will now flag anonymous class' methods marked as final (can't be overridden, so it's pointless), along with
+ final methods overridden / defined within enum instances. It will also flag `final` modifiers on try-with-resources.
+
+* The Java rule `UnnecessaryParentheses` (category `codestyle`, former ruleset `java-controversial`)
+ has been merged into `UselessParentheses` (category `codestyle`, former ruleset `java-unnecessary`).
+ The rule covers all scenarios previously covered by either rule.
+
+* The Java rule `UncommentedEmptyConstructor` (category `documentation`, former ruleset `java-design`)
+ will now ignore empty constructors annotated with `javax.inject.Inject`.
+
+* The Java rule `AbstractClassWithoutAnyMethod` (category `bestpractices`, former ruleset `java-design`)
+ will now ignore classes annotated with `com.google.auto.value.AutoValue`.
+
+* The Java rule `GodClass` (category `design', former ruleset `java-design`) has been revamped to use
+ the new metrics framework.
+
+* The Java rule `LooseCoupling` (category `bestpractices`, former ruleset `java-coupling`) has been
+ replaced by the typeresolution-based implementation.
+
+* The Java rule `CloneMethodMustImplementCloneable` (category `errorprone`, former ruleset `java-clone`)
+ has been replaced by the typeresolution-based
+ implementation and is now able to detect cases if a class implements or extends a Cloneable class/interface.
+
+* The Java rule `UnusedImports` (category `bestpractices`, former ruleset `java-imports`) has been
+ replaced by the typeresolution-based
+ implementation and is now able to detect unused on-demand imports.
+
+* The Java rule `SignatureDeclareThrowsException` (category `design`, former ruleset 'java-strictexception')
+ has been replaced by the
+ typeresolution-based implementation. It has a new property `IgnoreJUnitCompletely`, which allows all
+ methods in a JUnit testcase to throw exceptions.
+
+* The Java rule `NPathComplexity` (category `design`, former ruleset `java-codesize`) has been revamped
+ to use the new metrics framework.
+ Its report threshold can be configured via the property `reportLevel`, which replaces the now
+ deprecated property `minimum`.
+
+* The Java rule `CyclomaticComplexity` (category `design`, former ruleset `java-codesize`) has been
+ revamped to use the new metrics framework.
+ Its report threshold can be configured via the properties `classReportLevel` and `methodReportLevel` separately.
+ The old property `reportLevel`, which configured the level for both total class and method complexity,
+ is deprecated.
+
+* The Java rule `CommentRequired` (category `documentation`, former ruleset `java-comments`)
+ has been revamped to include 2 new properties:
+ * `accessorCommentRequirement` to specify documentation requirements for getters and setters (default to `ignored`)
+ * `methodWithOverrideCommentRequirement` to specify documentation requirements for methods annotated with `@Override` (default to `ignored`)
+
+* The Java rule `EmptyCatchBlock` (category `errorprone`, former ruleset `java-empty`) has been changed to ignore
+ exceptions named `ignore` or `expected` by default. You can still override this behaviour by setting the `allowExceptionNameRegex` property.
+
+* The Java rule `OptimizableToArrayCall` (category `performance`, former ruleset `design`) has been
+ modified to fit for the current JVM implementations: It basically detects now the opposite and suggests to
+ use `Collection.toArray(new E[0])` with a zero-sized array.
+ See [Arrays of Wisdom of the Ancients](https://shipilev.net/blog/2016/arrays-wisdom-ancients/).
+
+#### Deprecated Rules
+
+* The Java rules `NcssConstructorCount`, `NcssMethodCount`, and `NcssTypeCount` (ruleset `java-codesize`) have been
+ deprecated. They will be replaced by the new rule `NcssCount` in the category `design`.
+
+* The Java rule `LooseCoupling` in ruleset `java-typeresolution` is deprecated. Use the rule with the same name
+ from category `bestpractices` instead.
+
+* The Java rule `CloneMethodMustImplementCloneable` in ruleset `java-typeresolution` is deprecated. Use the rule with
+ the same name from category `errorprone` instead.
+
+* The Java rule `UnusedImports` in ruleset `java-typeresolution` is deprecated. Use the rule with
+ the same name from category `bestpractices` instead.
+
+* The Java rule `SignatureDeclareThrowsException` in ruleset `java-typeresolution` is deprecated. Use the rule
+ with the same name from category `design` instead.
+
+* The Java rule `EmptyStaticInitializer` in ruleset `java-empty` is deprecated. Use the rule `EmptyInitializer`
+ from the category `errorprone`, which covers both static and non-static empty initializers.`
+
+* The Java rules `GuardDebugLogging` (ruleset `java-logging-jakarta-commons`) and `GuardLogStatementJavaUtil`
+ (ruleset `java-logging-java`) have been deprecated. Use the rule `GuardLogStatement` from the
+ category `bestpractices`, which covers all cases regardless of the logging framework.
+
+#### Removed Rules
+
+* The deprecated Java rule `UseSingleton` has been removed from the ruleset `java-design`. The rule has been renamed
+ long time ago to `UseUtilityClass` (category `design`).
+
+#### Java Symbol Table
+
+A [bug in symbol table](https://github.com/pmd/pmd/pull/549/commits/0958621ca884a8002012fc7738308c8dfc24b97c) prevented
+the symbol table analysis to properly match primitive arrays types. The issue [affected the `java-unsedcode/UnusedPrivateMethod`](https://github.com/pmd/pmd/issues/521)
+rule, but other rules may now produce improved results as consequence of this fix.
+
+#### Apex Parser Update
+
+The Apex parser version was bumped, from `1.0-sfdc-187` to `210-SNAPSHOT`. This update let us take full advantage
+of the latest improvements from Salesforce, but introduces some breaking changes:
+
+* `BlockStatements` are now created for all control structures, even if no brace is used. We have therefore added
+ a `hasCurlyBrace` method to differentiate between both scenarios.
+* New AST node types are available. In particular `CastExpression`, `ConstructorPreamble`, `IllegalStoreExpression`,
+ `MethodBlockStatement`, `Modifier`, `MultiStatement`, `NestedExpression`, `NestedStoreExpression`,
+ `NewKeyValueObjectExpression` and `StatementExecuted`
+* Some nodes have been removed. Such is the case of `TestNode`, `DottedExpression` and `NewNameValueObjectExpression`
+ (replaced by `NewKeyValueObjectExpression`)
+
+All existing rules have been updated to reflect these changes. If you have custom rules, be sure to update them.
+
+For more info about the included Apex parser, see the new pmd module "pmd-apex-jorje", which packages and provides
+the parser as a binary.
+
+#### Incremental Analysis
+
+The incremental analysis feature first introduced in PMD 5.6.0 has been enhanced. A few minor issues have been fixed,
+and several improvements have been performed to make it more accurate.
+
+The cache will now detect changes to the JARs referenced in the `auxclasspath` instead of simply looking at their paths
+and order. This means that if you are referencing a JAR you are overwriting in some way, the incremental analysis can
+now detect it and invalidate it's cache to avoid false reports.
+
+Similarly, any changes to the execution classpath of PMD will invalidate the cache. This means that if you have custom
+rules packaged in a jar, any changes to it will invalidate the cache automatically.
+
+We have also improved logging on the analysis code, allowing better insight into how the cache is performing,
+under debug / verbose builds you can even see individual hits / misses to the cache (and the reason for any miss!)
+
+Finally, as this feature keeps maturing, we are gently pushing this forward. If not using incremental analysis,
+a warning will now be produced suggesting users to adopt it for better performance.
+
+#### Rule and Report Properties
+
+The implementation around the properties support for rule properties and report properties has been revamped
+to be fully typesafe. Along with that change, the support classes have been moved into an own
+package `net.sourceforge.pmd.properties`. While there is no change necessary in the ruleset XML files,
+when using/setting values for rules, there are adjustments necessary when declaring properties in Java-implemented
+rules.
+
+Rule properties can be declared both for Java based rules and XPath rules.
+This is now very well documented in [Working with properties](pmd_devdocs_working_with_properties.html).
+
+With PMD 6.0.0, multivalued properties are now also possible with XPath rules.
+
+### Fixed Issues
+
+* all
+ * [#394](https://github.com/pmd/pmd/issues/394): \[core] PMD exclude rules are failing with IllegalArgumentException with non-default minimumPriority
+ * [#532](https://github.com/pmd/pmd/issues/532): \[core] security concerns on URL-based rulesets
+ * [#538](https://github.com/pmd/pmd/issues/538): \[core] Provide an XML Schema for XML reports
+ * [#600](https://github.com/pmd/pmd/issues/600): \[core] Nullpointer while creating cache File
+ * [#604](https://github.com/pmd/pmd/issues/604): \[core] Incremental analysis should detect changes to jars in classpath
+ * [#608](https://github.com/pmd/pmd/issues/608): \[core] Add DEBUG log when applying incremental analysis
+ * [#618](https://github.com/pmd/pmd/issues/618): \[core] Incremental Analysis doesn't close file correctly on Windows upon a cache hit
+ * [#643](https://github.com/pmd/pmd/issues/643): \[core] PMD Properties (dev-properties) breaks markup on CodeClimateRenderer
+ * [#680](https://github.com/pmd/pmd/pull/680): \[core] Isolate classloaders for runtime and auxclasspath
+ * [#762](https://github.com/pmd/pmd/issues/762): \[core] Remove method and file property from available property descriptors for XPath rules
+ * [#763](https://github.com/pmd/pmd/issues/763): \[core] Turn property descriptor util into an enum and enrich its interface
+* apex
+ * [#265](https://github.com/pmd/pmd/issues/265): \[apex] Make Rule suppression work
+ * [#488](https://github.com/pmd/pmd/pull/488): \[apex] Use Apex lexer for CPD
+ * [#489](https://github.com/pmd/pmd/pull/489): \[apex] Update Apex compiler
+ * [#500](https://github.com/pmd/pmd/issues/500): \[apex] Running through CLI shows jorje optimization messages
+ * [#605](https://github.com/pmd/pmd/issues/605): \[apex] java.lang.NoClassDefFoundError in the latest build
+ * [#637](https://github.com/pmd/pmd/issues/637): \[apex] Avoid SOSL in loops
+ * [#760](https://github.com/pmd/pmd/issues/760): \[apex] EmptyStatementBlock complains about missing rather than empty block
+ * [#766](https://github.com/pmd/pmd/issues/766): \[apex] Replace old Jorje parser with new one
+ * [#768](https://github.com/pmd/pmd/issues/768): \[apex] java.lang.NullPointerException from PMD
+* cpp
+ * [#448](https://github.com/pmd/pmd/issues/448): \[cpp] Write custom CharStream to handle continuation characters
+* java
+ * [#1454](https://sourceforge.net/p/pmd/bugs/1454/): \[java] OptimizableToArrayCall is outdated and invalid in current JVMs
+ * [#1513](https://sourceforge.net/p/pmd/bugs/1513/): \[java] Remove deprecated rule UseSingleton
+ * [#328](https://github.com/pmd/pmd/issues/328): \[java] java.lang.ClassFormatError: Absent Code attribute in method that is not native or abstract in class file javax/servlet/jsp/PageContext
+ * [#487](https://github.com/pmd/pmd/pull/487): \[java] Fix typeresolution for anonymous extending object
+ * [#496](https://github.com/pmd/pmd/issues/496): \[java] processing error on generics inherited from enclosing class
+ * [#510](https://github.com/pmd/pmd/issues/510): \[java] Typeresolution fails on a simple primary when the source is loaded from a class literal
+ * [#527](https://github.com/pmd/pmd/issues/527): \[java] Lombok getter annotation on enum is not recognized correctly
+ * [#534](https://github.com/pmd/pmd/issues/534): \[java] NPE in MethodTypeResolution for static methods
+ * [#603](https://github.com/pmd/pmd/issues/603): \[core] incremental analysis should invalidate upon Java rule plugin changes
+ * [#650](https://github.com/pmd/pmd/issues/650): \[java] ProcesingError analyzing code under 5.8.1
+ * [#732](https://github.com/pmd/pmd/issues/732): \[java] LinkageError with aux classpath
+* java-basic
+ * [#565](https://github.com/pmd/pmd/pull/565): \[java] False negative on DontCallThreadRun when extending Thread
+* java-comments
+ * [#396](https://github.com/pmd/pmd/issues/396): \[java] CommentRequired: add properties to ignore @Override method and getters / setters
+ * [#536](https://github.com/pmd/pmd/issues/536): \[java] CommentDefaultAccessModifierRule ignores constructors
+* java-controversial
+ * [#388](https://github.com/pmd/pmd/issues/388): \[java] controversial.AvoidLiteralsInIfCondition 0.0 false positive
+ * [#408](https://github.com/pmd/pmd/issues/408): \[java] DFA not analyzing asserts
+ * [#537](https://github.com/pmd/pmd/issues/537): \[java] UnnecessaryParentheses fails to detect obvious scenario
+* java-design
+ * [#357](https://github.com/pmd/pmd/issues/357): \[java] UncommentedEmptyConstructor consider annotations on Constructor
+ * [#438](https://github.com/pmd/pmd/issues/438): \[java] Relax AbstractClassWithoutAnyMethod when class is annotated by @AutoValue
+ * [#590](https://github.com/pmd/pmd/issues/590): \[java] False positive on MissingStaticMethodInNonInstantiatableClass
+* java-logging
+ * [#457](https://github.com/pmd/pmd/issues/457): \[java] Merge all log guarding rules
+ * [#721](https://github.com/pmd/pmd/issues/721): \[java] NPE in PMD 5.8.1 InvalidSlf4jMessageFormat
+* java-sunsecure
+ * [#468](https://github.com/pmd/pmd/issues/468): \[java] ArrayIsStoredDirectly false positive
+* java-unusedcode
+ * [#521](https://github.com/pmd/pmd/issues/521): \[java] UnusedPrivateMethod returns false positives with primitive data type in map argument
+* java-unnecessarycode
+ * [#412](https://github.com/pmd/pmd/issues/412): \[java] java-unnecessarycode/UnnecessaryFinalModifier missing cases
+ * [#676](https://github.com/pmd/pmd/issues/676): \[java] java-unnecessarycode/UnnecessaryFinalModifier on try-with-resources
+
+### API Changes
+
+* The class `net.sourceforge.pmd.lang.dfa.NodeType` has been converted to an enum.
+ All node types are enum members now instead of int constants. The names for node types are retained.
+
+* The *Properties API* (rule and report properties) has been revamped to be fully typesafe. This is everything
+ around `net.sourceforge.pmd.properties.PropertyDescriptor`.
+
+ Note: All classes related to properties have been moved into the package `net.sourceforge.pmd.properties`.
+
+* The rule classes `net.sourceforge.pmd.lang.apex.rule.apexunit.ApexUnitTestClassShouldHaveAsserts`
+ and `net.sourceforge.pmd.lang.apex.rule.apexunit.ApexUnitTestShouldNotUseSeeAllDataTrue` have been
+ renamed to `ApexUnitTestClassShouldHaveAssertsRule` and `ApexUnitTestShouldNotUseSeeAllDataTrueRule`,
+ respectively. This is to comply with the naming convention, that each rule class should be suffixed with "Rule".
+
+ This change has no impact on custom rulesets, since the rule names themselves didn't change.
+
+* The never implemented method `PMD.processFiles(PMDConfiguration, RuleSetFactory, Collection<File>, RuleContext, ProgressMonitor)` along with the interface `ProgressMonitor` has been removed.
+
+* The method `PMD.setupReport(RuleSets, RuleContext, String)` is gone. It was used to report dysfunctional
+ rules. But PMD does this now automatically before processing the files, so there is no need for this
+ method anymore.
+
+* All APIs deprecated in older versions are now removed. This includes:
+ * `Renderer.getPropertyDefinitions`
+ * `AbstractRenderer.defineProperty(String, String)`
+ * `AbstractRenderer.propertyDefinitions`
+ * `ReportListener`
+ * `Report.addListener(ReportListener)`
+ * `SynchronizedReportListener`
+ * `CPDConfiguration.CPDConfiguration(int, Language, String)`
+ * `CPDConfiguration.getRendererFromString(String)`
+ * `StreamUtil`
+ * `StringUtil.appendXmlEscaped(StringBuilder, String)`
+ * `StringUtil.htmlEncode(String)`
+
+
+* Several methods in `net.sourceforge.pmd.util.CollectionUtil` have been deprecated and will be removed in PMD 7.0.0. In particular:
+ * `CollectionUtil.addWithoutDuplicates(T[], T)`
+ * `CollectionUtil.addWithoutDuplicates(T[], T[])`
+ * `CollectionUtil.areSemanticEquals(T[], T[])`
+ * `CollectionUtil.areEqual(Object, Object)`
+ * `CollectionUtil.arraysAreEqual(Object, Object)`
+ * `CollectionUtil.valuesAreTransitivelyEqual(Object[], Object[])`
+
+
+* Several methods in `net.sourceforge.pmd.util.StringUtil` have been deprecated and will be removed in PMD 7.0.0. In particular:
+ * `StringUtil.startsWithAny(String, String[])`
+ * `StringUtil.isNotEmpty(String)`
+ * `StringUtil.isEmpty(String)`
+ * `StringUtil.isMissing(String)`
+ * `StringUtil.areSemanticEquals(String, String)`
+ * `StringUtil.replaceString(String, String, String)`
+ * `StringUtil.replaceString(String, char, String)`
+ * `StringUtil.substringsOf(String, char)`
+ * `StringUtil.substringsOf(String, String)`
+ * `StringUtil.asStringOn(StringBuffer, Iterator, String)`
+ * `StringUtil.asStringOn(StringBuilder, Object[], String)`
+ * `StringUtil.lpad(String, int)`
+
+* The class `net.sourceforge.pmd.lang.java.typeresolution.typedefinition.JavaTypeDefinition` is now abstract, and has been enhanced
+ to provide several new methods.
+
+* The constructor of `net.sourceforge.pmd.RuleSetFactory`, which took a `ClassLoader` is deprecated.
+ Please use the alternative constructor with the `net.sourceforge.pmd.util.ResourceLoader` instead.
+
+* The following GUI related classes have been deprecated and will be removed in PMD 7.0.0.
+ The tool "bgastviewer", that could be started via the script `bgastviewer.bat` or `run.sh bgastviewer` is
+ deprecated, too, and will be removed in PMD 7.0.0.
+ Both the "old designer" and "bgastviewer" are replaced by the [New Rule Designer](#new-rule-designer).
+ * `net.sourceforge.pmd.util.designer.CodeEditorTextPane`
+ * `net.sourceforge.pmd.util.designer.CreateXMLRulePanel`
+ * `net.sourceforge.pmd.util.designer.Designer`
+ * `net.sourceforge.pmd.util.designer.DFAPanel`
+ * `net.sourceforge.pmd.util.designer.LineGetter`
+ * `net.sourceforge.pmd.util.viewer.Viewer`
+ * `net.sourceforge.pmd.util.viewer.gui.ActionCommands`
+ * `net.sourceforge.pmd.util.viewer.gui.ASTPanel`
+ * `net.sourceforge.pmd.util.viewer.gui.EvaluationResultsPanel`
+ * `net.sourceforge.pmd.util.viewer.gui.MainFrame`
+ * `net.sourceforge.pmd.util.viewer.gui.ParseExceptionHandler`
+ * `net.sourceforge.pmd.util.viewer.gui.SourceCodePanel`
+ * `net.sourceforge.pmd.util.viewer.gui.XPathPanel`
+ * `net.sourceforge.pmd.util.viewer.gui.menu.ASTNodePopupMenu`
+ * `net.sourceforge.pmd.util.viewer.gui.menu.AttributesSubMenu`
+ * `net.sourceforge.pmd.util.viewer.gui.menu.SimpleNodeSubMenu`
+ * `net.sourceforge.pmd.util.viewer.gui.menu.XPathFragmentAddingItem`
+ * `net.sourceforge.pmd.util.viewer.model.ASTModel`
+ * `net.sourceforge.pmd.util.viewer.model.AttributeToolkit`
+ * `net.sourceforge.pmd.util.viewer.model.SimpleNodeTreeNodeAdapter`
+ * `net.sourceforge.pmd.util.viewer.model.ViewerModel`
+ * `net.sourceforge.pmd.util.viewer.model.ViewerModelEvent`
+ * `net.sourceforge.pmd.util.viewer.model.ViewerModelListener`
+ * `net.sourceforge.pmd.util.viewer.util.NLS`
+
+* The following methods in `net.sourceforge.pmd.Rule` have been deprecated and will be removed in PMD 7.0.0.
+ All methods are replaced by their bean-like counterparts
+ * `void setUsesDFA()`. Use `void setDfa(boolean)` instead.
+ * `boolean usesDFA()`. Use `boolean isDfa()` instead.
+ * `void setUsesTypeResolution()`. Use `void setTypeResolution(boolean)` instead.
+ * `boolean usesTypeResolution()`. Use `boolean isTypeResolution()` instead.
+ * `void setUsesMultifile()`. Use `void setMultifile(boolean)` instead.
+ * `boolean usesMultifile()`. Use `boolean isMultifile()` instead.
+ * `boolean usesRuleChain()`. Use `boolean isRuleChain()` instead.
+
+### External Contributions
+
+* [#287](https://github.com/pmd/pmd/pull/287): \[apex] Make Rule suppression work - [Robert Sösemann](https://github.com/up2go-rsoesemann)
+* [#420](https://github.com/pmd/pmd/pull/420): \[java] Fix UR anomaly in assert statements - [Clément Fournier](https://github.com/oowekyala)
+* [#482](https://github.com/pmd/pmd/pull/482): \[java] Metrics testing framework + improved capabilities for metrics - [Clément Fournier](https://github.com/oowekyala)
+* [#484](https://github.com/pmd/pmd/pull/484): \[core] Changed linux usage to a more unix like path - [patriksevallius](https://github.com/patriksevallius)
+* [#486](https://github.com/pmd/pmd/pull/486): \[java] Add basic method typeresolution - [Bendegúz Nagy](https://github.com/WinterGrascph)
+* [#492](https://github.com/pmd/pmd/pull/492): \[java] Typeresolution for overloaded methods - [Bendegúz Nagy](https://github.com/WinterGrascph)
+* [#495](https://github.com/pmd/pmd/pull/495): \[core] Custom rule reinitialization code - [Clément Fournier](https://github.com/oowekyala)
+* [#479](https://github.com/pmd/pmd/pull/479): \[core] Typesafe and immutable properties - [Clément Fournier](https://github.com/oowekyala)
+* [#499](https://github.com/pmd/pmd/pull/499): \[java] Metrics memoization tests - [Clément Fournier](https://github.com/oowekyala)
+* [#501](https://github.com/pmd/pmd/pull/501): \[java] Add support for most specific vararg method type resolution - [Bendegúz Nagy](https://github.com/WinterGrascph)
+* [#502](https://github.com/pmd/pmd/pull/502): \[java] Add support for static field type resolution - [Bendegúz Nagy](https://github.com/WinterGrascph)
+* [#505](https://github.com/pmd/pmd/pull/505): \[java] Followup on metrics - [Clément Fournier](https://github.com/oowekyala)
+* [#506](https://github.com/pmd/pmd/pull/506): \[java] Add reduction rules to type inference - [Bendegúz Nagy](https://github.com/WinterGrascph)
+* [#511](https://github.com/pmd/pmd/pull/511): \[core] Prepare abstraction of the metrics framework - [Clément Fournier](https://github.com/oowekyala)
+* [#512](https://github.com/pmd/pmd/pull/512): \[java] Add incorporation to type inference - [Bendegúz Nagy](https://github.com/WinterGrascph)
+* [#513](https://github.com/pmd/pmd/pull/513): \[java] Fix for maximally specific method selection - [Bendegúz Nagy](https://github.com/WinterGrascph)
+* [#514](https://github.com/pmd/pmd/pull/514): \[java] Add static method type resolution - [Bendegúz Nagy](https://github.com/WinterGrascph)
+* [#517](https://github.com/pmd/pmd/pull/517): \[doc] Metrics documentation - [Clément Fournier](https://github.com/oowekyala)
+* [#518](https://github.com/pmd/pmd/pull/518): \[core] Properties refactoring: factorized enumerated property - [Clément Fournier](https://github.com/oowekyala)
+* [#523](https://github.com/pmd/pmd/pull/523): \[java] Npath complexity metric and rule - [Clément Fournier](https://github.com/oowekyala)
+* [#524](https://github.com/pmd/pmd/pull/524): \[java] Add support for explicit type arguments with method invocation - [Bendegúz Nagy](https://github.com/WinterGrascph)
+* [#525](https://github.com/pmd/pmd/pull/525): \[core] Fix line ending and not ignored files issues - [Matias Comercio](https://github.com/MatiasComercio)
+* [#528](https://github.com/pmd/pmd/pull/528): \[core] Fix typo - [Ayoub Kaanich](https://github.com/kayoub5)
+* [#529](https://github.com/pmd/pmd/pull/529): \[java] Abstracted the Java metrics framework - [Clément Fournier](https://github.com/oowekyala)
+* [#530](https://github.com/pmd/pmd/pull/530): \[java] Fix issue #527: Lombok getter annotation on enum is not recognized correctly - [Clément Fournier](https://github.com/oowekyala)
+* [#533](https://github.com/pmd/pmd/pull/533): \[core] improve error message - [Dennis Kieselhorst](https://github.com/deki)
+* [#535](https://github.com/pmd/pmd/pull/535): \[apex] Fix broken Apex visitor adapter - [Clément Fournier](https://github.com/oowekyala)
+* [#542](https://github.com/pmd/pmd/pull/542): \[java] Metrics abstraction - [Clément Fournier](https://github.com/oowekyala)
+* [#545](https://github.com/pmd/pmd/pull/545): \[apex] Apex metrics framework - [Clément Fournier](https://github.com/oowekyala)
+* [#548](https://github.com/pmd/pmd/pull/548): \[java] Metrics documentation - [Clément Fournier](https://github.com/oowekyala)
+* [#550](https://github.com/pmd/pmd/pull/550): \[java] Add basic resolution to type inference - [Bendegúz Nagy](https://github.com/WinterGrascph)
+* [#553](https://github.com/pmd/pmd/pull/553): \[java] Refactored ParserTst into a static utility class + add getSourceFromClass - [Clément Fournier](https://github.com/oowekyala)
+* [#554](https://github.com/pmd/pmd/pull/554): \[java] Fix #537: UnnecessaryParentheses fails to detect obvious scenario - [Clément Fournier](https://github.com/oowekyala)
+* [#555](https://github.com/pmd/pmd/pull/555): \[java] Changed metrics/CyclomaticComplexityRule to use WMC when reporting classes - [Clément Fournier](https://github.com/oowekyala)
+* [#556](https://github.com/pmd/pmd/pull/556): \[java] Fix #357: UncommentedEmptyConstructor consider annotations on Constructor - [Clément Fournier](https://github.com/oowekyala)
+* [#557](https://github.com/pmd/pmd/pull/557): \[java] Fix NPath metric not counting ternaries correctly - [Clément Fournier](https://github.com/oowekyala)
+* [#563](https://github.com/pmd/pmd/pull/563): \[java] Add support for basic method type inference for strict invocation - [Bendegúz Nagy](https://github.com/WinterGrascph)
+* [#566](https://github.com/pmd/pmd/pull/566): \[java] New rule in migrating ruleset: ForLoopCanBeForeach - [Clément Fournier](https://github.com/oowekyala)
+* [#567](https://github.com/pmd/pmd/pull/567): \[java] Last API change for metrics (metric options) - [Clément Fournier](https://github.com/oowekyala)
+* [#570](https://github.com/pmd/pmd/pull/570): \[java] Model lower, upper and intersection types - [Bendegúz Nagy](https://github.com/WinterGrascph)
+* [#573](https://github.com/pmd/pmd/pull/573): \[java] Data class rule - [Clément Fournier](https://github.com/oowekyala)
+* [#576](https://github.com/pmd/pmd/pull/576): \[doc]\[java] Add hint for Guava users in InefficientEmptyStringCheck - [mmoehring](https://github.com/mmoehring)
+* [#578](https://github.com/pmd/pmd/pull/578): \[java] Refactored god class rule - [Clément Fournier](https://github.com/oowekyala)
+* [#579](https://github.com/pmd/pmd/pull/579): \[java] Update parsing to produce upper and lower bounds - [Bendegúz Nagy](https://github.com/WinterGrascph)
+* [#580](https://github.com/pmd/pmd/pull/580): \[core] Add AbstractMetric to topple the class hierarchy of metrics - [Clément Fournier](https://github.com/oowekyala)
+* [#581](https://github.com/pmd/pmd/pull/581): \[java] Relax AbstractClassWithoutAnyMethod when class is annotated by @AutoValue - [Niklas Baudy](https://github.com/vanniktech)
+* [#583](https://github.com/pmd/pmd/pull/583): \[java] Documentation about writing metrics - [Clément Fournier](https://github.com/oowekyala)
+* [#585](https://github.com/pmd/pmd/pull/585): \[java] Moved NcssCountRule to codesize.xml - [Clément Fournier](https://github.com/oowekyala)
+* [#587](https://github.com/pmd/pmd/pull/587): \[core] Properties refactoring: Move static constants of ValueParser to class ValueParserConstants - [Clément Fournier](https://github.com/oowekyala)
+* [#588](https://github.com/pmd/pmd/pull/588): \[java] XPath function to compute metrics - [Clément Fournier](https://github.com/oowekyala)
+* [#598](https://github.com/pmd/pmd/pull/598): \[java] Fix #388: controversial.AvoidLiteralsInIfCondition 0.0 false positive - [Clément Fournier](https://github.com/oowekyala)
+* [#602](https://github.com/pmd/pmd/pull/602): \[java] \[apex] Separate multifile analysis from metrics - [Clément Fournier](https://github.com/oowekyala)
+* [#620](https://github.com/pmd/pmd/pull/620): \[core] Moved properties to n.s.pmd.properties - [Clément Fournier](https://github.com/oowekyala)
+* [#625](https://github.com/pmd/pmd/pull/625): \[apex] empty code ruleset for apex - [Jan Aertgeerts](https://github.com/JAertgeerts)
+* [#632](https://github.com/pmd/pmd/pull/632): \[apex] Add AvoidDirectAccessTriggerMap rule to the style set - [Jan Aertgeerts](https://github.com/JAertgeerts)
+* [#644](https://github.com/pmd/pmd/pull/644): \[core] Prevent internal dev-properties from being displayed on CodeClimate renderer - [Filipe Esperandio](https://github.com/filipesperandio)
+* [#660](https://github.com/pmd/pmd/pull/660): \[apex] avoid sosl in loops - [Jan Aertgeerts](https://github.com/JAertgeerts)
+* [#661](https://github.com/pmd/pmd/pull/661): \[apex] avoid hardcoding id's - [Jan Aertgeerts](https://github.com/JAertgeerts)
+* [#666](https://github.com/pmd/pmd/pull/666): \[java] Add DoNotExtendJavaLangThrowable rule - [Robert Painsi](https://github.com/robertpainsi)
+* [#668](https://github.com/pmd/pmd/pull/668): \[core] Fix javadoc warnings on pmd-core - [Clément Fournier](https://github.com/oowekyala)
+* [#669](https://github.com/pmd/pmd/pull/669): \[core] Builder pattern for properties - [Clément Fournier](https://github.com/oowekyala)
+* [#675](https://github.com/pmd/pmd/pull/675): \[java] Fix in Java grammar: Try with final resource node error - [Gonzalo Ibars Ingman](https://github.com/gibarsin)
+* [#679](https://github.com/pmd/pmd/pull/679): \[core] Token scheme generalization - [Gonzalo Ibars Ingman](https://github.com/gibarsin)
+* [#694](https://github.com/pmd/pmd/pull/694): \[core] Add minor fixes to root pom - [Matias Comercio](https://github.com/MatiasComercio)
+* [#696](https://github.com/pmd/pmd/pull/696): \[core] Add remove operation over nodes - [Matias Comercio](https://github.com/MatiasComercio)
+* [#711](https://github.com/pmd/pmd/pull/711): \[ui] New rule designer - [Clément Fournier](https://github.com/oowekyala)
+* [#722](https://github.com/pmd/pmd/pull/722): \[java] Move NPathComplexity from metrics to design - [Clément Fournier](https://github.com/oowekyala)
+* [#723](https://github.com/pmd/pmd/pull/723): \[core] Rule factory refactoring - [Clément Fournier](https://github.com/oowekyala)
+* [#726](https://github.com/pmd/pmd/pull/726): \[java] Fix issue #721 (NPE in InvalidSlf4jMessageFormat) - [Clément Fournier](https://github.com/oowekyala)
+* [#727](https://github.com/pmd/pmd/pull/727): \[core] Fix #725: numeric property descriptors now check their default value - [Clément Fournier](https://github.com/oowekyala)
+* [#733](https://github.com/pmd/pmd/pull/733): \[java] Some improvements to CommentRequired - [Clément Fournier](https://github.com/oowekyala)
+* [#734](https://github.com/pmd/pmd/pull/734): \[java] Move CyclomaticComplexity from metrics to design - [Clément Fournier](https://github.com/oowekyala)
+* [#736](https://github.com/pmd/pmd/pull/736): \[core] Make Saxon support multi valued XPath properties - [Clément Fournier](https://github.com/oowekyala)
+* [#737](https://github.com/pmd/pmd/pull/737): \[doc] Fix NPathComplexity documentation bad rendering - [Clément Fournier](https://github.com/oowekyala)
+* [#744](https://github.com/pmd/pmd/pull/744): \[doc] Added Apex to supported languages - [Michał Kuliński](https://github.com/coola)
+* [#746](https://github.com/pmd/pmd/pull/746): \[doc] Fix typo in incremental analysis log message - [Clément Fournier](https://github.com/oowekyala)
+* [#749](https://github.com/pmd/pmd/pull/749): \[doc] Update the documentation for properties - [Clément Fournier](https://github.com/oowekyala)
+* [#758](https://github.com/pmd/pmd/pull/758): \[core] Expose the full mapping from property type id to property extractor - [Clément Fournier](https://github.com/oowekyala)
+* [#764](https://github.com/pmd/pmd/pull/764): \[core] Prevent method and file property use in XPath rules - [Clément Fournier](https://github.com/oowekyala)
+* [#771](https://github.com/pmd/pmd/pull/771): \[apex] Fix Apex metrics framework failing on triggers, refs #768 - [Clément Fournier](https://github.com/oowekyala)
+* [#774](https://github.com/pmd/pmd/pull/774): \[java] Avoid using FileInput/Output - see JDK-8080225 - [Chas Honton](https://github.com/chonton)
## 01-July-2017 - 5.8.1
diff --git a/docs/pages/tags/tag_collaboration.md b/docs/pages/tags/tag_collaboration.md
deleted file mode 100644
index bec986c4ad7..00000000000
--- a/docs/pages/tags/tag_collaboration.md
+++ /dev/null
@@ -1,11 +0,0 @@
----
-title: "Collaboration pages"
-tagName: collaboration
-search: exclude
-permalink: tag_collaboration.html
-sidebar: mydoc_sidebar
-folder: tags
----
-{% include taglogic.html %}
-
-{% include links.html %}
diff --git a/docs/pages/tags/tag_content_types.md b/docs/pages/tags/tag_content_types.md
deleted file mode 100644
index fe87eaab59b..00000000000
--- a/docs/pages/tags/tag_content_types.md
+++ /dev/null
@@ -1,11 +0,0 @@
----
-title: "Content types pages"
-tagName: content_types
-search: exclude
-permalink: tag_content_types.html
-sidebar: mydoc_sidebar
-folder: tags
----
-{% include taglogic.html %}
-
-{% include links.html %}
diff --git a/docs/pages/tags/tag_customizing.md b/docs/pages/tags/tag_customizing.md
deleted file mode 100644
index fe1426428ed..00000000000
--- a/docs/pages/tags/tag_customizing.md
+++ /dev/null
@@ -1,11 +0,0 @@
----
-title: "Customizing PMD Pages"
-tagName: customizing
-search: exclude
-permalink: tag_customizing.html
-sidebar: pmd_sidebar
-folder: tags
----
-{% include taglogic.html %}
-
-{% include links.html %}
diff --git a/docs/pages/tags/tag_devdocs.md b/docs/pages/tags/tag_devdocs.md
new file mode 100644
index 00000000000..87aa8aa5411
--- /dev/null
+++ b/docs/pages/tags/tag_devdocs.md
@@ -0,0 +1,11 @@
+---
+title: "Developer and contributor documentation"
+tagName: devdocs
+search: exclude
+permalink: tag_devdocs.html
+sidebar: pmd_sidebar
+folder: tags
+---
+{% include taglogic.html %}
+
+{% include links.html %}
diff --git a/docs/pages/tags/tag_extending.md b/docs/pages/tags/tag_extending.md
new file mode 100644
index 00000000000..28291803daf
--- /dev/null
+++ b/docs/pages/tags/tag_extending.md
@@ -0,0 +1,9 @@
+---
+title: "Extending PMD"
+tagName: extending
+search: exclude
+permalink: tag_extending.html
+sidebar: pmd_sidebar
+folder: tags
+---
+{% include taglogic.html %}
diff --git a/docs/pages/tags/tag_formatting.md b/docs/pages/tags/tag_formatting.md
deleted file mode 100644
index 83325023378..00000000000
--- a/docs/pages/tags/tag_formatting.md
+++ /dev/null
@@ -1,11 +0,0 @@
----
-title: "Formatting pages"
-tagName: formatting
-search: exclude
-permalink: tag_formatting.html
-sidebar: mydoc_sidebar
-folder: tags
----
-{% include taglogic.html %}
-
-{% include links.html %}
diff --git a/docs/pages/tags/tag_languages.md b/docs/pages/tags/tag_languages.md
index 5cd56b1795d..886d150173d 100644
--- a/docs/pages/tags/tag_languages.md
+++ b/docs/pages/tags/tag_languages.md
@@ -3,7 +3,7 @@ title: "Supported Lanugages"
tagName: languages
search: exclude
permalink: tag_languages.html
-sidebar: mydoc_sidebar
+sidebar: pmd_sidebar
folder: tags
---
{% include taglogic.html %}
diff --git a/docs/pages/tags/tag_metrics.md b/docs/pages/tags/tag_metrics.md
new file mode 100644
index 00000000000..f189486a617
--- /dev/null
+++ b/docs/pages/tags/tag_metrics.md
@@ -0,0 +1,9 @@
+---
+title: "Code metrics"
+tagName: metrics
+search: exclude
+permalink: tag_metrics.html
+sidebar: pmd_sidebar
+folder: tags
+---
+{% include taglogic.html %}
diff --git a/docs/pages/tags/tag_mobile.md b/docs/pages/tags/tag_mobile.md
deleted file mode 100644
index 4f35333a27a..00000000000
--- a/docs/pages/tags/tag_mobile.md
+++ /dev/null
@@ -1,11 +0,0 @@
----
-title: "Mobile Pages"
-search: exclude
-tagName: mobile
-permalink: tag_mobile.html
-sidebar: mydoc_sidebar
-folder: tags
----
-{% include taglogic.html %}
-
-{% include links.html %}
diff --git a/docs/pages/tags/tag_navigation.md b/docs/pages/tags/tag_navigation.md
deleted file mode 100644
index 480d087b8e6..00000000000
--- a/docs/pages/tags/tag_navigation.md
+++ /dev/null
@@ -1,11 +0,0 @@
----
-title: "Navigation pages"
-tagName: navigation
-search: exclude
-permalink: tag_navigation.html
-sidebar: mydoc_sidebar
-folder: tags
----
-{% include taglogic.html %}
-
-{% include links.html %}
diff --git a/docs/pages/tags/tag_news.md b/docs/pages/tags/tag_news.md
deleted file mode 100644
index 3dc9414239d..00000000000
--- a/docs/pages/tags/tag_news.md
+++ /dev/null
@@ -1,11 +0,0 @@
----
-title: "News"
-tagName: news
-search: exclude
-permalink: tag_news.html
-sidebar: mydoc_sidebar
-folder: tags
----
-{% include taglogic.html %}
-
-{% include links.html %}
diff --git a/docs/pages/tags/tag_publishing.md b/docs/pages/tags/tag_publishing.md
deleted file mode 100644
index 5d948f0e2f4..00000000000
--- a/docs/pages/tags/tag_publishing.md
+++ /dev/null
@@ -1,11 +0,0 @@
----
-title: "Publishing pages"
-tagName: publishing
-search: exclude
-permalink: tag_publishing.html
-sidebar: mydoc_sidebar
-folder: tags
----
-{% include taglogic.html %}
-
-{% include links.html %}
diff --git a/docs/pages/tags/tag_release_notes.md b/docs/pages/tags/tag_release_notes.md
index 8d0685a831c..2804c0ff307 100644
--- a/docs/pages/tags/tag_release_notes.md
+++ b/docs/pages/tags/tag_release_notes.md
@@ -3,7 +3,7 @@ title: "Release Notes Pages"
tagName: release_notes
search: exclude
permalink: tag_release_notes.html
-sidebar: mydoc_sidebar
+sidebar: pmd_sidebar
folder: tags
---
{% include taglogic.html %}
diff --git a/docs/pages/tags/tag_rule_references.md b/docs/pages/tags/tag_rule_references.md
new file mode 100644
index 00000000000..2d0ca25b18c
--- /dev/null
+++ b/docs/pages/tags/tag_rule_references.md
@@ -0,0 +1,11 @@
+---
+title: "Rule references"
+tagName: rule_references
+search: exclude
+permalink: tag_rule_references.html
+sidebar: pmd_sidebar
+folder: tags
+---
+{% include taglogic.html %}
+
+{% include links.html %}
diff --git a/docs/pages/tags/tag_single_sourcing.md b/docs/pages/tags/tag_single_sourcing.md
deleted file mode 100644
index ae181e154ef..00000000000
--- a/docs/pages/tags/tag_single_sourcing.md
+++ /dev/null
@@ -1,11 +0,0 @@
----
-title: "Single sourcing pages"
-tagName: single_sourcing
-search: exclude
-permalink: tag_single_sourcing.html
-sidebar: mydoc_sidebar
-folder: tags
----
-{% include taglogic.html %}
-
-{% include links.html %}
diff --git a/docs/pages/tags/tag_special_layouts.md b/docs/pages/tags/tag_special_layouts.md
deleted file mode 100644
index b010362e967..00000000000
--- a/docs/pages/tags/tag_special_layouts.md
+++ /dev/null
@@ -1,12 +0,0 @@
----
-title: "Special layout pages"
-tagName: special_layouts
-search: exclude
-permalink: tag_special_layouts.html
-sidebar: mydoc_sidebar
-folder: tags
----
-
-{% include taglogic.html %}
-
-{% include links.html %}
diff --git a/docs/pages/tags/tag_tools.md b/docs/pages/tags/tag_tools.md
new file mode 100644
index 00000000000..de8532dc7a5
--- /dev/null
+++ b/docs/pages/tags/tag_tools.md
@@ -0,0 +1,11 @@
+---
+title: "Tools and integrations"
+tagName: tools
+search: exclude
+permalink: tag_tools.html
+sidebar: pmd_sidebar
+folder: tags
+---
+{% include taglogic.html %}
+
+{% include links.html %}
diff --git a/docs/pages/tags/tag_userdocs.md b/docs/pages/tags/tag_userdocs.md
new file mode 100644
index 00000000000..6d7ffcb3fa1
--- /dev/null
+++ b/docs/pages/tags/tag_userdocs.md
@@ -0,0 +1,8 @@
+---
+title: "User documentation"
+tagName: userdocs
+search: exclude
+permalink: tag_userdocs.html
+sidebar: pmd_sidebar
+---
+{% include taglogic.html %}
diff --git a/docs/search.json b/docs/search.json
index a7f7dd0fe10..3a9de069120 100644
--- a/docs/search.json
+++ b/docs/search.json
@@ -7,6 +7,20 @@ search: exclude
[
{% for page in site.pages %}
{% unless page.search == "exclude" %}
+
+{% if page.permalink contains "pmd_rules_" and page.keywords %}
+{% assign rules = page.keywords | split: ", " %}
+{% for rule in rules %}
+{
+"title": "{{ rule | escape }} ({{page.language}}, {{page.title}})",
+"tags": "{{ page.tags }}",
+"keywords": "{{rule}}",
+"url": "{{ page.url | remove: "/"}}#{{ rule | downcase }}",
+"summary": "{{page.summary | strip }}"
+}
+{% unless forloop.last %},{% endunless %}
+{% endfor %}
+{% else %}
{
"title": "{{ page.title | escape }}",
"tags": "{{ page.tags }}",
@@ -14,6 +28,9 @@ search: exclude
"url": "{{ page.url | remove: "/"}}",
"summary": "{{page.summary | strip }}"
}
+{% endif %}
+
+
{% unless forloop.last and site.posts.size < 1 %},{% endunless %}
{% endunless %}
{% endfor %}
diff --git a/docs/update.sh b/docs/update.sh
deleted file mode 100755
index 42a3bece578..00000000000
--- a/docs/update.sh
+++ /dev/null
@@ -1,4 +0,0 @@
-git add .
-git status
-git commit -m "content update"
-git push
\ No newline at end of file
diff --git a/example-toolchains.xml b/example-toolchains.xml
deleted file mode 100644
index ff0b1d5c954..00000000000
--- a/example-toolchains.xml
+++ /dev/null
@@ -1,28 +0,0 @@
-<?xml version="1.0" encoding="UTF8"?>
-<toolchains>
- <!-- place this file in ${user.home}/.m2/toolchains.xml -->
- <!-- adjust the paths to jdkhome -->
-
- <toolchain>
- <type>jdk</type>
- <provides>
- <version>1.7</version>
- </provides>
- <configuration>
- <jdkHome>/path/to/jdk/1.7</jdkHome> <!-- Linux -->
- <jdkHome>/Library/Java/JavaVirtualMachines/jdk1.7.0_80.jdk/Contents/Home</jdkHome> <!-- MacOSX -->
- <jdkHome>C:\\java\\edition\\jdk1.7.0_80</jdkHome> <!-- Windows -->
- </configuration>
- </toolchain>
- <toolchain>
- <type>jdk</type>
- <provides>
- <version>1.8</version>
- </provides>
- <configuration>
- <jdkHome>/path/to/jdk/1.8</jdkHome> <!-- Linux -->
- <jdkHome>/Library/Java/JavaVirtualMachines/jdk1.8.0_131.jdk/Contents/Home</jdkHome> <!-- MacOSX -->
- <jdkHome>C:\\java\\edition\\jdk1.8.0_131</jdkHome> <!-- Windows -->
- </configuration>
- </toolchain>
-</toolchains>
\ No newline at end of file
diff --git a/mvnw b/mvnw
index 5bf251c0774..e96ccd5fbbb 100755
--- a/mvnw
+++ b/mvnw
@@ -108,7 +108,7 @@ if $cygwin ; then
CLASSPATH=`cygpath --path --unix "$CLASSPATH"`
fi
-# For Migwn, ensure paths are in UNIX format before anything is touched
+# For Mingw, ensure paths are in UNIX format before anything is touched
if $mingw ; then
[ -n "$M2_HOME" ] &&
M2_HOME="`(cd "$M2_HOME"; pwd)`"
@@ -201,7 +201,9 @@ if [ -z "$BASE_DIR" ]; then
fi
export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}
-echo $MAVEN_PROJECTBASEDIR
+if [ "$MVNW_VERBOSE" = true ]; then
+ echo $MAVEN_PROJECTBASEDIR
+fi
MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS"
# For Cygwin, switch paths to Windows format before running java
diff --git a/mvnw.cmd b/mvnw.cmd
index 019bd74d766..6a6eec39baf 100755
--- a/mvnw.cmd
+++ b/mvnw.cmd
@@ -35,6 +35,8 @@
@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on'
@echo off
+@REM set title of command window
+title %0
@REM enable echoing my setting MAVEN_BATCH_ECHO to 'on'
@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO%
diff --git a/pmd-apex-jorje/pom.xml b/pmd-apex-jorje/pom.xml
new file mode 100644
index 00000000000..e4db1c5e79d
--- /dev/null
+++ b/pmd-apex-jorje/pom.xml
@@ -0,0 +1,138 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+ <artifactId>pmd-apex-jorje</artifactId>
+ <name>PMD Apex Jorje Parser Library</name>
+ <packaging>pom</packaging>
+
+ <parent>
+ <groupId>net.sourceforge.pmd</groupId>
+ <artifactId>pmd</artifactId>
+ <version>6.10.0-SNAPSHOT</version>
+ </parent>
+
+ <properties>
+ <java.version>8</java.version>
+ <!-- Workaround for https://youtrack.jetbrains.com/issue/IDEA-188690 -->
+ <maven.compiler.source>1.${java.version}</maven.compiler.source>
+ <maven.compiler.target>1.${java.version}</maven.compiler.target>
+ <apex.jorje.version>2017-11-17</apex.jorje.version>
+ </properties>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.codehaus.mojo</groupId>
+ <artifactId>build-helper-maven-plugin</artifactId>
+ <version>3.0.0</version>
+ <executions>
+ <execution>
+ <id>attach-apex-jorje</id>
+ <phase>package</phase>
+ <goals>
+ <goal>attach-artifact</goal>
+ </goals>
+ <configuration>
+ <artifacts>
+ <artifact>
+ <file>${basedir}/repo/apex/apex-jorje-lsp-minimized/${apex.jorje.version}/apex-jorje-lsp-minimized-${apex.jorje.version}.jar</file>
+ <type>jar</type>
+ <classifier>lib</classifier>
+ </artifact>
+ </artifacts>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ <dependencies>
+ <!-- transitive dependencies of apex-jorje -->
+ <dependency>
+ <groupId>cglib</groupId>
+ <artifactId>cglib</artifactId>
+ <version>3.2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>ch.qos.logback</groupId>
+ <artifactId>logback-classic</artifactId>
+ <version>1.1.7</version>
+ </dependency>
+ <dependency>
+ <groupId>ch.qos.logback</groupId>
+ <artifactId>logback-core</artifactId>
+ <version>1.1.7</version>
+ </dependency>
+ <dependency>
+ <groupId>com.google.code.findbugs</groupId>
+ <artifactId>jsr305</artifactId>
+ <version>3.0.1</version>
+ </dependency>
+ <dependency>
+ <groupId>com.google.code.gson</groupId>
+ <artifactId>gson</artifactId>
+ <version>2.7</version>
+ </dependency>
+ <dependency>
+ <groupId>com.google.guava</groupId>
+ <artifactId>guava</artifactId>
+ <version>22.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.antlr</groupId>
+ <artifactId>antlr-runtime</artifactId>
+ <version>3.5.2</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-lang3</artifactId>
+ <version>3.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.eclipse.xtend</groupId>
+ <artifactId>org.eclipse.xtend.lib</artifactId>
+ <version>2.10.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.eclipse.xtend</groupId>
+ <artifactId>org.eclipse.xtend.lib.macro</artifactId>
+ <version>2.10.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.eclipse.xtext</groupId>
+ <artifactId>org.eclipse.xtext.xbase.lib</artifactId>
+ <version>2.10.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.openjdk.jol</groupId>
+ <artifactId>jol-core</artifactId>
+ <version>0.4</version>
+ </dependency>
+ <dependency>
+ <groupId>org.slf4j</groupId>
+ <artifactId>slf4j-api</artifactId>
+ <version>1.7.20</version>
+ </dependency>
+ <dependency>
+ <groupId>org.yaml</groupId>
+ <artifactId>snakeyaml</artifactId>
+ <version>1.17</version>
+ </dependency>
+ <dependency>
+ <groupId>aopalliance</groupId>
+ <artifactId>aopalliance</artifactId>
+ <version>1.0</version>
+ </dependency>
+ <dependency>
+ <groupId>javax.inject</groupId>
+ <artifactId>javax.inject</artifactId>
+ <version>1</version>
+ </dependency>
+ <dependency>
+ <groupId>org.ow2.asm</groupId>
+ <artifactId>asm</artifactId>
+ <version>5.0.3</version>
+ <scope>runtime</scope>
+ </dependency>
+ </dependencies>
+</project>
diff --git a/pmd-apex-jorje/repo/README.md b/pmd-apex-jorje/repo/README.md
new file mode 100644
index 00000000000..1b3caee2c5a
--- /dev/null
+++ b/pmd-apex-jorje/repo/README.md
@@ -0,0 +1,17 @@
+# Local Maven Repo for the Apex Jorje Parser library
+
+You can download the needed libraries from:
+<https://github.com/forcedotcom/salesforcedx-vscode/tree/develop/packages/salesforcedx-vscode-apex/out>
+
+Apex Reference:
+<https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_reference.htm>
+
+<https://resources.docs.salesforce.com/sfdc/pdf/salesforce_apex_language_reference.pdf>
+
+In order to download the jar file, minimize it and add a the jar files to the local repo, use the following script:
+
+ ./create-local-repo.sh
+
+For the PMD 6.0.0 Release, the versions from
+<https://github.com/forcedotcom/salesforcedx-vscode/tree/54b127925eebfcfd14cd9988018438ba49ec3d43/packages/salesforcedx-vscode-apex/out>
+have been taken.
diff --git a/pmd-apex-jorje/repo/apex/apex-jorje-lsp-minimized/2017-11-17/apex-jorje-lsp-minimized-2017-11-17.jar b/pmd-apex-jorje/repo/apex/apex-jorje-lsp-minimized/2017-11-17/apex-jorje-lsp-minimized-2017-11-17.jar
new file mode 100644
index 00000000000..c764affbd1e
Binary files /dev/null and b/pmd-apex-jorje/repo/apex/apex-jorje-lsp-minimized/2017-11-17/apex-jorje-lsp-minimized-2017-11-17.jar differ
diff --git a/pmd-apex-jorje/repo/apex/apex-jorje-lsp-minimized/2017-11-17/apex-jorje-lsp-minimized-2017-11-17.pom b/pmd-apex-jorje/repo/apex/apex-jorje-lsp-minimized/2017-11-17/apex-jorje-lsp-minimized-2017-11-17.pom
new file mode 100644
index 00000000000..9a7ae9a0985
--- /dev/null
+++ b/pmd-apex-jorje/repo/apex/apex-jorje-lsp-minimized/2017-11-17/apex-jorje-lsp-minimized-2017-11-17.pom
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+ <modelVersion>4.0.0</modelVersion>
+ <groupId>apex</groupId>
+ <artifactId>apex-jorje-lsp-minimized</artifactId>
+ <version>2017-11-17</version>
+ <description>POM was created from install:install-file</description>
+</project>
diff --git a/pmd-apex-jorje/repo/apex/apex-jorje-lsp-minimized/maven-metadata-local.xml b/pmd-apex-jorje/repo/apex/apex-jorje-lsp-minimized/maven-metadata-local.xml
new file mode 100644
index 00000000000..cadab749b5b
--- /dev/null
+++ b/pmd-apex-jorje/repo/apex/apex-jorje-lsp-minimized/maven-metadata-local.xml
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<metadata>
+ <groupId>apex</groupId>
+ <artifactId>apex-jorje-lsp-minimized</artifactId>
+ <versioning>
+ <release>2017-11-17</release>
+ <versions>
+ <version>2017-11-17</version>
+ </versions>
+ <lastUpdated>20171204195258</lastUpdated>
+ </versioning>
+</metadata>
diff --git a/pmd-apex-jorje/repo/create-local-repo.sh b/pmd-apex-jorje/repo/create-local-repo.sh
new file mode 100755
index 00000000000..c2933453e32
--- /dev/null
+++ b/pmd-apex-jorje/repo/create-local-repo.sh
@@ -0,0 +1,52 @@
+#!/bin/bash
+
+URL=https://raw.githubusercontent.com/forcedotcom/salesforcedx-vscode/54b127925eebfcfd14cd9988018438ba49ec3d43/packages/salesforcedx-vscode-apex/out/apex-jorje-lsp.jar
+VERSION=2017-11-17
+FILENAME=apex-jorje-lsp-${VERSION}.jar
+FILENAME_MINIMIZED=apex-jorje-lsp-minimized-${VERSION}.jar
+
+
+function install() {
+ mvn install:install-file -Dfile=${FILENAME_MINIMIZED} \
+ -DgroupId=apex \
+ -DartifactId=apex-jorje-lsp-minimized \
+ -Dversion=${VERSION} \
+ -Dpackaging=jar \
+ -DlocalRepositoryPath=.
+}
+
+function download() {
+ curl -o $FILENAME $URL
+}
+
+
+function minimize() {
+ unzip -d temp ${FILENAME}
+ pushd temp
+ find . -not -path "." \
+ -and -not -path ".." \
+ -and -not -path "./apex*" \
+ -and -not -path "./StandardApex*" \
+ -and -not -path "./messages*" \
+ -and -not -path "./com" \
+ -and -not -path "./com/google" \
+ -and -not -path "./com/google/common*" \
+ -print0 | xargs -0 rm -rf
+ popd
+ jar --create --file ${FILENAME_MINIMIZED} -C temp/ .
+ rm -rf temp
+}
+
+function cleanup() {
+ rm ${FILENAME}
+ rm ${FILENAME_MINIMIZED}
+}
+
+
+download
+minimize
+install
+cleanup
+
+
+
diff --git a/pmd-apex/pom.xml b/pmd-apex/pom.xml
index 6d833d697bb..33fa5a9ee44 100644
--- a/pmd-apex/pom.xml
+++ b/pmd-apex/pom.xml
@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<artifactId>pmd-apex</artifactId>
<name>PMD Apex</name>
@@ -8,12 +7,14 @@
<parent>
<groupId>net.sourceforge.pmd</groupId>
<artifactId>pmd</artifactId>
- <version>6.0.0-SNAPSHOT</version>
+ <version>6.10.0-SNAPSHOT</version>
</parent>
<properties>
- <config.basedir>${basedir}/../pmd-core</config.basedir>
- <java.version>1.8</java.version>
+ <java.version>8</java.version>
+ <!-- Workaround for https://youtrack.jetbrains.com/issue/IDEA-188690 -->
+ <maven.compiler.source>1.${java.version}</maven.compiler.source>
+ <maven.compiler.target>1.${java.version}</maven.compiler.target>
</properties>
<build>
@@ -45,10 +46,8 @@
<target>
<echo>PMD specific tasks: cleaning generated markdown</echo>
<delete quiet="true">
- <fileset dir="${basedir}/src/site/markdown/rules/"
- includes="**/*.md" />
- <fileset dir="${basedir}/src/site/markdown/"
- includes="mergedruleset.xml" />
+ <fileset dir="${basedir}/src/site/markdown/rules/" includes="**/*.md" />
+ <fileset dir="${basedir}/src/site/markdown/" includes="mergedruleset.xml" />
<fileset dir="${basedir}/src/site/" includes="site.xml" />
</delete>
</target>
@@ -59,43 +58,6 @@
</execution>
</executions>
</plugin>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-shade-plugin</artifactId>
- <executions>
- <execution>
- <phase>package</phase>
- <goals>
- <goal>shade</goal>
- </goals>
- <configuration>
- <artifactSet>
- <includes>
- <include>apex</include>
- </includes>
- <excludes>
- <exclude>${project.groupId}</exclude>
- </excludes>
- </artifactSet>
- <relocations>
- <!-- apex uses an older version of asm, hence we need to shaded it away -->
- <relocation>
- <pattern>org.objectweb.asm</pattern>
- <shadedPattern>shaded.org.objectweb.asm</shadedPattern>
- </relocation>
- <!-- apex uses an older version of jackson, hence we need to shaded it away -->
- <relocation>
- <pattern>com.fasterxml.jackson</pattern>
- <shadedPattern>shaded.com.fasterxml.jackson</shadedPattern>
- </relocation>
- </relocations>
- <shadedArtifactAttached>true</shadedArtifactAttached>
- <shadedClassifierName>apex-jorje-shaded</shadedClassifierName>
- </configuration>
- </execution>
- </executions>
- </plugin>
</plugins>
</build>
<dependencies>
@@ -105,68 +67,43 @@
</dependency>
<dependency>
- <groupId>net.sourceforge.pmd</groupId>
- <artifactId>pmd-test</artifactId>
- <scope>test</scope>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>pmd-apex-jorje</artifactId>
+ <version>${project.version}</version>
+ <classifier>lib</classifier>
</dependency>
<dependency>
- <groupId>apex</groupId>
- <artifactId>apex-jorje-data</artifactId>
- <version>1.0-sfdc-224-SNAPSHOT-3083815933</version>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>pmd-apex-jorje</artifactId>
+ <version>${project.version}</version>
+ <type>pom</type>
</dependency>
<dependency>
- <groupId>apex</groupId>
- <artifactId>apex-jorje-ide</artifactId>
- <version>1.0-sfdc-224-SNAPSHOT-3083815933</version>
+ <groupId>commons-io</groupId>
+ <artifactId>commons-io</artifactId>
</dependency>
- <dependency>
- <groupId>apex</groupId>
- <artifactId>apex-jorje-parser</artifactId>
- <version>1.0-sfdc-224-SNAPSHOT-3083815933</version>
- </dependency>
<dependency>
- <groupId>apex</groupId>
- <artifactId>apex-jorje-semantic</artifactId>
- <version>1.0-sfdc-224-SNAPSHOT-3083815933</version>
+ <groupId>net.sourceforge.saxon</groupId>
+ <artifactId>saxon</artifactId>
</dependency>
- <dependency>
- <groupId>apex</groupId>
- <artifactId>apex-jorje-services</artifactId>
- <version>1.0-sfdc-224-SNAPSHOT-3083815933</version>
- </dependency>
-
- <dependency>
- <groupId>apex</groupId>
- <artifactId>apex-jorje-tools</artifactId>
- <version>1.0-sfdc-224-SNAPSHOT-3083815933</version>
- </dependency>
<dependency>
- <groupId>com.google.guava</groupId>
- <artifactId>guava</artifactId>
- <version>22.0</version>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <scope>test</scope>
</dependency>
-
<dependency>
- <groupId>org.antlr</groupId>
- <artifactId>antlr-runtime</artifactId>
- <version>3.5.2</version>
+ <groupId>net.sourceforge.pmd</groupId>
+ <artifactId>pmd-test</artifactId>
+ <scope>test</scope>
</dependency>
-
</dependencies>
- <repositories>
- <repository>
- <id>local-apex-repo</id>
- <url>file://${basedir}/repo</url>
- </repository>
- </repositories>
-
<profiles>
<profile>
<id>designer</id>
diff --git a/pmd-apex/repo/README.md b/pmd-apex/repo/README.md
deleted file mode 100644
index 6922be92467..00000000000
--- a/pmd-apex/repo/README.md
+++ /dev/null
@@ -1,56 +0,0 @@
-# Local Maven Repo for the Apex Jorje Parser library
-
-You can download the needed libraries from:
-<https://github.com/forcedotcom/idecore/tree/master/com.salesforce.ide.apex.core/lib>
-
-Apex Reference:
-<https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_reference.htm>
-
-In order to add a the jar files to the local repo, use the following commands:
-
- mvn install:install-file -Dfile=apex-jorje-data-1.0-sfdc-224-SNAPSHOT.jar \
- -DgroupId=apex \
- -DartifactId=apex-jorje-data \
- -Dversion=1.0-sfdc-224-SNAPSHOT \
- -Dpackaging=jar \
- -DlocalRepositoryPath=./repo
-
- mvn install:install-file -Dfile=apex-jorje-ide-1.0-sfdc-224-SNAPSHOT.jar \
- -DgroupId=apex \
- -DartifactId=apex-jorje-ide \
- -Dversion=1.0-sfdc-224-SNAPSHOT-3083815933 \
- -Dpackaging=jar \
- -DlocalRepositoryPath=./repo
-
- mvn install:install-file -Dfile=apex-jorje-parser-1.0-sfdc-224-SNAPSHOT.jar \
- -DgroupId=apex \
- -DartifactId=apex-jorje-parser \
- -Dversion=1.0-sfdc-224-SNAPSHOT-3083815933 \
- -Dpackaging=jar \
- -DlocalRepositoryPath=./repo
-
- mvn install:install-file -Dfile=apex-jorje-semantic-1.0-sfdc-224-SNAPSHOT.jar \
- -DgroupId=apex \
- -DartifactId=apex-jorje-semantic \
- -Dversion=1.0-sfdc-224-SNAPSHOT-3083815933 \
- -Dpackaging=jar \
- -DlocalRepositoryPath=./repo
-
- mvn install:install-file -Dfile=apex-jorje-services-1.0-sfdc-224-SNAPSHOT.jar \
- -DgroupId=apex \
- -DartifactId=apex-jorje-services \
- -Dversion=1.0-sfdc-224-SNAPSHOT-3083815933 \
- -Dpackaging=jar \
- -DlocalRepositoryPath=./repo
-
- mvn install:install-file -Dfile=apex-jorje-tools-1.0-sfdc-224-SNAPSHOT.jar \
- -DgroupId=apex \
- -DartifactId=apex-jorje-tools \
- -Dversion=1.0-sfdc-224-SNAPSHOT-3083815933 \
- -Dpackaging=jar \
- -DlocalRepositoryPath=./repo
-
-
-For the PMD 6.0.0 Release, the versions from
-<https://github.com/forcedotcom/idecore/tree/3083815933c2d015d03417986f57bd25786d58ce/com.salesforce.ide.apex.core/lib>
-have been taken.
diff --git a/pmd-apex/repo/apex/apex-jorje-data/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-data-1.0-sfdc-224-SNAPSHOT-3083815933.jar b/pmd-apex/repo/apex/apex-jorje-data/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-data-1.0-sfdc-224-SNAPSHOT-3083815933.jar
deleted file mode 100644
index 0dc242ad4a2..00000000000
Binary files a/pmd-apex/repo/apex/apex-jorje-data/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-data-1.0-sfdc-224-SNAPSHOT-3083815933.jar and /dev/null differ
diff --git a/pmd-apex/repo/apex/apex-jorje-data/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-data-1.0-sfdc-224-SNAPSHOT-3083815933.pom b/pmd-apex/repo/apex/apex-jorje-data/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-data-1.0-sfdc-224-SNAPSHOT-3083815933.pom
deleted file mode 100644
index 058d3840bc3..00000000000
--- a/pmd-apex/repo/apex/apex-jorje-data/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-data-1.0-sfdc-224-SNAPSHOT-3083815933.pom
+++ /dev/null
@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
- <modelVersion>4.0.0</modelVersion>
- <groupId>apex</groupId>
- <artifactId>apex-jorje-data</artifactId>
- <version>1.0-sfdc-224-SNAPSHOT-3083815933</version>
- <description>POM was created from install:install-file</description>
-</project>
diff --git a/pmd-apex/repo/apex/apex-jorje-data/maven-metadata-local.xml b/pmd-apex/repo/apex/apex-jorje-data/maven-metadata-local.xml
deleted file mode 100644
index 6422123f774..00000000000
--- a/pmd-apex/repo/apex/apex-jorje-data/maven-metadata-local.xml
+++ /dev/null
@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<metadata>
- <groupId>apex</groupId>
- <artifactId>apex-jorje-data</artifactId>
- <versioning>
- <release>1.0-sfdc-224-SNAPSHOT-3083815933</release>
- <versions>
- <version>1.0-sfdc-224-SNAPSHOT-3083815933</version>
- </versions>
- <lastUpdated>20170629193627</lastUpdated>
- </versioning>
-</metadata>
diff --git a/pmd-apex/repo/apex/apex-jorje-ide/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-ide-1.0-sfdc-224-SNAPSHOT-3083815933.jar b/pmd-apex/repo/apex/apex-jorje-ide/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-ide-1.0-sfdc-224-SNAPSHOT-3083815933.jar
deleted file mode 100644
index 49d659f7017..00000000000
Binary files a/pmd-apex/repo/apex/apex-jorje-ide/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-ide-1.0-sfdc-224-SNAPSHOT-3083815933.jar and /dev/null differ
diff --git a/pmd-apex/repo/apex/apex-jorje-ide/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-ide-1.0-sfdc-224-SNAPSHOT-3083815933.pom b/pmd-apex/repo/apex/apex-jorje-ide/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-ide-1.0-sfdc-224-SNAPSHOT-3083815933.pom
deleted file mode 100644
index 7de5f2f2b84..00000000000
--- a/pmd-apex/repo/apex/apex-jorje-ide/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-ide-1.0-sfdc-224-SNAPSHOT-3083815933.pom
+++ /dev/null
@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
- <modelVersion>4.0.0</modelVersion>
- <groupId>apex</groupId>
- <artifactId>apex-jorje-ide</artifactId>
- <version>1.0-sfdc-224-SNAPSHOT-3083815933</version>
- <description>POM was created from install:install-file</description>
-</project>
diff --git a/pmd-apex/repo/apex/apex-jorje-ide/maven-metadata-local.xml b/pmd-apex/repo/apex/apex-jorje-ide/maven-metadata-local.xml
deleted file mode 100644
index 190fe95a19c..00000000000
--- a/pmd-apex/repo/apex/apex-jorje-ide/maven-metadata-local.xml
+++ /dev/null
@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<metadata>
- <groupId>apex</groupId>
- <artifactId>apex-jorje-ide</artifactId>
- <versioning>
- <release>1.0-sfdc-224-SNAPSHOT-3083815933</release>
- <versions>
- <version>1.0-sfdc-224-SNAPSHOT-3083815933</version>
- </versions>
- <lastUpdated>20170629193403</lastUpdated>
- </versioning>
-</metadata>
diff --git a/pmd-apex/repo/apex/apex-jorje-parser/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-parser-1.0-sfdc-224-SNAPSHOT-3083815933.jar b/pmd-apex/repo/apex/apex-jorje-parser/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-parser-1.0-sfdc-224-SNAPSHOT-3083815933.jar
deleted file mode 100644
index 04f8c8daa4c..00000000000
Binary files a/pmd-apex/repo/apex/apex-jorje-parser/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-parser-1.0-sfdc-224-SNAPSHOT-3083815933.jar and /dev/null differ
diff --git a/pmd-apex/repo/apex/apex-jorje-parser/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-parser-1.0-sfdc-224-SNAPSHOT-3083815933.pom b/pmd-apex/repo/apex/apex-jorje-parser/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-parser-1.0-sfdc-224-SNAPSHOT-3083815933.pom
deleted file mode 100644
index 5556dfc70ee..00000000000
--- a/pmd-apex/repo/apex/apex-jorje-parser/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-parser-1.0-sfdc-224-SNAPSHOT-3083815933.pom
+++ /dev/null
@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
- <modelVersion>4.0.0</modelVersion>
- <groupId>apex</groupId>
- <artifactId>apex-jorje-parser</artifactId>
- <version>1.0-sfdc-224-SNAPSHOT-3083815933</version>
- <description>POM was created from install:install-file</description>
-</project>
diff --git a/pmd-apex/repo/apex/apex-jorje-parser/maven-metadata-local.xml b/pmd-apex/repo/apex/apex-jorje-parser/maven-metadata-local.xml
deleted file mode 100644
index 206bde25a30..00000000000
--- a/pmd-apex/repo/apex/apex-jorje-parser/maven-metadata-local.xml
+++ /dev/null
@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<metadata>
- <groupId>apex</groupId>
- <artifactId>apex-jorje-parser</artifactId>
- <versioning>
- <release>1.0-sfdc-224-SNAPSHOT-3083815933</release>
- <versions>
- <version>1.0-sfdc-224-SNAPSHOT-3083815933</version>
- </versions>
- <lastUpdated>20170629193645</lastUpdated>
- </versioning>
-</metadata>
diff --git a/pmd-apex/repo/apex/apex-jorje-semantic/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-semantic-1.0-sfdc-224-SNAPSHOT-3083815933.jar b/pmd-apex/repo/apex/apex-jorje-semantic/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-semantic-1.0-sfdc-224-SNAPSHOT-3083815933.jar
deleted file mode 100644
index 9c047a30f3c..00000000000
Binary files a/pmd-apex/repo/apex/apex-jorje-semantic/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-semantic-1.0-sfdc-224-SNAPSHOT-3083815933.jar and /dev/null differ
diff --git a/pmd-apex/repo/apex/apex-jorje-semantic/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-semantic-1.0-sfdc-224-SNAPSHOT-3083815933.pom b/pmd-apex/repo/apex/apex-jorje-semantic/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-semantic-1.0-sfdc-224-SNAPSHOT-3083815933.pom
deleted file mode 100644
index 042bbb58cb1..00000000000
--- a/pmd-apex/repo/apex/apex-jorje-semantic/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-semantic-1.0-sfdc-224-SNAPSHOT-3083815933.pom
+++ /dev/null
@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
- <modelVersion>4.0.0</modelVersion>
- <groupId>apex</groupId>
- <artifactId>apex-jorje-semantic</artifactId>
- <version>1.0-sfdc-224-SNAPSHOT-3083815933</version>
- <description>POM was created from install:install-file</description>
-</project>
diff --git a/pmd-apex/repo/apex/apex-jorje-semantic/maven-metadata-local.xml b/pmd-apex/repo/apex/apex-jorje-semantic/maven-metadata-local.xml
deleted file mode 100644
index 512c049b0e3..00000000000
--- a/pmd-apex/repo/apex/apex-jorje-semantic/maven-metadata-local.xml
+++ /dev/null
@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<metadata>
- <groupId>apex</groupId>
- <artifactId>apex-jorje-semantic</artifactId>
- <versioning>
- <release>1.0-sfdc-224-SNAPSHOT-3083815933</release>
- <versions>
- <version>1.0-sfdc-224-SNAPSHOT-3083815933</version>
- </versions>
- <lastUpdated>20170629193659</lastUpdated>
- </versioning>
-</metadata>
diff --git a/pmd-apex/repo/apex/apex-jorje-services/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-services-1.0-sfdc-224-SNAPSHOT-3083815933.jar b/pmd-apex/repo/apex/apex-jorje-services/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-services-1.0-sfdc-224-SNAPSHOT-3083815933.jar
deleted file mode 100644
index a4b83d818b0..00000000000
Binary files a/pmd-apex/repo/apex/apex-jorje-services/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-services-1.0-sfdc-224-SNAPSHOT-3083815933.jar and /dev/null differ
diff --git a/pmd-apex/repo/apex/apex-jorje-services/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-services-1.0-sfdc-224-SNAPSHOT-3083815933.pom b/pmd-apex/repo/apex/apex-jorje-services/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-services-1.0-sfdc-224-SNAPSHOT-3083815933.pom
deleted file mode 100644
index 4f67f8b8b7d..00000000000
--- a/pmd-apex/repo/apex/apex-jorje-services/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-services-1.0-sfdc-224-SNAPSHOT-3083815933.pom
+++ /dev/null
@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
- <modelVersion>4.0.0</modelVersion>
- <groupId>apex</groupId>
- <artifactId>apex-jorje-services</artifactId>
- <version>1.0-sfdc-224-SNAPSHOT-3083815933</version>
- <description>POM was created from install:install-file</description>
-</project>
diff --git a/pmd-apex/repo/apex/apex-jorje-services/maven-metadata-local.xml b/pmd-apex/repo/apex/apex-jorje-services/maven-metadata-local.xml
deleted file mode 100644
index a8bc5aea710..00000000000
--- a/pmd-apex/repo/apex/apex-jorje-services/maven-metadata-local.xml
+++ /dev/null
@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<metadata>
- <groupId>apex</groupId>
- <artifactId>apex-jorje-services</artifactId>
- <versioning>
- <release>1.0-sfdc-224-SNAPSHOT-3083815933</release>
- <versions>
- <version>1.0-sfdc-224-SNAPSHOT-3083815933</version>
- </versions>
- <lastUpdated>20170629193717</lastUpdated>
- </versioning>
-</metadata>
diff --git a/pmd-apex/repo/apex/apex-jorje-tools/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-tools-1.0-sfdc-224-SNAPSHOT-3083815933.jar b/pmd-apex/repo/apex/apex-jorje-tools/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-tools-1.0-sfdc-224-SNAPSHOT-3083815933.jar
deleted file mode 100644
index 3f858966c15..00000000000
Binary files a/pmd-apex/repo/apex/apex-jorje-tools/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-tools-1.0-sfdc-224-SNAPSHOT-3083815933.jar and /dev/null differ
diff --git a/pmd-apex/repo/apex/apex-jorje-tools/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-tools-1.0-sfdc-224-SNAPSHOT-3083815933.pom b/pmd-apex/repo/apex/apex-jorje-tools/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-tools-1.0-sfdc-224-SNAPSHOT-3083815933.pom
deleted file mode 100644
index 3830873343a..00000000000
--- a/pmd-apex/repo/apex/apex-jorje-tools/1.0-sfdc-224-SNAPSHOT-3083815933/apex-jorje-tools-1.0-sfdc-224-SNAPSHOT-3083815933.pom
+++ /dev/null
@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
- <modelVersion>4.0.0</modelVersion>
- <groupId>apex</groupId>
- <artifactId>apex-jorje-tools</artifactId>
- <version>1.0-sfdc-224-SNAPSHOT-3083815933</version>
- <description>POM was created from install:install-file</description>
-</project>
diff --git a/pmd-apex/repo/apex/apex-jorje-tools/maven-metadata-local.xml b/pmd-apex/repo/apex/apex-jorje-tools/maven-metadata-local.xml
deleted file mode 100644
index 0c2c47f514e..00000000000
--- a/pmd-apex/repo/apex/apex-jorje-tools/maven-metadata-local.xml
+++ /dev/null
@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<metadata>
- <groupId>apex</groupId>
- <artifactId>apex-jorje-tools</artifactId>
- <versioning>
- <release>1.0-sfdc-224-SNAPSHOT-3083815933</release>
- <versions>
- <version>1.0-sfdc-224-SNAPSHOT-3083815933</version>
- </versions>
- <lastUpdated>20170629193730</lastUpdated>
- </versioning>
-</metadata>
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/cpd/ApexLanguage.java b/pmd-apex/src/main/java/net/sourceforge/pmd/cpd/ApexLanguage.java
index ef6f6ce7902..0bb7bd70148 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/cpd/ApexLanguage.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/cpd/ApexLanguage.java
@@ -17,6 +17,7 @@ public ApexLanguage(Properties properties) {
setProperties(properties);
}
+ @Override
public final void setProperties(Properties properties) {
ApexTokenizer tokenizer = (ApexTokenizer) getTokenizer();
tokenizer.setProperties(properties);
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/cpd/ApexTokenizer.java b/pmd-apex/src/main/java/net/sourceforge/pmd/cpd/ApexTokenizer.java
index f83cb65cfad..c872489c025 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/cpd/ApexTokenizer.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/cpd/ApexTokenizer.java
@@ -40,6 +40,7 @@ public void tokenize(SourceCode sourceCode, Tokens tokenEntries) {
ANTLRStringStream ass = new ANTLRStringStream(code.toString());
ApexLexer lexer = new ApexLexer(ass) {
+ @Override
public void emitErrorMessage(String msg) {
throw new TokenMgrError(msg, TokenMgrError.LEXICAL_ERROR);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ApexHandler.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ApexHandler.java
index 92dd3d03032..6984ff1a36a 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ApexHandler.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ApexHandler.java
@@ -13,27 +13,25 @@
import net.sourceforge.pmd.lang.XPathHandler;
import net.sourceforge.pmd.lang.apex.ast.ApexNode;
import net.sourceforge.pmd.lang.apex.ast.DumpFacade;
-import net.sourceforge.pmd.lang.apex.metrics.ApexMetricsVisitorFacade;
+import net.sourceforge.pmd.lang.apex.multifile.ApexMultifileVisitorFacade;
import net.sourceforge.pmd.lang.apex.rule.ApexRuleViolationFactory;
-import net.sourceforge.pmd.lang.ast.Node;
-import net.sourceforge.pmd.lang.ast.xpath.AbstractASTXPathHandler;
+import net.sourceforge.pmd.lang.ast.xpath.DefaultASTXPathHandler;
import net.sourceforge.pmd.lang.rule.RuleViolationFactory;
-import net.sf.saxon.sxpath.IndependentContext;
-
public class ApexHandler extends AbstractLanguageVersionHandler {
@Override
- public XPathHandler getXPathHandler() {
- return new AbstractASTXPathHandler() {
- public void initialize() {
- }
+ public VisitorStarter getMultifileFacade() {
+ return rootNode -> new ApexMultifileVisitorFacade().initializeWith((ApexNode<?>) rootNode);
+ }
- public void initialize(IndependentContext context) {
- }
- };
+
+ @Override
+ public XPathHandler getXPathHandler() {
+ return new DefaultASTXPathHandler();
}
+ @Override
public RuleViolationFactory getRuleViolationFactory() {
return ApexRuleViolationFactory.INSTANCE;
}
@@ -43,26 +41,14 @@ public ParserOptions getDefaultParserOptions() {
return new ApexParserOptions();
}
+ @Override
public Parser getParser(ParserOptions parserOptions) {
return new ApexParser(parserOptions);
}
@Override
public VisitorStarter getDumpFacade(Writer writer, String prefix, boolean recurse) {
- return new VisitorStarter() {
- public void start(Node rootNode) {
- new DumpFacade().initializeWith(writer, prefix, recurse, (ApexNode<?>) rootNode);
- }
- };
+ return rootNode -> new DumpFacade().initializeWith(writer, prefix, recurse, (ApexNode<?>) rootNode);
}
- @Override
- public VisitorStarter getMetricsVisitorFacade() {
- return new VisitorStarter() {
- @Override
- public void start(Node rootNode) {
- new ApexMetricsVisitorFacade().initializeWith((ApexNode<?>) rootNode);
- }
- };
- }
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ApexParser.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ApexParser.java
index 63e0d529a74..f18cb518f49 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ApexParser.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ApexParser.java
@@ -29,14 +29,17 @@ public TokenManager createTokenManager(Reader source) {
return null;
}
+ @Override
public boolean canParse() {
return true;
}
+ @Override
public Node parse(String fileName, Reader source) throws ParseException {
return apexParser.parse(source);
}
+ @Override
public Map<Integer, String> getSuppressMap() {
return apexParser.getSuppressMap();
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ApexParserOptions.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ApexParserOptions.java
index 7f81184afac..a660af6eef7 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ApexParserOptions.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ApexParserOptions.java
@@ -5,29 +5,10 @@
package net.sourceforge.pmd.lang.apex;
import net.sourceforge.pmd.lang.ParserOptions;
-import net.sourceforge.pmd.util.StringUtil;
public class ApexParserOptions extends ParserOptions {
- @Override
- public int hashCode() {
- final int prime = 31;
- int result = super.hashCode();
- result = prime * result + (1237);
- result = prime * result + (1237);
- result = prime * result;
- return result;
- }
+ // empty class for now, since we don't have extra options for Apex
+ // Once you add something here, make sure to override hashCode and equals
- @Override
- public boolean equals(Object obj) {
- if (this == obj) {
- return true;
- }
- if (obj == null || getClass() != obj.getClass()) {
- return false;
- }
- final ApexParserOptions that = (ApexParserOptions) obj;
- return StringUtil.isSame(this.suppressMarker, that.suppressMarker, false, false, false);
- }
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTAnnotation.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTAnnotation.java
index fc049c2afd4..1ba073df4bc 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTAnnotation.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTAnnotation.java
@@ -4,6 +4,12 @@
package net.sourceforge.pmd.lang.apex.ast;
+import java.util.Arrays;
+import java.util.Set;
+import java.util.TreeSet;
+
+import net.sourceforge.pmd.Rule;
+
import apex.jorje.semantic.ast.modifier.Annotation;
public class ASTAnnotation extends AbstractApexNode<Annotation> {
@@ -12,7 +18,33 @@ public ASTAnnotation(Annotation annotation) {
super(annotation);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
+
+ @Override
+ public String getImage() {
+ return node.getType().getApexName();
+ }
+
+ public boolean suppresses(Rule rule) {
+ final String ruleAnno = "PMD." + rule.getName();
+
+ if (hasImageEqualTo("SuppressWarnings")) {
+ for (ASTAnnotationParameter param : findChildrenOfType(ASTAnnotationParameter.class)) {
+ String image = param.getImage();
+
+ if (image != null) {
+ Set<String> paramValues = new TreeSet<String>(String.CASE_INSENSITIVE_ORDER);
+ paramValues.addAll(Arrays.asList(image.replaceAll("\\s+", "").split(",")));
+ if (paramValues.contains("PMD") || paramValues.contains(ruleAnno) || paramValues.contains("all")) {
+ return true;
+ }
+ }
+ }
+ }
+
+ return false;
+ }
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTAnnotationParameter.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTAnnotationParameter.java
index c60f1f6b4fb..be17773e78c 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTAnnotationParameter.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTAnnotationParameter.java
@@ -12,7 +12,16 @@ public ASTAnnotationParameter(AnnotationParameter annotationParameter) {
super(annotationParameter);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
+
+ @Override
+ public String getImage() {
+ if (node.getValue() != null) {
+ return node.getValueAsString();
+ }
+ return null;
+ }
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTAnonymousClass.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTAnonymousClass.java
index f75ed7e14ae..4f63c004b14 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTAnonymousClass.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTAnonymousClass.java
@@ -12,6 +12,7 @@ public ASTAnonymousClass(AnonymousClass anonymousClass) {
super(anonymousClass);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTArrayLoadExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTArrayLoadExpression.java
index ad6686daa83..d5f938bb6ef 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTArrayLoadExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTArrayLoadExpression.java
@@ -12,6 +12,7 @@ public ASTArrayLoadExpression(ArrayLoadExpression arrayLoadExpression) {
super(arrayLoadExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTArrayStoreExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTArrayStoreExpression.java
index c35a7adc4cc..0585b121f2f 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTArrayStoreExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTArrayStoreExpression.java
@@ -12,6 +12,7 @@ public ASTArrayStoreExpression(ArrayStoreExpression arrayStoreExpression) {
super(arrayStoreExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTAssignmentExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTAssignmentExpression.java
index 7d6d2bc00f0..29f466692ba 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTAssignmentExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTAssignmentExpression.java
@@ -12,6 +12,7 @@ public ASTAssignmentExpression(AssignmentExpression assignmentExpression) {
super(assignmentExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTBinaryExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTBinaryExpression.java
index 577140ef483..3d7e85027f1 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTBinaryExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTBinaryExpression.java
@@ -12,6 +12,7 @@ public ASTBinaryExpression(BinaryExpression binaryExpression) {
super(binaryExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTBindExpressions.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTBindExpressions.java
index 3357b3409d9..7501f3ab8f2 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTBindExpressions.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTBindExpressions.java
@@ -12,6 +12,7 @@ public ASTBindExpressions(BindExpressions bindExpressions) {
super(bindExpressions);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTBlockStatement.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTBlockStatement.java
index 522d9489c48..ab16315554c 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTBlockStatement.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTBlockStatement.java
@@ -13,6 +13,7 @@ public ASTBlockStatement(BlockStatement blockStatement) {
super(blockStatement);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
@@ -30,7 +31,7 @@ protected void handleSourceCode(final String source) {
// check, whether the this block statement really begins with a curly brace
// unfortunately, for-loop and if-statements always contain a block statement,
// regardless whether curly braces where present or not.
- char firstChar = source.charAt(node.getLoc().startIndex);
+ char firstChar = source.charAt(node.getLoc().getStartIndex());
curlyBrace = firstChar == '{';
}
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTBooleanExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTBooleanExpression.java
index b60935098bc..f2e44dbc4aa 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTBooleanExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTBooleanExpression.java
@@ -12,6 +12,7 @@ public ASTBooleanExpression(BooleanExpression booleanExpression) {
super(booleanExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTBreakStatement.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTBreakStatement.java
index 66f38758da7..90b947d51b6 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTBreakStatement.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTBreakStatement.java
@@ -12,6 +12,7 @@ public ASTBreakStatement(BreakStatement breakStatement) {
super(breakStatement);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTBridgeMethodCreator.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTBridgeMethodCreator.java
index 32f5d80641b..29be1c20c01 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTBridgeMethodCreator.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTBridgeMethodCreator.java
@@ -12,6 +12,7 @@ public ASTBridgeMethodCreator(BridgeMethodCreator bridgeMethodCreator) {
super(bridgeMethodCreator);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTCastExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTCastExpression.java
index 74f52d243bc..1a534a6eaca 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTCastExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTCastExpression.java
@@ -12,6 +12,7 @@ public ASTCastExpression(CastExpression node) {
super(node);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTCatchBlockStatement.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTCatchBlockStatement.java
index c00239bc0a3..14f4929dee2 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTCatchBlockStatement.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTCatchBlockStatement.java
@@ -12,6 +12,7 @@ public ASTCatchBlockStatement(CatchBlockStatement catchBlockStatement) {
super(catchBlockStatement);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTClassRefExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTClassRefExpression.java
index bc0669637ee..92f4c5a51b4 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTClassRefExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTClassRefExpression.java
@@ -12,6 +12,7 @@ public ASTClassRefExpression(ClassRefExpression classRefExpression) {
super(classRefExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTConstructorPreamble.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTConstructorPreamble.java
index 41163d83845..3f532db8d6c 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTConstructorPreamble.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTConstructorPreamble.java
@@ -12,6 +12,7 @@ public ASTConstructorPreamble(ConstructorPreamble node) {
super(node);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTConstructorPreambleStatement.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTConstructorPreambleStatement.java
index 89e9ec8d666..e8613c28443 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTConstructorPreambleStatement.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTConstructorPreambleStatement.java
@@ -12,6 +12,7 @@ public ASTConstructorPreambleStatement(ConstructorPreambleStatement constructorP
super(constructorPreambleStatement);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTContinueStatement.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTContinueStatement.java
index 36138e8412f..9a5a80aeab2 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTContinueStatement.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTContinueStatement.java
@@ -12,6 +12,7 @@ public ASTContinueStatement(ContinueStatement continueStatement) {
super(continueStatement);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDmlDeleteStatement.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDmlDeleteStatement.java
index 3ff1a195a7d..d876498594d 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDmlDeleteStatement.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDmlDeleteStatement.java
@@ -12,6 +12,7 @@ public ASTDmlDeleteStatement(DmlDeleteStatement dmlDeleteStatement) {
super(dmlDeleteStatement);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDmlInsertStatement.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDmlInsertStatement.java
index 2589985cb26..2b818a94f42 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDmlInsertStatement.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDmlInsertStatement.java
@@ -12,6 +12,7 @@ public ASTDmlInsertStatement(DmlInsertStatement dmlInsertStatement) {
super(dmlInsertStatement);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDmlMergeStatement.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDmlMergeStatement.java
index 41de98a930e..7e1bebb4335 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDmlMergeStatement.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDmlMergeStatement.java
@@ -12,6 +12,7 @@ public ASTDmlMergeStatement(DmlMergeStatement dmlMergeStatement) {
super(dmlMergeStatement);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDmlUndeleteStatement.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDmlUndeleteStatement.java
index 94396689e1b..6e91324bd70 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDmlUndeleteStatement.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDmlUndeleteStatement.java
@@ -12,6 +12,7 @@ public ASTDmlUndeleteStatement(DmlUndeleteStatement dmlUndeleteStatement) {
super(dmlUndeleteStatement);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDmlUpdateStatement.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDmlUpdateStatement.java
index 9f6b11bf1d3..587a5365429 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDmlUpdateStatement.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDmlUpdateStatement.java
@@ -12,6 +12,7 @@ public ASTDmlUpdateStatement(DmlUpdateStatement dmlUpdateStatement) {
super(dmlUpdateStatement);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDmlUpsertStatement.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDmlUpsertStatement.java
index 4496376d8c0..8f7512ec31e 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDmlUpsertStatement.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDmlUpsertStatement.java
@@ -12,6 +12,7 @@ public ASTDmlUpsertStatement(DmlUpsertStatement dmlUpsertStatement) {
super(dmlUpsertStatement);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDoLoopStatement.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDoLoopStatement.java
index a6cdc9aeb81..6ac37c8bbe0 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDoLoopStatement.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTDoLoopStatement.java
@@ -12,6 +12,7 @@ public ASTDoLoopStatement(DoLoopStatement doLoopStatement) {
super(doLoopStatement);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTExpression.java
index 8914bcdf142..690ae31f5a8 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTExpression.java
@@ -12,6 +12,7 @@ public ASTExpression(Expression expression) {
super(expression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTExpressionStatement.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTExpressionStatement.java
index ceb6f59c408..b23a76b050a 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTExpressionStatement.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTExpressionStatement.java
@@ -12,7 +12,31 @@ public ASTExpressionStatement(ExpressionStatement expressionStatement) {
super(expressionStatement);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
+
+ private int beginColumnDiff = -1;
+
+ @Override
+ public int getBeginColumn() {
+ if (beginColumnDiff > -1) {
+ return super.getBeginColumn() - beginColumnDiff;
+ }
+
+ if (jjtGetNumChildren() > 0 && jjtGetChild(0) instanceof ASTMethodCallExpression) {
+ ASTMethodCallExpression methodCallExpression = (ASTMethodCallExpression) jjtGetChild(0);
+
+ int fullLength = methodCallExpression.getFullMethodName().length();
+ int nameLength = methodCallExpression.getMethodName().length();
+ if (fullLength > nameLength) {
+ beginColumnDiff = fullLength - nameLength;
+ } else {
+ beginColumnDiff = 0;
+ }
+ }
+
+ return super.getBeginColumn() - beginColumnDiff;
+ }
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTField.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTField.java
index 96812c19128..e362a6d3af2 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTField.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTField.java
@@ -4,14 +4,17 @@
package net.sourceforge.pmd.lang.apex.ast;
+import net.sourceforge.pmd.Rule;
+
import apex.jorje.semantic.ast.member.Field;
-public class ASTField extends AbstractApexNode<Field> {
+public class ASTField extends AbstractApexNode<Field> implements CanSuppressWarnings {
public ASTField(Field field) {
super(field);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
@@ -20,4 +23,16 @@ public Object jjtAccept(ApexParserVisitor visitor, Object data) {
public String getImage() {
return node.getFieldInfo().getName();
}
+
+ @Override
+ public boolean hasSuppressWarningsAnnotationFor(Rule rule) {
+ for (ASTModifierNode modifier : findChildrenOfType(ASTModifierNode.class)) {
+ for (ASTAnnotation a : modifier.findChildrenOfType(ASTAnnotation.class)) {
+ if (a.suppresses(rule)) {
+ return true;
+ }
+ }
+ }
+ return false;
+ }
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTFieldDeclaration.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTFieldDeclaration.java
index 298e337dc09..9b84e465128 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTFieldDeclaration.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTFieldDeclaration.java
@@ -12,6 +12,7 @@ public ASTFieldDeclaration(FieldDeclaration fieldDeclaration) {
super(fieldDeclaration);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTFieldDeclarationStatements.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTFieldDeclarationStatements.java
index f9c8fe5242d..56ff04c40a4 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTFieldDeclarationStatements.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTFieldDeclarationStatements.java
@@ -4,15 +4,31 @@
package net.sourceforge.pmd.lang.apex.ast;
+import net.sourceforge.pmd.Rule;
+
import apex.jorje.semantic.ast.statement.FieldDeclarationStatements;
-public class ASTFieldDeclarationStatements extends AbstractApexNode<FieldDeclarationStatements> {
+public class ASTFieldDeclarationStatements extends AbstractApexNode<FieldDeclarationStatements>
+ implements CanSuppressWarnings {
public ASTFieldDeclarationStatements(FieldDeclarationStatements fieldDeclarationStatements) {
super(fieldDeclarationStatements);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
+
+ @Override
+ public boolean hasSuppressWarningsAnnotationFor(Rule rule) {
+ for (ASTModifierNode modifier : findChildrenOfType(ASTModifierNode.class)) {
+ for (ASTAnnotation a : modifier.findChildrenOfType(ASTAnnotation.class)) {
+ if (a.suppresses(rule)) {
+ return true;
+ }
+ }
+ }
+ return false;
+ }
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTForEachStatement.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTForEachStatement.java
index 839b9b84273..5036d368dbf 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTForEachStatement.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTForEachStatement.java
@@ -4,7 +4,7 @@
package net.sourceforge.pmd.lang.apex.ast;
-import apex.jorje.semantic.ast.statement.ForEachStatement;
+import apex.jorje.semantic.ast.statement.foreachstatement.ForEachStatement;
public class ASTForEachStatement extends AbstractApexNode<ForEachStatement> {
@@ -12,6 +12,7 @@ public ASTForEachStatement(ForEachStatement forEachStatement) {
super(forEachStatement);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTForLoopStatement.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTForLoopStatement.java
index 8f9ed065125..8fb8b9610fa 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTForLoopStatement.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTForLoopStatement.java
@@ -12,6 +12,7 @@ public ASTForLoopStatement(ForLoopStatement forLoopStatement) {
super(forLoopStatement);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTFormalComment.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTFormalComment.java
new file mode 100644
index 00000000000..a59df839e13
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTFormalComment.java
@@ -0,0 +1,23 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.ast;
+
+public class ASTFormalComment extends AbstractApexNodeBase {
+ private String token;
+
+ public ASTFormalComment(String token) {
+ super(ASTFormalComment.class);
+ this.token = token;
+ }
+
+ @Override
+ public Object jjtAccept(ApexParserVisitor visitor, Object data) {
+ return visitor.visit(this, data);
+ }
+
+ public String getToken() {
+ return token;
+ }
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTIfBlockStatement.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTIfBlockStatement.java
index 2198f303294..e2f633e6d26 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTIfBlockStatement.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTIfBlockStatement.java
@@ -12,6 +12,7 @@ public ASTIfBlockStatement(IfBlockStatement ifBlockStatement) {
super(ifBlockStatement);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTIfElseBlockStatement.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTIfElseBlockStatement.java
index 88a4143c9cd..92571c5cad3 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTIfElseBlockStatement.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTIfElseBlockStatement.java
@@ -12,6 +12,7 @@ public ASTIfElseBlockStatement(IfElseBlockStatement ifElseBlockStatement) {
super(ifElseBlockStatement);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTIllegalStoreExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTIllegalStoreExpression.java
index be7d283a1ca..29f70170373 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTIllegalStoreExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTIllegalStoreExpression.java
@@ -12,6 +12,7 @@ public ASTIllegalStoreExpression(IllegalStoreExpression node) {
super(node);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTInstanceOfExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTInstanceOfExpression.java
index 4ddf7411334..f1e94593cdc 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTInstanceOfExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTInstanceOfExpression.java
@@ -12,6 +12,7 @@ public ASTInstanceOfExpression(InstanceOfExpression instanceOfExpression) {
super(instanceOfExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTJavaMethodCallExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTJavaMethodCallExpression.java
index 679ec6eb079..ba8c2b56f0a 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTJavaMethodCallExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTJavaMethodCallExpression.java
@@ -12,6 +12,7 @@ public ASTJavaMethodCallExpression(JavaMethodCallExpression javaMethodCallExpres
super(javaMethodCallExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTJavaVariableExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTJavaVariableExpression.java
index 84f91da4f11..78c3f14e2d8 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTJavaVariableExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTJavaVariableExpression.java
@@ -12,6 +12,7 @@ public ASTJavaVariableExpression(JavaVariableExpression javaVariableExpression)
super(javaVariableExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTLiteralExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTLiteralExpression.java
index 7d19485275d..19e7440fac9 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTLiteralExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTLiteralExpression.java
@@ -12,6 +12,7 @@ public ASTLiteralExpression(LiteralExpression literalExpression) {
super(literalExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTMapEntryNode.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTMapEntryNode.java
index 1f29b0b3aaf..e5518792af2 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTMapEntryNode.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTMapEntryNode.java
@@ -12,6 +12,7 @@ public ASTMapEntryNode(MapEntryNode mapEntryNode) {
super(mapEntryNode);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTMethod.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTMethod.java
index 50019156644..6aa19802613 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTMethod.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTMethod.java
@@ -4,24 +4,27 @@
package net.sourceforge.pmd.lang.apex.ast;
+import net.sourceforge.pmd.Rule;
import net.sourceforge.pmd.lang.apex.metrics.signature.ApexOperationSignature;
import net.sourceforge.pmd.lang.ast.SignedNode;
import apex.jorje.semantic.ast.member.Method;
-public class ASTMethod extends AbstractApexNode<Method> implements ApexQualifiableNode, SignedNode<ASTMethod> {
+public class ASTMethod extends AbstractApexNode<Method> implements ApexQualifiableNode,
+ SignedNode<ASTMethod>, CanSuppressWarnings {
public ASTMethod(Method method) {
super(method);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
@Override
public String getImage() {
- return node.getMethodInfo().getIdentifier().value;
+ return node.getMethodInfo().getCanonicalName();
}
@Override
@@ -44,7 +47,6 @@ public int getEndColumn() {
return super.getEndColumn();
}
-
@Override
public ApexQualifiedName getQualifiedName() {
return ApexQualifiedName.ofMethod(this);
@@ -55,4 +57,16 @@ public ApexQualifiedName getQualifiedName() {
public ApexOperationSignature getSignature() {
return ApexOperationSignature.of(this);
}
+
+ @Override
+ public boolean hasSuppressWarningsAnnotationFor(Rule rule) {
+ for (ASTModifierNode modifier : findChildrenOfType(ASTModifierNode.class)) {
+ for (ASTAnnotation a : modifier.findChildrenOfType(ASTAnnotation.class)) {
+ if (a.suppresses(rule)) {
+ return true;
+ }
+ }
+ }
+ return false;
+ }
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTMethodBlockStatement.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTMethodBlockStatement.java
index 0890667eba9..98459d46343 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTMethodBlockStatement.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTMethodBlockStatement.java
@@ -12,6 +12,7 @@ public ASTMethodBlockStatement(MethodBlockStatement node) {
super(node);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTMethodCallExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTMethodCallExpression.java
index 77f485a5768..b15ccfd1ec1 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTMethodCallExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTMethodCallExpression.java
@@ -4,6 +4,9 @@
package net.sourceforge.pmd.lang.apex.ast;
+import java.util.Iterator;
+
+import apex.jorje.data.Identifier;
import apex.jorje.semantic.ast.expression.MethodCallExpression;
public class ASTMethodCallExpression extends AbstractApexNode<MethodCallExpression> {
@@ -12,6 +15,7 @@ public ASTMethodCallExpression(MethodCallExpression methodCallExpression) {
super(methodCallExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
@@ -22,10 +26,10 @@ public String getMethodName() {
public String getFullMethodName() {
final String methodName = getMethodName();
- String typeName = "";
- if (!getNode().getReferenceExpression().getJadtIdentifiers().isEmpty()) {
- typeName = getNode().getReferenceExpression().getJadtIdentifiers().get(0).value + ".";
+ StringBuilder typeName = new StringBuilder();
+ for (Iterator<Identifier> it = getNode().getReferenceContext().getNames().iterator(); it.hasNext();) {
+ typeName.append(it.next().getValue()).append('.');
}
- return typeName + methodName;
+ return typeName.toString() + methodName;
}
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTModifier.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTModifier.java
index 58a788c4461..bed065951a4 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTModifier.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTModifier.java
@@ -12,6 +12,7 @@ public ASTModifier(Modifier node) {
super(node);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTModifierNode.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTModifierNode.java
index 1dee4943de6..811cd33f66d 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTModifierNode.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTModifierNode.java
@@ -12,6 +12,7 @@ public ASTModifierNode(ModifierNode modifierNode) {
super(modifierNode);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTModifierOrAnnotation.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTModifierOrAnnotation.java
index c374dec55b7..56e200334d5 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTModifierOrAnnotation.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTModifierOrAnnotation.java
@@ -12,6 +12,7 @@ public ASTModifierOrAnnotation(ModifierOrAnnotation modifierOrAnnotation) {
super(modifierOrAnnotation);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTMultiStatement.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTMultiStatement.java
index b4632dcc525..2b5f7e1d0e6 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTMultiStatement.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTMultiStatement.java
@@ -12,6 +12,7 @@ public ASTMultiStatement(MultiStatement node) {
super(node);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNestedExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNestedExpression.java
index 2d07059de20..90428807028 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNestedExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNestedExpression.java
@@ -12,6 +12,7 @@ public ASTNestedExpression(NestedExpression node) {
super(node);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNestedStoreExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNestedStoreExpression.java
index acdaab383bb..22fc1c9f968 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNestedStoreExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNestedStoreExpression.java
@@ -12,6 +12,7 @@ public ASTNestedStoreExpression(NestedStoreExpression node) {
super(node);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewKeyValueObjectExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewKeyValueObjectExpression.java
index 6b7c51295dc..60269d4510b 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewKeyValueObjectExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewKeyValueObjectExpression.java
@@ -12,6 +12,7 @@ public ASTNewKeyValueObjectExpression(NewKeyValueObjectExpression node) {
super(node);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewListInitExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewListInitExpression.java
index d8e63732d23..7ee5f8ef5bc 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewListInitExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewListInitExpression.java
@@ -12,6 +12,7 @@ public ASTNewListInitExpression(NewListInitExpression newListInitExpression) {
super(newListInitExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewListLiteralExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewListLiteralExpression.java
index f54dbf4adb0..35d2f73e81b 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewListLiteralExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewListLiteralExpression.java
@@ -12,6 +12,7 @@ public ASTNewListLiteralExpression(NewListLiteralExpression newListLiteralExpres
super(newListLiteralExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewMapInitExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewMapInitExpression.java
index b97080fc8f7..3b3e7eaca14 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewMapInitExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewMapInitExpression.java
@@ -12,6 +12,7 @@ public ASTNewMapInitExpression(NewMapInitExpression newMapInitExpression) {
super(newMapInitExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewMapLiteralExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewMapLiteralExpression.java
index 406f3c046ab..77cac52fa00 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewMapLiteralExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewMapLiteralExpression.java
@@ -12,6 +12,7 @@ public ASTNewMapLiteralExpression(NewMapLiteralExpression newMapLiteralExpressio
super(newMapLiteralExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewObjectExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewObjectExpression.java
index 510e79b6c9f..7195c58afc2 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewObjectExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewObjectExpression.java
@@ -12,6 +12,7 @@ public ASTNewObjectExpression(NewObjectExpression newObjectExpression) {
super(newObjectExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewSetInitExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewSetInitExpression.java
index 6f412d21803..130a0603fd4 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewSetInitExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewSetInitExpression.java
@@ -12,6 +12,7 @@ public ASTNewSetInitExpression(NewSetInitExpression newSetInitExpression) {
super(newSetInitExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewSetLiteralExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewSetLiteralExpression.java
index 6e07c93260f..43517f85c6d 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewSetLiteralExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTNewSetLiteralExpression.java
@@ -12,6 +12,7 @@ public ASTNewSetLiteralExpression(NewSetLiteralExpression newSetLiteralExpressio
super(newSetLiteralExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTPackageVersionExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTPackageVersionExpression.java
index 2ad57df462f..33133633706 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTPackageVersionExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTPackageVersionExpression.java
@@ -12,6 +12,7 @@ public ASTPackageVersionExpression(PackageVersionExpression packageVersionExpres
super(packageVersionExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTParameter.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTParameter.java
index 21eb2309497..b861bc1472c 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTParameter.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTParameter.java
@@ -4,20 +4,35 @@
package net.sourceforge.pmd.lang.apex.ast;
+import net.sourceforge.pmd.Rule;
+
import apex.jorje.semantic.ast.member.Parameter;
-public class ASTParameter extends AbstractApexNode<Parameter> {
+public class ASTParameter extends AbstractApexNode<Parameter> implements CanSuppressWarnings {
public ASTParameter(Parameter parameter) {
super(parameter);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
@Override
public String getImage() {
- return node.getName().value;
+ return node.getName().getValue();
+ }
+
+ @Override
+ public boolean hasSuppressWarningsAnnotationFor(Rule rule) {
+ for (ASTModifierNode modifier : findChildrenOfType(ASTModifierNode.class)) {
+ for (ASTAnnotation a : modifier.findChildrenOfType(ASTAnnotation.class)) {
+ if (a.suppresses(rule)) {
+ return true;
+ }
+ }
+ }
+ return false;
}
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTPostfixExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTPostfixExpression.java
index 19fe85bb4cf..4d2bd2b017c 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTPostfixExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTPostfixExpression.java
@@ -12,6 +12,7 @@ public ASTPostfixExpression(PostfixExpression postfixExpression) {
super(postfixExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTPrefixExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTPrefixExpression.java
index 707970e767e..11db2fb4a30 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTPrefixExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTPrefixExpression.java
@@ -12,6 +12,7 @@ public ASTPrefixExpression(PrefixExpression prefixExpression) {
super(prefixExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTProperty.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTProperty.java
index a64e976c9a5..a0bec8ba906 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTProperty.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTProperty.java
@@ -12,6 +12,7 @@ public ASTProperty(Property property) {
super(property);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTReferenceExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTReferenceExpression.java
index 8287ab39afd..32e91d26bbd 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTReferenceExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTReferenceExpression.java
@@ -12,6 +12,7 @@ public ASTReferenceExpression(ReferenceExpression referenceExpression) {
super(referenceExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTReturnStatement.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTReturnStatement.java
index 004e735b16d..dfe345408ed 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTReturnStatement.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTReturnStatement.java
@@ -12,6 +12,7 @@ public ASTReturnStatement(ReturnStatement returnStatement) {
super(returnStatement);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTRunAsBlockStatement.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTRunAsBlockStatement.java
index e108b99e658..ff2b84eef4b 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTRunAsBlockStatement.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTRunAsBlockStatement.java
@@ -12,6 +12,7 @@ public ASTRunAsBlockStatement(RunAsBlockStatement runAsBlockStatement) {
super(runAsBlockStatement);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTSoqlExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTSoqlExpression.java
index 52c2f7355b8..b05e5dcf7c1 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTSoqlExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTSoqlExpression.java
@@ -12,6 +12,7 @@ public ASTSoqlExpression(SoqlExpression soqlExpression) {
super(soqlExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTSoslExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTSoslExpression.java
index f029ecd490a..b773d346aaa 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTSoslExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTSoslExpression.java
@@ -12,6 +12,7 @@ public ASTSoslExpression(SoslExpression soslExpression) {
super(soslExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTStandardCondition.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTStandardCondition.java
index f01164cf428..9260962ef9d 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTStandardCondition.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTStandardCondition.java
@@ -12,6 +12,7 @@ public ASTStandardCondition(StandardCondition standardCondition) {
super(standardCondition);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTStatement.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTStatement.java
index f30541ebea3..9fe6e7dd1c4 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTStatement.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTStatement.java
@@ -12,6 +12,7 @@ public ASTStatement(Statement statement) {
super(statement);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTStatementExecuted.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTStatementExecuted.java
index 3307ddca4b5..0e4b865065f 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTStatementExecuted.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTStatementExecuted.java
@@ -12,6 +12,7 @@ public ASTStatementExecuted(StatementExecuted node) {
super(node);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTSuperMethodCallExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTSuperMethodCallExpression.java
index 689e201e7d9..1dfbd47f46c 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTSuperMethodCallExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTSuperMethodCallExpression.java
@@ -12,6 +12,7 @@ public ASTSuperMethodCallExpression(SuperMethodCallExpression superMethodCallExp
super(superMethodCallExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTSuperVariableExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTSuperVariableExpression.java
index 65abf340278..2b13cb7171d 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTSuperVariableExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTSuperVariableExpression.java
@@ -12,6 +12,7 @@ public ASTSuperVariableExpression(SuperVariableExpression superVariableExpressio
super(superVariableExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTTernaryExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTTernaryExpression.java
index 8f6beae7656..3aa5622d528 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTTernaryExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTTernaryExpression.java
@@ -12,6 +12,7 @@ public ASTTernaryExpression(TernaryExpression ternaryExpression) {
super(ternaryExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTThisMethodCallExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTThisMethodCallExpression.java
index 6ec6115930b..b3f1194c2ef 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTThisMethodCallExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTThisMethodCallExpression.java
@@ -12,6 +12,7 @@ public ASTThisMethodCallExpression(ThisMethodCallExpression thisMethodCallExpres
super(thisMethodCallExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTThisVariableExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTThisVariableExpression.java
index 1a054880c1c..d28e79a9493 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTThisVariableExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTThisVariableExpression.java
@@ -12,6 +12,7 @@ public ASTThisVariableExpression(ThisVariableExpression thisVariableExpression)
super(thisVariableExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTThrowStatement.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTThrowStatement.java
index 85a60624ca2..00c977f9cad 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTThrowStatement.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTThrowStatement.java
@@ -12,6 +12,7 @@ public ASTThrowStatement(ThrowStatement throwStatement) {
super(throwStatement);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTTriggerVariableExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTTriggerVariableExpression.java
index 8d1ec224ccb..45260316cc1 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTTriggerVariableExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTTriggerVariableExpression.java
@@ -12,6 +12,7 @@ public ASTTriggerVariableExpression(TriggerVariableExpression triggerVariableExp
super(triggerVariableExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTTryCatchFinallyBlockStatement.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTTryCatchFinallyBlockStatement.java
index 79d17b94ae9..07d8e8e83f5 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTTryCatchFinallyBlockStatement.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTTryCatchFinallyBlockStatement.java
@@ -12,6 +12,7 @@ public ASTTryCatchFinallyBlockStatement(TryCatchFinallyBlockStatement tryCatchFi
super(tryCatchFinallyBlockStatement);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTUserClass.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTUserClass.java
index c506ce13c7e..8e8594e13e7 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTUserClass.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTUserClass.java
@@ -6,19 +6,22 @@
import java.lang.reflect.Field;
-import apex.jorje.data.ast.Identifier;
+import net.sourceforge.pmd.Rule;
+
+import apex.jorje.data.Identifier;
import apex.jorje.semantic.ast.compilation.UserClass;
-public class ASTUserClass extends ApexRootNode<UserClass> implements ASTUserClassOrInterface<UserClass> {
+public class ASTUserClass extends ApexRootNode<UserClass> implements ASTUserClassOrInterface<UserClass>,
+ CanSuppressWarnings {
private ApexQualifiedName qname;
-
public ASTUserClass(UserClass userClass) {
super(userClass);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
@@ -30,14 +33,12 @@ public String getImage() {
Field field = node.getClass().getDeclaredField("name");
field.setAccessible(true);
Identifier name = (Identifier) field.get(node);
- return name.value;
- } catch (Exception e) {
- e.printStackTrace();
+ return name.getValue();
+ } catch (NoSuchFieldException | IllegalArgumentException | IllegalAccessException e) {
+ throw new RuntimeException(e);
}
- return super.getImage();
}
-
@Override
public ApexQualifiedName getQualifiedName() {
if (qname == null) {
@@ -59,4 +60,16 @@ public ApexQualifiedName getQualifiedName() {
public TypeKind getTypeKind() {
return TypeKind.CLASS;
}
+
+ @Override
+ public boolean hasSuppressWarningsAnnotationFor(Rule rule) {
+ for (ASTModifierNode modifier : findChildrenOfType(ASTModifierNode.class)) {
+ for (ASTAnnotation a : modifier.findChildrenOfType(ASTAnnotation.class)) {
+ if (a.suppresses(rule)) {
+ return true;
+ }
+ }
+ }
+ return false;
+ }
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTUserClassMethods.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTUserClassMethods.java
index da2161c13b3..0146a2d3c6d 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTUserClassMethods.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTUserClassMethods.java
@@ -12,6 +12,7 @@ public ASTUserClassMethods(UserClassMethods userClassMethods) {
super(userClassMethods);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTUserEnum.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTUserEnum.java
index 39588a4cfef..9e05252dafa 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTUserEnum.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTUserEnum.java
@@ -12,6 +12,7 @@ public ASTUserEnum(UserEnum userEnum) {
super(userEnum);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTUserExceptionMethods.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTUserExceptionMethods.java
index 522e882187e..25306a1e5c1 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTUserExceptionMethods.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTUserExceptionMethods.java
@@ -12,6 +12,7 @@ public ASTUserExceptionMethods(UserExceptionMethods userExceptionMethods) {
super(userExceptionMethods);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTUserInterface.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTUserInterface.java
index f9b8a181b69..bf7995bd264 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTUserInterface.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTUserInterface.java
@@ -6,10 +6,13 @@
import java.lang.reflect.Field;
-import apex.jorje.data.ast.Identifier;
+import net.sourceforge.pmd.Rule;
+
+import apex.jorje.data.Identifier;
import apex.jorje.semantic.ast.compilation.UserInterface;
-public class ASTUserInterface extends ApexRootNode<UserInterface> implements ASTUserClassOrInterface<UserInterface> {
+public class ASTUserInterface extends ApexRootNode<UserInterface> implements ASTUserClassOrInterface<UserInterface>,
+ CanSuppressWarnings {
private ApexQualifiedName qname;
@@ -17,6 +20,7 @@ public ASTUserInterface(UserInterface userInterface) {
super(userInterface);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
@@ -27,20 +31,17 @@ public String getImage() {
Field field = node.getClass().getDeclaredField("name");
field.setAccessible(true);
Identifier name = (Identifier) field.get(node);
- return name.value;
- } catch (Exception e) {
- e.printStackTrace();
+ return name.getValue();
+ } catch (NoSuchFieldException | IllegalArgumentException | IllegalAccessException e) {
+ throw new RuntimeException(e);
}
- return super.getImage();
}
-
@Override
public TypeKind getTypeKind() {
return TypeKind.INTERFACE;
}
-
@Override
public ApexQualifiedName getQualifiedName() {
if (qname == null) {
@@ -56,4 +57,16 @@ public ApexQualifiedName getQualifiedName() {
return qname;
}
+
+ @Override
+ public boolean hasSuppressWarningsAnnotationFor(Rule rule) {
+ for (ASTModifierNode modifier : findChildrenOfType(ASTModifierNode.class)) {
+ for (ASTAnnotation a : modifier.findChildrenOfType(ASTAnnotation.class)) {
+ if (a.suppresses(rule)) {
+ return true;
+ }
+ }
+ }
+ return false;
+ }
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTUserTrigger.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTUserTrigger.java
index b42192b1972..3c9f5b1bef8 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTUserTrigger.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTUserTrigger.java
@@ -6,7 +6,7 @@
import java.lang.reflect.Field;
-import apex.jorje.data.ast.Identifier;
+import apex.jorje.data.Identifier;
import apex.jorje.semantic.ast.compilation.UserTrigger;
public class ASTUserTrigger extends ApexRootNode<UserTrigger> {
@@ -15,6 +15,7 @@ public ASTUserTrigger(UserTrigger userTrigger) {
super(userTrigger);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
@@ -25,10 +26,9 @@ public String getImage() {
Field field = node.getClass().getDeclaredField("name");
field.setAccessible(true);
Identifier name = (Identifier) field.get(node);
- return name.value;
- } catch (Exception e) {
- e.printStackTrace();
+ return name.getValue();
+ } catch (NoSuchFieldException | IllegalArgumentException | IllegalAccessException e) {
+ throw new RuntimeException(e);
}
- return super.getImage();
}
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTVariableDeclaration.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTVariableDeclaration.java
index e6ca034e98c..684e55b32ff 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTVariableDeclaration.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTVariableDeclaration.java
@@ -4,14 +4,17 @@
package net.sourceforge.pmd.lang.apex.ast;
+import net.sourceforge.pmd.Rule;
+
import apex.jorje.semantic.ast.statement.VariableDeclaration;
-public class ASTVariableDeclaration extends AbstractApexNode<VariableDeclaration> {
+public class ASTVariableDeclaration extends AbstractApexNode<VariableDeclaration> implements CanSuppressWarnings {
public ASTVariableDeclaration(VariableDeclaration variableDeclaration) {
super(variableDeclaration);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
@@ -20,4 +23,18 @@ public Object jjtAccept(ApexParserVisitor visitor, Object data) {
public String getImage() {
return node.getLocalInfo().getName();
}
+
+ @Override
+ public boolean hasSuppressWarningsAnnotationFor(Rule rule) {
+ ASTVariableDeclarationStatements parent = (ASTVariableDeclarationStatements) jjtGetParent();
+
+ for (ASTModifierNode modifier : parent.findChildrenOfType(ASTModifierNode.class)) {
+ for (ASTAnnotation a : modifier.findChildrenOfType(ASTAnnotation.class)) {
+ if (a.suppresses(rule)) {
+ return true;
+ }
+ }
+ }
+ return false;
+ }
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTVariableDeclarationStatements.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTVariableDeclarationStatements.java
index 89473603977..0a5a9b31559 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTVariableDeclarationStatements.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTVariableDeclarationStatements.java
@@ -12,6 +12,7 @@ public ASTVariableDeclarationStatements(VariableDeclarationStatements variableDe
super(variableDeclarationStatements);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTVariableExpression.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTVariableExpression.java
index 11061d46205..19f41508863 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTVariableExpression.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTVariableExpression.java
@@ -12,6 +12,7 @@ public ASTVariableExpression(VariableExpression variableExpression) {
super(variableExpression);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTWhileLoopStatement.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTWhileLoopStatement.java
index 09bf0ad7e20..f24d2854f8b 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTWhileLoopStatement.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTWhileLoopStatement.java
@@ -12,6 +12,7 @@ public ASTWhileLoopStatement(WhileLoopStatement whileLoopStatement) {
super(whileLoopStatement);
}
+ @Override
public Object jjtAccept(ApexParserVisitor visitor, Object data) {
return visitor.visit(this, data);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/AbstractApexNode.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/AbstractApexNode.java
index d0e62947c13..bc18a8d05df 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/AbstractApexNode.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/AbstractApexNode.java
@@ -4,8 +4,6 @@
package net.sourceforge.pmd.lang.apex.ast;
-import net.sourceforge.pmd.lang.ast.AbstractNode;
-import net.sourceforge.pmd.lang.ast.Node;
import net.sourceforge.pmd.lang.ast.SourceCodePositioner;
import apex.jorje.data.Location;
@@ -13,12 +11,12 @@
import apex.jorje.semantic.ast.AstNode;
import apex.jorje.semantic.exception.UnexpectedCodePathException;
-public abstract class AbstractApexNode<T extends AstNode> extends AbstractNode implements ApexNode<T> {
+public abstract class AbstractApexNode<T extends AstNode> extends AbstractApexNodeBase implements ApexNode<T> {
protected final T node;
public AbstractApexNode(T node) {
- super(node.getClass().hashCode());
+ super(node.getClass());
this.node = node;
}
@@ -28,20 +26,7 @@ void calculateLineNumbers(SourceCodePositioner positioner) {
}
Location loc = node.getLoc();
- int startOffset = loc.startIndex;
- int endOffset = loc.endIndex;
- // end column will be interpreted as inclusive, while endOffset/endIndex
- // is exclusive
- endOffset -= 1;
-
- this.beginLine = positioner.lineNumberFromOffset(startOffset);
- this.beginColumn = positioner.columnFromOffset(this.beginLine, startOffset);
- this.endLine = positioner.lineNumberFromOffset(endOffset);
- this.endColumn = positioner.columnFromOffset(this.endLine, endOffset);
-
- if (this.endColumn < 0) {
- this.endColumn = 0;
- }
+ calculateLineNumbers(positioner, loc.getStartIndex(), loc.getEndIndex());
}
protected void handleSourceCode(String source) {
@@ -49,68 +34,6 @@ protected void handleSourceCode(String source) {
}
@Override
- public int getBeginLine() {
- if (this.beginLine > 0) {
- return this.beginLine;
- }
- Node parent = jjtGetParent();
- if (parent != null) {
- return parent.getBeginLine();
- }
- throw new RuntimeException("Unable to determine beginning line of Node.");
- }
-
- @Override
- public int getBeginColumn() {
- if (this.beginColumn > 0) {
- return this.beginColumn;
- }
- Node parent = jjtGetParent();
- if (parent != null) {
- return parent.getBeginColumn();
- }
- throw new RuntimeException("Unable to determine beginning column of Node.");
- }
-
- @Override
- public int getEndLine() {
- if (this.endLine > 0) {
- return this.endLine;
- }
- Node parent = jjtGetParent();
- if (parent != null) {
- return parent.getEndLine();
- }
- throw new RuntimeException("Unable to determine ending line of Node.");
- }
-
- @Override
- public int getEndColumn() {
- if (this.endColumn > 0) {
- return this.endColumn;
- }
- Node parent = jjtGetParent();
- if (parent != null) {
- return parent.getEndColumn();
- }
- throw new RuntimeException("Unable to determine ending column of Node.");
- }
-
- /**
- * Accept the visitor. *
- */
- public Object childrenAccept(ApexParserVisitor visitor, Object data) {
- if (children != null) {
- for (int i = 0; i < children.length; ++i) {
- @SuppressWarnings("unchecked")
- // we know that the children here are all ApexNodes
- ApexNode<T> apexNode = (ApexNode<T>) children[i];
- apexNode.jjtAccept(visitor, data);
- }
- }
- return data;
- }
-
public T getNode() {
return node;
}
@@ -130,11 +53,6 @@ protected boolean hasRealLoc() {
}
}
- @Override
- public String toString() {
- return this.getClass().getSimpleName().replaceFirst("^AST", "");
- }
-
public String getLocation() {
if (hasRealLoc()) {
return String.valueOf(node.getLoc());
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/AbstractApexNodeBase.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/AbstractApexNodeBase.java
new file mode 100644
index 00000000000..8ba32fe4a72
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/AbstractApexNodeBase.java
@@ -0,0 +1,103 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.ast;
+
+import net.sourceforge.pmd.lang.ast.AbstractNode;
+import net.sourceforge.pmd.lang.ast.Node;
+import net.sourceforge.pmd.lang.ast.SourceCodePositioner;
+
+public abstract class AbstractApexNodeBase extends AbstractNode {
+
+ public AbstractApexNodeBase(Class<?> klass) {
+ super(klass.hashCode());
+ }
+
+ /* package */ void calculateLineNumbers(SourceCodePositioner positioner, int startOffset, int endOffset) {
+ // end column will be interpreted as inclusive, while endOffset/endIndex
+ // is exclusive
+ endOffset -= 1;
+
+ this.beginLine = positioner.lineNumberFromOffset(startOffset);
+ this.beginColumn = positioner.columnFromOffset(this.beginLine, startOffset);
+ this.endLine = positioner.lineNumberFromOffset(endOffset);
+ this.endColumn = positioner.columnFromOffset(this.endLine, endOffset);
+
+ if (this.endColumn < 0) {
+ this.endColumn = 0;
+ }
+ }
+
+ /**
+ * Accept the visitor. *
+ */
+ public abstract Object jjtAccept(ApexParserVisitor visitor, Object data);
+
+ /**
+ * Accept the visitor. *
+ */
+ public Object childrenAccept(ApexParserVisitor visitor, Object data) {
+ if (children != null) {
+ for (int i = 0; i < children.length; ++i) {
+ // we know that the children here are all ApexNodes
+ AbstractApexNodeBase apexNode = (AbstractApexNodeBase) children[i];
+ apexNode.jjtAccept(visitor, data);
+ }
+ }
+ return data;
+ }
+
+ @Override
+ public int getBeginLine() {
+ if (this.beginLine > 0) {
+ return this.beginLine;
+ }
+ Node parent = jjtGetParent();
+ if (parent != null) {
+ return parent.getBeginLine();
+ }
+ throw new RuntimeException("Unable to determine beginning line of Node.");
+ }
+
+ @Override
+ public int getBeginColumn() {
+ if (this.beginColumn > 0) {
+ return this.beginColumn;
+ }
+ Node parent = jjtGetParent();
+ if (parent != null) {
+ return parent.getBeginColumn();
+ }
+ throw new RuntimeException("Unable to determine beginning column of Node.");
+ }
+
+ @Override
+ public int getEndLine() {
+ if (this.endLine > 0) {
+ return this.endLine;
+ }
+ Node parent = jjtGetParent();
+ if (parent != null) {
+ return parent.getEndLine();
+ }
+ throw new RuntimeException("Unable to determine ending line of Node.");
+ }
+
+ @Override
+ public int getEndColumn() {
+ if (this.endColumn > 0) {
+ return this.endColumn;
+ }
+ Node parent = jjtGetParent();
+ if (parent != null) {
+ return parent.getEndColumn();
+ }
+ throw new RuntimeException("Unable to determine ending column of Node.");
+ }
+
+ @Override
+ public final String getXPathNodeName() {
+ return this.getClass().getSimpleName().replaceFirst("^AST", "");
+ }
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexParser.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexParser.java
index b71f438e122..3cbd386de20 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexParser.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexParser.java
@@ -15,6 +15,7 @@
import net.sourceforge.pmd.lang.apex.ApexParserOptions;
import net.sourceforge.pmd.lang.ast.ParseException;
+import apex.jorje.data.Locations;
import apex.jorje.semantic.ast.compilation.Compilation;
import apex.jorje.semantic.ast.compilation.UserClass;
import apex.jorje.semantic.ast.compilation.UserEnum;
@@ -27,24 +28,19 @@ public class ApexParser {
protected final ApexParserOptions parserOptions;
private Map<Integer, String> suppressMap;
- private String suppressMarker = "NOPMD";
public ApexParser(ApexParserOptions parserOptions) {
ApexJorjeLogging.disableLogging();
this.parserOptions = parserOptions;
-
- if (parserOptions.getSuppressMarker() != null) {
- suppressMarker = parserOptions.getSuppressMarker();
- }
}
public Compilation parseApex(final String sourceCode) throws ParseException {
TopLevelVisitor visitor = new TopLevelVisitor();
+ Locations.useIndexFactory();
CompilerService.INSTANCE.visitAstFromString(sourceCode, visitor);
- Compilation astRoot = visitor.getTopLevel();
- return astRoot;
+ return visitor.getTopLevel();
}
public ApexNode<Compilation> parse(final Reader reader) {
@@ -58,8 +54,7 @@ public ApexNode<Compilation> parse(final Reader reader) {
throw new ParseException("Couldn't parse the source - there is not root node - Syntax Error??");
}
- ApexNode<Compilation> tree = treeBuilder.build(astRoot);
- return tree;
+ return treeBuilder.build(astRoot);
} catch (IOException e) {
throw new ParseException(e);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexParserVisitor.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexParserVisitor.java
index 6a20eb582aa..b662e828657 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexParserVisitor.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexParserVisitor.java
@@ -5,10 +5,17 @@
package net.sourceforge.pmd.lang.apex.ast;
public interface ApexParserVisitor {
+ Object visit(AbstractApexNodeBase node, Object data);
+
+ /**
+ * @deprecated This visit method will be removed with PMD 7.0.0. Use {@link #visit(AbstractApexNodeBase, Object)}
+ * instead. This method would not visit all nodes, e.g. ASTFormalComment would not be covered.
+ */
+ @Deprecated // will be removed with PMD 7.0.0
Object visit(ApexNode<?> node, Object data);
Object visit(ASTAnnotation node, Object data);
-
+
Object visit(ASTAnnotationParameter node, Object data);
Object visit(ASTAnonymousClass node, Object data);
@@ -38,7 +45,7 @@ public interface ApexParserVisitor {
Object visit(ASTClassRefExpression node, Object data);
Object visit(ASTConstructorPreamble node, Object data);
-
+
Object visit(ASTConstructorPreambleStatement node, Object data);
Object visit(ASTContinueStatement node, Object data);
@@ -67,6 +74,8 @@ public interface ApexParserVisitor {
Object visit(ASTFieldDeclarationStatements node, Object data);
+ Object visit(ASTFormalComment node, Object data);
+
Object visit(ASTForEachStatement node, Object data);
Object visit(ASTForLoopStatement node, Object data);
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexParserVisitorAdapter.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexParserVisitorAdapter.java
index 639b88ec879..1680151c232 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexParserVisitorAdapter.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexParserVisitorAdapter.java
@@ -6,447 +6,462 @@
public class ApexParserVisitorAdapter implements ApexParserVisitor {
@Override
- public Object visit(ApexNode<?> node, Object data) {
+ public Object visit(AbstractApexNodeBase node, Object data) {
return node.childrenAccept(this, data);
}
+ /**
+ * @deprecated This visit method will be removed with PMD 7.0.0. Use {@link #visit(AbstractApexNodeBase, Object)}
+ * instead. This method would not visit all nodes, e.g. ASTFormalComment would not be covered.
+ */
+ @Deprecated // will be removed with PMD 7.0.0
+ @Override
+ public Object visit(ApexNode<?> node, Object data) {
+ return visit((AbstractApexNodeBase) node, data);
+ }
+
@Override
public Object visit(ASTMethod node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTUserClass node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTModifierNode node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTParameter node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTBlockStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTUserClassMethods node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTBridgeMethodCreator node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTReturnStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTLiteralExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTConstructorPreambleStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTUserInterface node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTUserEnum node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTFieldDeclaration node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTWhileLoopStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTTryCatchFinallyBlockStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTForLoopStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTIfElseBlockStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTIfBlockStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTForEachStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTField node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTBreakStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTThrowStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTDoLoopStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTTernaryExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTSoqlExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTBooleanExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTAnnotation node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTAnonymousClass node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTArrayLoadExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTArrayStoreExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTAssignmentExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTBinaryExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTBindExpressions node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTCatchBlockStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTClassRefExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTContinueStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTDmlDeleteStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTDmlInsertStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTDmlMergeStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTDmlUndeleteStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTDmlUpdateStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTDmlUpsertStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTExpressionStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTFieldDeclarationStatements node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTInstanceOfExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTJavaMethodCallExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTJavaVariableExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTMapEntryNode node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTMethodCallExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTModifierOrAnnotation node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTNewListInitExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTNewListLiteralExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTNewMapInitExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTNewMapLiteralExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTNewObjectExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTNewSetInitExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTNewSetLiteralExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTPackageVersionExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTPostfixExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTPrefixExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTProperty node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTReferenceExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTRunAsBlockStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTSoslExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTStandardCondition node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTSuperMethodCallExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTSuperVariableExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTThisMethodCallExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTThisVariableExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTTriggerVariableExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTUserExceptionMethods node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTUserTrigger node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTVariableDeclaration node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTVariableDeclarationStatements node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTVariableExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTAnnotationParameter node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTCastExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTConstructorPreamble node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTIllegalStoreExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTMethodBlockStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTModifier node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTMultiStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTNestedExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTNestedStoreExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTNewKeyValueObjectExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTStatementExecuted node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
+ }
+
+ @Override
+ public Object visit(ASTFormalComment node, Object data) {
+ return visit((AbstractApexNodeBase) node, data);
}
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexParserVisitorReducedAdapter.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexParserVisitorReducedAdapter.java
index f989a95bde1..16d9329dd46 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexParserVisitorReducedAdapter.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexParserVisitorReducedAdapter.java
@@ -23,7 +23,7 @@ public final Object visit(ASTUserClass node, Object data) {
public Object visit(ASTUserClassOrInterface<?> node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexQualifiedName.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexQualifiedName.java
index f65605d0a3c..0757b833f6c 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexQualifiedName.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexQualifiedName.java
@@ -14,12 +14,13 @@
import apex.jorje.semantic.symbol.type.TypeInfo;
+
/**
* Qualified name of an apex class or method.
*
* @author Clément Fournier
*/
-public class ApexQualifiedName implements QualifiedName {
+public final class ApexQualifiedName implements QualifiedName {
private final String nameSpace;
@@ -106,9 +107,9 @@ public int hashCode() {
@Override
public boolean equals(Object obj) {
return obj instanceof ApexQualifiedName
- && Objects.deepEquals(classes, ((ApexQualifiedName) obj).classes)
- && Objects.equals(operation, ((ApexQualifiedName) obj).operation)
- && Objects.equals(nameSpace, ((ApexQualifiedName) obj).nameSpace);
+ && Objects.deepEquals(classes, ((ApexQualifiedName) obj).classes)
+ && Objects.equals(operation, ((ApexQualifiedName) obj).operation)
+ && Objects.equals(nameSpace, ((ApexQualifiedName) obj).nameSpace);
}
@@ -154,7 +155,7 @@ private static String getOperationString(ASTMethod node) {
List<TypeInfo> paramTypes = node.getNode().getMethodInfo().getParameterTypes();
- if (paramTypes.size() > 0) {
+ if (!paramTypes.isEmpty()) {
sb.append(paramTypes.get(0).getApexName());
for (int i = 1; i < paramTypes.size(); i++) {
@@ -170,8 +171,18 @@ private static String getOperationString(ASTMethod node) {
static ApexQualifiedName ofMethod(ASTMethod node) {
- ApexQualifiedName parent = node.getFirstParentOfType(ASTUserClassOrInterface.class).getQualifiedName();
+ ASTUserClassOrInterface<?> parent = node.getFirstParentOfType(ASTUserClassOrInterface.class);
+ if (parent == null) {
+ ASTUserTrigger trigger = node.getFirstParentOfType(ASTUserTrigger.class);
+ String ns = trigger.getNode().getDefiningType().getNamespace().toString();
+ String targetObj = trigger.getNode().getTargetName().get(0).getValue();
+
+ return new ApexQualifiedName(StringUtils.isEmpty(ns) ? "c" : ns, new String[]{"trigger", targetObj}, trigger.getImage()); // uses a reserved word as a class name to prevent clashes
- return new ApexQualifiedName(parent.nameSpace, parent.classes, getOperationString(node));
+ } else {
+ ApexQualifiedName baseName = parent.getQualifiedName();
+
+ return new ApexQualifiedName(baseName.nameSpace, baseName.classes, getOperationString(node));
+ }
}
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexTreeBuilder.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexTreeBuilder.java
index 21e0c6e96d9..e55005d186a 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexTreeBuilder.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexTreeBuilder.java
@@ -6,13 +6,20 @@
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
+import java.util.ArrayList;
import java.util.HashMap;
+import java.util.List;
+import java.util.ListIterator;
import java.util.Map;
import java.util.Stack;
+import org.antlr.runtime.ANTLRStringStream;
+import org.antlr.runtime.Token;
+
import net.sourceforge.pmd.lang.ast.Node;
import net.sourceforge.pmd.lang.ast.SourceCodePositioner;
+import apex.jorje.parser.impl.ApexLexer;
import apex.jorje.semantic.ast.AstNode;
import apex.jorje.semantic.ast.compilation.AnonymousClass;
import apex.jorje.semantic.ast.compilation.ConstructorPreamble;
@@ -87,7 +94,6 @@
import apex.jorje.semantic.ast.statement.ExpressionStatement;
import apex.jorje.semantic.ast.statement.FieldDeclaration;
import apex.jorje.semantic.ast.statement.FieldDeclarationStatements;
-import apex.jorje.semantic.ast.statement.ForEachStatement;
import apex.jorje.semantic.ast.statement.ForLoopStatement;
import apex.jorje.semantic.ast.statement.IfBlockStatement;
import apex.jorje.semantic.ast.statement.IfElseBlockStatement;
@@ -102,6 +108,7 @@
import apex.jorje.semantic.ast.statement.VariableDeclaration;
import apex.jorje.semantic.ast.statement.VariableDeclarationStatements;
import apex.jorje.semantic.ast.statement.WhileLoopStatement;
+import apex.jorje.semantic.ast.statement.foreachstatement.ForEachStatement;
import apex.jorje.semantic.ast.visitor.AdditionalPassScope;
import apex.jorje.semantic.ast.visitor.AstVisitor;
import apex.jorje.semantic.exception.Errors;
@@ -216,17 +223,19 @@ private static <T extends AstNode> void register(Class<T> nodeType, Class<? exte
// The Apex nodes with children to build.
private Stack<AstNode> parents = new Stack<>();
+
+ private AdditionalPassScope scope = new AdditionalPassScope(Errors.createErrors());
private final SourceCodePositioner sourceCodePositioner;
private final String sourceCode;
+ private ListIterator<TokenLocation> apexDocTokenLocations;
public ApexTreeBuilder(String sourceCode) {
this.sourceCode = sourceCode;
sourceCodePositioner = new SourceCodePositioner(sourceCode);
+ apexDocTokenLocations = buildApexDocTokenLocations(sourceCode).listIterator();
}
- AdditionalPassScope scope = new AdditionalPassScope(new Errors());
-
static <T extends AstNode> AbstractApexNode<T> createNodeAdapter(T node) {
try {
@SuppressWarnings("unchecked")
@@ -271,6 +280,78 @@ public <T extends AstNode> ApexNode<T> build(T astNode) {
return node;
}
+ private void buildFormalComment(AstNode node) {
+ if (parents.peek() == node) {
+ ApexNode<?> parent = (ApexNode<?>) nodes.peek();
+ TokenLocation tokenLocation = getApexDocTokenLocation(getApexDocIndex(parent));
+ if (tokenLocation != null) {
+ ASTFormalComment comment = new ASTFormalComment(tokenLocation.token);
+ comment.calculateLineNumbers(sourceCodePositioner, tokenLocation.index,
+ tokenLocation.index + tokenLocation.token.length());
+ parent.jjtAddChild(comment, 0);
+ comment.jjtSetParent(parent);
+ }
+ }
+ }
+
+ private int getApexDocIndex(ApexNode<?> node) {
+ final int index = node.getNode().getLoc().getStartIndex();
+ return sourceCode.lastIndexOf('\n', index);
+ }
+
+ private TokenLocation getApexDocTokenLocation(int index) {
+ TokenLocation last = null;
+ while (apexDocTokenLocations.hasNext()) {
+ final TokenLocation location = apexDocTokenLocations.next();
+ if (location.index >= index) {
+ // rollback, the next token corresponds to a different node
+ apexDocTokenLocations.previous();
+
+ if (last != null) {
+ return last;
+ }
+ return null;
+ }
+ last = location;
+ }
+ return last;
+ }
+
+ private static List<TokenLocation> buildApexDocTokenLocations(String source) {
+ ANTLRStringStream stream = new ANTLRStringStream(source);
+ ApexLexer lexer = new ApexLexer(stream);
+
+ ArrayList<TokenLocation> tokenLocations = new ArrayList<>();
+ int startIndex = 0;
+ Token token = lexer.nextToken();
+ int endIndex = lexer.getCharIndex();
+ while (token.getType() != Token.EOF) {
+ if (token.getType() == ApexLexer.BLOCK_COMMENT) {
+
+ // Filter only block comments starting with "/**"
+ if (token.getText().startsWith("/**")) {
+ tokenLocations.add(new TokenLocation(startIndex, token.getText()));
+ }
+ }
+ // TODO : Check other non-doc comments and tokens of type ApexLexer.EOL_COMMENT for "NOPMD" suppressions
+ startIndex = endIndex;
+ token = lexer.nextToken();
+ endIndex = lexer.getCharIndex();
+ }
+
+ return tokenLocations;
+ }
+
+ private static class TokenLocation {
+ int index;
+ String token;
+
+ TokenLocation(int index, String token) {
+ this.index = index;
+ this.token = token;
+ }
+ }
+
private boolean visit(AstNode node) {
if (parents.peek() == node) {
return true;
@@ -287,7 +368,9 @@ public boolean visit(UserEnum node, AdditionalPassScope scope) {
@Override
public boolean visit(UserInterface node, AdditionalPassScope scope) {
- return visit(node);
+ final boolean ret = visit(node);
+ buildFormalComment(node);
+ return ret;
}
@Override
@@ -572,7 +655,9 @@ public boolean visit(TryCatchFinallyBlockStatement node, AdditionalPassScope sco
@Override
public boolean visit(Property node, AdditionalPassScope scope) {
- return visit(node);
+ final boolean ret = visit(node);
+ buildFormalComment(node);
+ return ret;
}
@Override
@@ -637,12 +722,16 @@ public boolean visit(ThisVariableExpression node, AdditionalPassScope scope) {
@Override
public boolean visit(UserClass node, AdditionalPassScope scope) {
- return visit(node);
+ final boolean ret = visit(node);
+ buildFormalComment(node);
+ return ret;
}
@Override
public boolean visit(Method node, AdditionalPassScope scope) {
- return visit(node);
+ final boolean ret = visit(node);
+ buildFormalComment(node);
+ return ret;
}
@Override
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/CanSuppressWarnings.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/CanSuppressWarnings.java
new file mode 100644
index 00000000000..cc6249d6b0f
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/CanSuppressWarnings.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.ast;
+
+import net.sourceforge.pmd.Rule;
+
+public interface CanSuppressWarnings {
+ boolean hasSuppressWarningsAnnotationFor(Rule rule);
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/CompilerService.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/CompilerService.java
index 825fe3305f6..f115f87a782 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/CompilerService.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/CompilerService.java
@@ -29,9 +29,9 @@
* Central point for interfacing with the compiler. Based on <a href=
* "https://github.com/forcedotcom/idecore/blob/master/com.salesforce.ide.apex.core/src/com/salesforce/ide/apex/internal/core/CompilerService.java"
* > CompilerService</a> but with Eclipse dependencies removed.
- *
+ *
* @author nchen
- *
+ *
*/
public class CompilerService {
public static final CompilerService INSTANCE = new CompilerService();
@@ -41,7 +41,7 @@ public class CompilerService {
/**
* Configure a compiler with the default configurations:
- *
+ *
* @param symbolProvider
* EmptySymbolProvider, doesn't provide any symbols that are not
* part of source.
@@ -56,7 +56,7 @@ public class CompilerService {
/**
* Configure a compiler with the following configurations:
- *
+ *
* @param symbolProvider
* A way to retrieve symbols, where symbols are names of types.
* @param accessEvaluator
@@ -84,11 +84,10 @@ public ApexCompiler visitAstsFromStrings(List<String> sources, AstVisitor<Additi
List<SourceFile> sourceFiles = sources.stream().map(s -> SourceFile.builder().setBody(s).build())
.collect(Collectors.toList());
CompilationInput compilationUnit = createCompilationInput(sourceFiles, visitor);
- return compile(compilationUnit, visitor, compilerStage);
+ return compile(compilationUnit, compilerStage);
}
- private ApexCompiler compile(CompilationInput compilationInput, AstVisitor<AdditionalPassScope> visitor,
- CompilerStage compilerStage) {
+ private ApexCompiler compile(CompilationInput compilationInput, CompilerStage compilerStage) {
ApexCompiler compiler = ApexCompiler.builder().setInput(compilationInput).build();
compiler.compile(compilerStage);
callAdditionalPassVisitor(compiler);
@@ -107,7 +106,7 @@ private CompilationInput createCompilationInput(List<SourceFile> sourceFiles,
* don't have all the parts for yet in the offline compiler. Rather than
* stop all work on that, we bypass it so that we can still do useful things
* like find all your types, find all your methods, etc.
- *
+ *
*/
@SuppressWarnings("unchecked")
private void callAdditionalPassVisitor(ApexCompiler compiler) {
@@ -125,6 +124,7 @@ private void callAdditionalPassVisitor(ApexCompiler compiler) {
operation.invoke(compilerContext, unit);
}
} catch (IllegalAccessException | InvocationTargetException | NoSuchMethodException e) {
+ throw new RuntimeException(e);
}
}
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/DumpFacade.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/DumpFacade.java
index acaf2813b92..f4b0e4efb9a 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/DumpFacade.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/DumpFacade.java
@@ -49,7 +49,7 @@ private void dump(ApexNode<?> node, String prefix) {
writer.print(prefix);
// 2) JJT Name of the Node
- writer.print(node.toString());
+ writer.print(node.getXPathNodeName());
//
// If there are any additional details, then:
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/EmptySymbolProvider.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/EmptySymbolProvider.java
index ea008d20e3f..3a01f8925b2 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/EmptySymbolProvider.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/EmptySymbolProvider.java
@@ -29,11 +29,11 @@
/**
* @author jspagnola
*/
-public class EmptySymbolProvider implements SymbolProvider {
+public final class EmptySymbolProvider implements SymbolProvider {
private static final EmptySymbolProvider INSTANCE = new EmptySymbolProvider();
- EmptySymbolProvider() {
+ private EmptySymbolProvider() {
}
public static EmptySymbolProvider get() {
@@ -76,4 +76,9 @@ public boolean hasLabelField(final TypeInfo referencingType, final Namespace nam
public String getQuickAction(TypeInfo arg0, String arg1, String arg2) {
return null;
}
+
+ @Override
+ public TypeInfo getAggregateResultType(TypeInfo arg0) {
+ return null;
+ }
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/TestAccessEvaluator.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/TestAccessEvaluator.java
index 92e8eec5282..c321ab8ce66 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/TestAccessEvaluator.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/TestAccessEvaluator.java
@@ -65,6 +65,7 @@ public class TestAccessEvaluator implements AccessEvaluator {
private boolean isReallyRunningTests;
private boolean hasApexGenericTypes;
private boolean hasRemoteActionPerm;
+ private boolean hasPersonAccountApiAvailable;
public TestAccessEvaluator() {
validPageVersions = HashMultimap.create();
@@ -77,6 +78,7 @@ public TestAccessEvaluator() {
globalComponents = new HashSet<>();
typesWithConnectApiDeserializers = new HashSet<>();
hasRemoteActionPerm = true;
+ hasPersonAccountApiAvailable = true;
}
@Override
@@ -89,6 +91,11 @@ public boolean hasPermissionForPermGuard(final Namespace referencingNamespace, f
return allowedPermGuards.contains(new AllowedPermGuard(referencingNamespace, orgPerm));
}
+ @Override
+ public boolean hasPersonAccountApiAvailable() {
+ return hasPersonAccountApiAvailable;
+ }
+
@Override
public boolean hasPrivateApi() {
return hasPrivateApi;
@@ -105,7 +112,7 @@ public boolean hasInternalSfdc() {
}
@Override
- public boolean isTrustedApplication() {
+ public boolean isTrustedApplication(TypeInfo arg0) {
return isTrustedApplication;
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/TestQueryValidators.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/TestQueryValidators.java
index 96ee968a92a..5396c5bb340 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/TestQueryValidators.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/TestQueryValidators.java
@@ -34,6 +34,7 @@
*
* @author jspagnola
*/
+@SuppressWarnings("PMD.MissingStaticMethodInNonInstantiatableClass") // this class provides utility classes
public final class TestQueryValidators {
private TestQueryValidators() {
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/AbstractApexMetric.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/AbstractApexMetric.java
index 3c5bc125723..0b8c5c95941 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/AbstractApexMetric.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/AbstractApexMetric.java
@@ -15,8 +15,4 @@
public abstract class AbstractApexMetric<N extends Node> extends AbstractMetric<N> {
- protected ApexSignatureMatcher getSignatureMatcher() {
- return ApexMetrics.getFacade().getProjectMirror();
- }
-
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/ApexMetricsFacade.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/ApexMetricsFacade.java
index 8c22a7e8464..0bcd271ab97 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/ApexMetricsFacade.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/ApexMetricsFacade.java
@@ -11,31 +11,20 @@
/**
* Backs the static façade.
+ *
* @author Clément Fournier
*/
public class ApexMetricsFacade extends AbstractMetricsFacade<ASTUserClassOrInterface<?>, ASTMethod> {
- private final ApexProjectMirror projectMirror = new ApexProjectMirror();
private final ApexProjectMemoizer memoizer = new ApexProjectMemoizer();
/** Resets the entire project mirror. Used for tests. */
void reset() {
- projectMirror.reset();
memoizer.reset();
}
- /**
- * Gets the project mirror.
- *
- * @return The project mirror
- */
- public ApexProjectMirror getProjectMirror() {
- return projectMirror;
- }
-
-
@Override
protected MetricsComputer<ASTUserClassOrInterface<?>, ASTMethod> getLanguageSpecificComputer() {
return ApexMetricsComputer.INSTANCE;
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/ApexMetricsVisitor.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/ApexMetricsVisitor.java
deleted file mode 100644
index cfa0b8e3058..00000000000
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/ApexMetricsVisitor.java
+++ /dev/null
@@ -1,50 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.metrics;
-
-import java.util.Stack;
-
-import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
-import net.sourceforge.pmd.lang.apex.ast.ASTUserClassOrInterface;
-import net.sourceforge.pmd.lang.apex.ast.ApexParserVisitorReducedAdapter;
-
-/**
- * @author Clément Fournier
- */
-public class ApexMetricsVisitor extends ApexParserVisitorReducedAdapter {
-
- private final ApexProjectMemoizer memoizer;
- private final ApexProjectMirror mirror;
-
- private final Stack<ApexClassStats> stack = new Stack<>();
-
-
- public ApexMetricsVisitor(ApexProjectMemoizer memoizer, ApexProjectMirror mirror) {
- this.memoizer = memoizer;
- this.mirror = mirror;
- }
-
- @Override
- public Object visit(ASTUserClassOrInterface<?> node, Object data) {
- memoizer.addClassMemoizer(node.getQualifiedName());
- stack.push(mirror.getClassStats(node.getQualifiedName(), true));
- super.visit(node, data);
- stack.pop();
-
- return data;
- }
-
-
-
-
- @Override
- public Object visit(ASTMethod node, Object data) {
- memoizer.addOperationMemoizer(node.getQualifiedName());
-
- stack.peek().addOperation(node.getQualifiedName().getOperation(), node.getSignature());
- return data;
- }
-
-}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/ApexMetricsVisitorFacade.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/ApexMetricsVisitorFacade.java
deleted file mode 100644
index 78dbcd6870c..00000000000
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/ApexMetricsVisitorFacade.java
+++ /dev/null
@@ -1,23 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.metrics;
-
-import net.sourceforge.pmd.lang.apex.ast.ApexNode;
-import net.sourceforge.pmd.lang.apex.ast.ApexParserVisitorAdapter;
-
-/**
- * @author Clément Fournier
- */
-public class ApexMetricsVisitorFacade extends ApexParserVisitorAdapter {
-
-
- public void initializeWith(ApexNode<?> rootNode) {
- ApexMetricsFacade facade = ApexMetrics.getFacade();
- ApexMetricsVisitor visitor = new ApexMetricsVisitor(facade.getLanguageSpecificProjectMemoizer(),
- facade.getProjectMirror());
- rootNode.jjtAccept(visitor, null);
- }
-
-}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/rule/CyclomaticComplexityRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/rule/CyclomaticComplexityRule.java
deleted file mode 100644
index 0fce961dd8f..00000000000
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/rule/CyclomaticComplexityRule.java
+++ /dev/null
@@ -1,81 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.metrics.rule;
-
-
-import java.util.Stack;
-
-import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
-import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
-import net.sourceforge.pmd.lang.apex.metrics.ApexMetrics;
-import net.sourceforge.pmd.lang.apex.metrics.api.ApexClassMetricKey;
-import net.sourceforge.pmd.lang.apex.metrics.api.ApexOperationMetricKey;
-import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
-import net.sourceforge.pmd.lang.metrics.ResultOption;
-import net.sourceforge.pmd.properties.IntegerProperty;
-
-/**
- * Cyclomatic complexity rule using metrics. Uses Wmc to report classes (the Java rule will be updated as well in an
- * upcoming PR)
- *
- * @author Clément Fournier
- */
-public class CyclomaticComplexityRule extends AbstractApexRule {
-
- private static final IntegerProperty CLASS_LEVEL_DESCRIPTOR = new IntegerProperty(
- "classReportLevel", "Total class complexity reporting threshold", 1, 200, 40, 1.0f);
-
- private static final IntegerProperty METHOD_LEVEL_DESCRIPTOR = new IntegerProperty(
- "methodReportLevel", "Cyclomatic complexity reporting threshold", 1, 30, 10, 1.0f);
-
- Stack<String> classNames = new Stack<>();
-
-
- public CyclomaticComplexityRule() {
- definePropertyDescriptor(CLASS_LEVEL_DESCRIPTOR);
- definePropertyDescriptor(METHOD_LEVEL_DESCRIPTOR);
- }
-
-
- @Override
- public Object visit(ASTUserClass node, Object data) {
-
- classNames.push(node.getImage());
- super.visit(node, data);
- classNames.pop();
-
- if (ApexClassMetricKey.WMC.supports(node)) {
- int classWmc = (int) ApexMetrics.get(ApexClassMetricKey.WMC, node);
-
- if (classWmc >= getProperty(CLASS_LEVEL_DESCRIPTOR)) {
- int classHighest = (int) ApexMetrics.get(ApexOperationMetricKey.CYCLO, node, ResultOption.HIGHEST);
-
- String[] messageParams = {"class",
- node.getImage(),
- " total",
- classWmc + " (highest " + classHighest + ")", };
-
- addViolation(data, node, messageParams);
- }
- }
- return data;
- }
-
-
- @Override
- public final Object visit(ASTMethod node, Object data) {
-
- int cyclo = (int) ApexMetrics.get(ApexOperationMetricKey.CYCLO, node);
- if (cyclo >= getProperty(METHOD_LEVEL_DESCRIPTOR)) {
- addViolation(data, node, new String[] {node.getImage().equals(classNames.peek()) ? "constructor" : "method",
- node.getQualifiedName().getOperation(),
- "",
- "" + cyclo, });
- }
-
- return data;
- }
-
-}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/signature/ApexOperationSigMask.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/signature/ApexOperationSigMask.java
index 38230937428..feb8e6f5bca 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/signature/ApexOperationSigMask.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/signature/ApexOperationSigMask.java
@@ -18,10 +18,6 @@ public class ApexOperationSigMask {
private Set<Visibility> visMask = EnumSet.allOf(Visibility.class);
- public ApexOperationSigMask() {
- }
-
-
/**
* Sets the mask to cover all visibilities.
*/
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/ApexClassStats.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/multifile/ApexClassStats.java
similarity index 95%
rename from pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/ApexClassStats.java
rename to pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/multifile/ApexClassStats.java
index 6619dafec93..0f96f0aa349 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/ApexClassStats.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/multifile/ApexClassStats.java
@@ -2,7 +2,7 @@
* BSD-style license; for more info see http://pmd.sourceforge.net/license.html
*/
-package net.sourceforge.pmd.lang.apex.metrics;
+package net.sourceforge.pmd.lang.apex.multifile;
import java.util.HashMap;
import java.util.HashSet;
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/multifile/ApexMultifileVisitor.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/multifile/ApexMultifileVisitor.java
new file mode 100644
index 00000000000..d617a193886
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/multifile/ApexMultifileVisitor.java
@@ -0,0 +1,44 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.multifile;
+
+import java.util.Stack;
+
+import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserClassOrInterface;
+import net.sourceforge.pmd.lang.apex.ast.ApexParserVisitorReducedAdapter;
+
+/**
+ * @author Clément Fournier
+ */
+public class ApexMultifileVisitor extends ApexParserVisitorReducedAdapter {
+
+ private final ApexProjectMirror mirror;
+
+ private final Stack<ApexClassStats> stack = new Stack<>();
+
+
+ public ApexMultifileVisitor(ApexProjectMirror mirror) {
+ this.mirror = mirror;
+ }
+
+
+ @Override
+ public Object visit(ASTUserClassOrInterface<?> node, Object data) {
+ stack.push(mirror.getClassStats(node.getQualifiedName(), true));
+ super.visit(node, data);
+ stack.pop();
+
+ return data;
+ }
+
+
+ @Override
+ public Object visit(ASTMethod node, Object data) {
+ stack.peek().addOperation(node.getQualifiedName().getOperation(), node.getSignature());
+ return data;
+ }
+
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/multifile/ApexMultifileVisitorFacade.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/multifile/ApexMultifileVisitorFacade.java
new file mode 100644
index 00000000000..dfea0a69f3d
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/multifile/ApexMultifileVisitorFacade.java
@@ -0,0 +1,20 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.multifile;
+
+import net.sourceforge.pmd.lang.apex.ast.ApexNode;
+import net.sourceforge.pmd.lang.apex.ast.ApexParserVisitorAdapter;
+
+/**
+ * @author Clément Fournier
+ */
+public class ApexMultifileVisitorFacade extends ApexParserVisitorAdapter {
+
+ public void initializeWith(ApexNode<?> rootNode) {
+ ApexMultifileVisitor visitor = new ApexMultifileVisitor(ApexProjectMirror.INSTANCE);
+ rootNode.jjtAccept(visitor, null);
+ }
+
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/ApexProjectMirror.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/multifile/ApexProjectMirror.java
similarity index 79%
rename from pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/ApexProjectMirror.java
rename to pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/multifile/ApexProjectMirror.java
index a747db733bc..3283b6de556 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/metrics/ApexProjectMirror.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/multifile/ApexProjectMirror.java
@@ -2,12 +2,13 @@
* BSD-style license; for more info see http://pmd.sourceforge.net/license.html
*/
-package net.sourceforge.pmd.lang.apex.metrics;
+package net.sourceforge.pmd.lang.apex.multifile;
import java.util.HashMap;
import java.util.Map;
import net.sourceforge.pmd.lang.apex.ast.ApexQualifiedName;
+import net.sourceforge.pmd.lang.apex.metrics.ApexSignatureMatcher;
import net.sourceforge.pmd.lang.apex.metrics.signature.ApexOperationSigMask;
/**
@@ -15,10 +16,15 @@
*
* @author Clément Fournier
*/
-public class ApexProjectMirror implements ApexSignatureMatcher {
+final class ApexProjectMirror implements ApexSignatureMatcher {
+
+ static final ApexProjectMirror INSTANCE = new ApexProjectMirror();
private final Map<ApexQualifiedName, ApexClassStats> classes = new HashMap<>();
+ private ApexProjectMirror() {
+ }
+
void reset() {
classes.clear();
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/AbstractApexRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/AbstractApexRule.java
index 0984252fb20..9a139bfd281 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/AbstractApexRule.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/AbstractApexRule.java
@@ -43,6 +43,7 @@
import net.sourceforge.pmd.lang.apex.ast.ASTFieldDeclarationStatements;
import net.sourceforge.pmd.lang.apex.ast.ASTForEachStatement;
import net.sourceforge.pmd.lang.apex.ast.ASTForLoopStatement;
+import net.sourceforge.pmd.lang.apex.ast.ASTFormalComment;
import net.sourceforge.pmd.lang.apex.ast.ASTIfBlockStatement;
import net.sourceforge.pmd.lang.apex.ast.ASTIfElseBlockStatement;
import net.sourceforge.pmd.lang.apex.ast.ASTIllegalStoreExpression;
@@ -99,6 +100,7 @@
import net.sourceforge.pmd.lang.apex.ast.ASTVariableDeclarationStatements;
import net.sourceforge.pmd.lang.apex.ast.ASTVariableExpression;
import net.sourceforge.pmd.lang.apex.ast.ASTWhileLoopStatement;
+import net.sourceforge.pmd.lang.apex.ast.AbstractApexNodeBase;
import net.sourceforge.pmd.lang.apex.ast.ApexNode;
import net.sourceforge.pmd.lang.apex.ast.ApexParserVisitor;
import net.sourceforge.pmd.lang.ast.Node;
@@ -121,6 +123,7 @@ public ParserOptions getParserOptions() {
return new ApexParserOptions();
}
+ @Override
public void apply(List<? extends Node> nodes, RuleContext ctx) {
visitAll(nodes, ctx);
}
@@ -138,448 +141,463 @@ protected void visitAll(List<? extends Node> nodes, RuleContext ctx) {
}
@Override
- public Object visit(ApexNode<?> node, Object data) {
+ public Object visit(AbstractApexNodeBase node, Object data) {
node.childrenAccept(this, data);
return null;
}
+ /**
+ * @deprecated This visit method will be removed with PMD 7.0.0. Use {@link #visit(AbstractApexNodeBase, Object)}
+ * instead. This method would not visit all nodes, e.g. ASTFormalComment would not be covered.
+ */
+ @Deprecated // will be removed with PMD 7.0.0
+ @Override
+ public Object visit(ApexNode<?> node, Object data) {
+ return visit((AbstractApexNodeBase) node, data);
+ }
+
@Override
public Object visit(ASTMethod node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTUserClass node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTModifierNode node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTParameter node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTBlockStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTUserClassMethods node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTBridgeMethodCreator node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTReturnStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTLiteralExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTConstructorPreambleStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTUserInterface node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTUserEnum node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTFieldDeclaration node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTWhileLoopStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTTryCatchFinallyBlockStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTForLoopStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTIfElseBlockStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTIfBlockStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTForEachStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTField node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTBreakStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTThrowStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTDoLoopStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTTernaryExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTSoqlExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTBooleanExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTAnnotation node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTAnonymousClass node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTArrayLoadExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTArrayStoreExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTAssignmentExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTBinaryExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTBindExpressions node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTCatchBlockStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTClassRefExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTContinueStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTDmlDeleteStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTDmlInsertStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTDmlMergeStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTDmlUndeleteStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTDmlUpdateStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTDmlUpsertStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTExpressionStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTFieldDeclarationStatements node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTInstanceOfExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTJavaMethodCallExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTJavaVariableExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTMapEntryNode node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTMethodCallExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTModifierOrAnnotation node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTNewListInitExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTNewListLiteralExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTNewMapInitExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTNewMapLiteralExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTNewObjectExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTNewSetInitExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTNewSetLiteralExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTPackageVersionExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTPostfixExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTPrefixExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTProperty node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTReferenceExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTRunAsBlockStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTSoslExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTStandardCondition node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTSuperMethodCallExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTSuperVariableExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTThisMethodCallExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTThisVariableExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTTriggerVariableExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTUserExceptionMethods node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTUserTrigger node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTVariableDeclaration node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTVariableDeclarationStatements node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTVariableExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTAnnotationParameter node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTCastExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTConstructorPreamble node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTIllegalStoreExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTMethodBlockStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTModifier node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTMultiStatement node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTNestedExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTNestedStoreExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTNewKeyValueObjectExpression node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
}
@Override
public Object visit(ASTStatementExecuted node, Object data) {
- return visit((ApexNode<?>) node, data);
+ return visit((AbstractApexNodeBase) node, data);
+ }
+
+ @Override
+ public Object visit(ASTFormalComment node, Object data) {
+ return visit((AbstractApexNodeBase) node, data);
}
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/apexunit/AbstractApexUnitTestRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/AbstractApexUnitTestRule.java
similarity index 88%
rename from pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/apexunit/AbstractApexUnitTestRule.java
rename to pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/AbstractApexUnitTestRule.java
index d74b34ef045..974954d0b22 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/apexunit/AbstractApexUnitTestRule.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/AbstractApexUnitTestRule.java
@@ -2,12 +2,11 @@
* BSD-style license; for more info see http://pmd.sourceforge.net/license.html
*/
-package net.sourceforge.pmd.lang.apex.rule.apexunit;
+package net.sourceforge.pmd.lang.apex.rule;
import net.sourceforge.pmd.lang.apex.ast.ASTModifierNode;
import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
import net.sourceforge.pmd.lang.apex.ast.ApexNode;
-import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
import apex.jorje.services.Version;
@@ -37,7 +36,7 @@ public Object visit(final ASTUserClass node, final Object data) {
return super.visit(node, data);
}
- boolean isTestMethodOrClass(final ApexNode<?> node) {
+ protected boolean isTestMethodOrClass(final ApexNode<?> node) {
final ASTModifierNode modifierNode = node.getFirstChildOfType(ASTModifierNode.class);
return modifierNode != null && modifierNode.getNode().getModifiers().isTest();
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/AbstractStatisticalApexRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/AbstractStatisticalApexRule.java
index facfe0f7e59..054bea94c93 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/AbstractStatisticalApexRule.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/AbstractStatisticalApexRule.java
@@ -16,12 +16,14 @@ public abstract class AbstractStatisticalApexRule extends AbstractApexRule imple
private final StatisticalRuleHelper helper = new StatisticalRuleHelper(this);
+ @Override
public void addDataPoint(DataPoint point) {
helper.addDataPoint(point);
}
+ @Override
public Object[] getViolationParameters(DataPoint point) {
- return null;
+ return new Object[0];
}
@Override
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/ApexRuleChainVisitor.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/ApexRuleChainVisitor.java
index b3f906bbc77..5abce5d8ac9 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/ApexRuleChainVisitor.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/ApexRuleChainVisitor.java
@@ -18,6 +18,7 @@
public class ApexRuleChainVisitor extends AbstractRuleChainVisitor {
+ @Override
protected void indexNodes(List<Node> nodes, RuleContext ctx) {
Stack<Node> stack = new Stack<>();
stack.addAll(nodes);
@@ -33,6 +34,7 @@ protected void indexNodes(List<Node> nodes, RuleContext ctx) {
}
}
+ @Override
protected void visit(Rule rule, Node node, RuleContext ctx) {
if (rule instanceof XPathRule) {
((XPathRule) rule).evaluate(node, ctx);
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/ApexRuleViolation.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/ApexRuleViolation.java
new file mode 100644
index 00000000000..fd44350f5d9
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/ApexRuleViolation.java
@@ -0,0 +1,68 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule;
+
+import net.sourceforge.pmd.Rule;
+import net.sourceforge.pmd.RuleContext;
+import net.sourceforge.pmd.lang.apex.ast.CanSuppressWarnings;
+import net.sourceforge.pmd.lang.ast.Node;
+import net.sourceforge.pmd.lang.rule.ParametricRuleViolation;
+
+/**
+ * This is an Apex RuleViolation. It knows how to try to extract the following
+ * extra information from the violation node:
+ * <ul>
+ * <li>Package name</li>
+ * <li>Class name</li>
+ * <li>Method name</li>
+ * <li>Variable name</li>
+ * <li>Suppression indicator</li>
+ * </ul>
+ * @param <T>
+ */
+@SuppressWarnings("PMD.UseUtilityClass") // we inherit non-static methods...
+public class ApexRuleViolation<T> extends ParametricRuleViolation<Node> {
+
+ public ApexRuleViolation(Rule rule, RuleContext ctx, Node node, String message, int beginLine, int endLine) {
+ this(rule, ctx, node, message);
+
+ setLines(beginLine, endLine);
+ }
+
+ public ApexRuleViolation(Rule rule, RuleContext ctx, Node node, String message) {
+ super(rule, ctx, node, message);
+
+ if (node != null) {
+ if (!suppressed) {
+ suppressed = isSupressed(node, getRule());
+ }
+ }
+ }
+
+ /**
+ * Check for suppression on this node, on parents, and on contained types
+ * for ASTCompilationUnit
+ *
+ * @param node
+ */
+ public static boolean isSupressed(Node node, Rule rule) {
+ boolean result = suppresses(node, rule);
+
+ if (!result) {
+ Node parent = node.jjtGetParent();
+ while (!result && parent != null) {
+ result = suppresses(parent, rule);
+ parent = parent.jjtGetParent();
+ }
+ }
+
+ return result;
+ }
+
+ private static boolean suppresses(final Node node, Rule rule) {
+ return node instanceof CanSuppressWarnings
+ && ((CanSuppressWarnings) node).hasSuppressWarningsAnnotationFor(rule);
+ }
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/ApexRuleViolationFactory.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/ApexRuleViolationFactory.java
index 30fa90df4aa..1fd6ed544ae 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/ApexRuleViolationFactory.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/ApexRuleViolationFactory.java
@@ -7,10 +7,8 @@
import net.sourceforge.pmd.Rule;
import net.sourceforge.pmd.RuleContext;
import net.sourceforge.pmd.RuleViolation;
-import net.sourceforge.pmd.lang.apex.ast.ApexNode;
import net.sourceforge.pmd.lang.ast.Node;
import net.sourceforge.pmd.lang.rule.AbstractRuleViolationFactory;
-import net.sourceforge.pmd.lang.rule.ParametricRuleViolation;
public final class ApexRuleViolationFactory extends AbstractRuleViolationFactory {
@@ -22,11 +20,13 @@ private ApexRuleViolationFactory() {
@SuppressWarnings("rawtypes")
@Override
protected RuleViolation createRuleViolation(Rule rule, RuleContext ruleContext, Node node, String message) {
- return new ParametricRuleViolation<>(rule, ruleContext, (ApexNode) node, message);
+ return new ApexRuleViolation<>(rule, ruleContext, node, message);
}
+ @Override
+ @SuppressWarnings("rawtypes")
protected RuleViolation createRuleViolation(Rule rule, RuleContext ruleContext, Node node, String message,
int beginLine, int endLine) {
- return null; // FIXME
+ return new ApexRuleViolation(rule, ruleContext, node, message, beginLine, endLine);
}
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/apexunit/ApexUnitTestClassShouldHaveAssertsRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/bestpractices/ApexUnitTestClassShouldHaveAssertsRule.java
similarity index 91%
rename from pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/apexunit/ApexUnitTestClassShouldHaveAssertsRule.java
rename to pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/bestpractices/ApexUnitTestClassShouldHaveAssertsRule.java
index 4ee76cab83a..76e6023fd6b 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/apexunit/ApexUnitTestClassShouldHaveAssertsRule.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/bestpractices/ApexUnitTestClassShouldHaveAssertsRule.java
@@ -2,11 +2,12 @@
* BSD-style license; for more info see http://pmd.sourceforge.net/license.html
*/
-package net.sourceforge.pmd.lang.apex.rule.apexunit;
+package net.sourceforge.pmd.lang.apex.rule.bestpractices;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
+import java.util.Locale;
import java.util.Set;
import net.sourceforge.pmd.lang.apex.ast.ASTBlockStatement;
@@ -14,6 +15,7 @@
import net.sourceforge.pmd.lang.apex.ast.ASTMethodCallExpression;
import net.sourceforge.pmd.lang.apex.ast.ASTStatement;
import net.sourceforge.pmd.lang.apex.ast.ApexNode;
+import net.sourceforge.pmd.lang.apex.rule.AbstractApexUnitTestRule;
/**
* Apex unit tests should have System.assert methods in them
@@ -50,7 +52,7 @@ private Object checkForAssertStatements(ApexNode<?> node, Object data) {
boolean isAssertFound = false;
for (final ASTMethodCallExpression methodCallExpression : methodCalls) {
- if (ASSERT_METHODS.contains(methodCallExpression.getFullMethodName().toLowerCase())) {
+ if (ASSERT_METHODS.contains(methodCallExpression.getFullMethodName().toLowerCase(Locale.ROOT))) {
isAssertFound = true;
break;
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/apexunit/ApexUnitTestShouldNotUseSeeAllDataTrueRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/bestpractices/ApexUnitTestShouldNotUseSeeAllDataTrueRule.java
similarity index 81%
rename from pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/apexunit/ApexUnitTestShouldNotUseSeeAllDataTrueRule.java
rename to pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/bestpractices/ApexUnitTestShouldNotUseSeeAllDataTrueRule.java
index 23137470c9d..38788da4666 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/apexunit/ApexUnitTestShouldNotUseSeeAllDataTrueRule.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/bestpractices/ApexUnitTestShouldNotUseSeeAllDataTrueRule.java
@@ -2,17 +2,19 @@
* BSD-style license; for more info see http://pmd.sourceforge.net/license.html
*/
-package net.sourceforge.pmd.lang.apex.rule.apexunit;
+package net.sourceforge.pmd.lang.apex.rule.bestpractices;
import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
import net.sourceforge.pmd.lang.apex.ast.ASTModifierNode;
import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
import net.sourceforge.pmd.lang.apex.ast.ApexNode;
+import net.sourceforge.pmd.lang.apex.rule.AbstractApexUnitTestRule;
import apex.jorje.semantic.ast.modifier.Annotation;
import apex.jorje.semantic.ast.modifier.AnnotationParameter;
import apex.jorje.semantic.ast.modifier.ModifierOrAnnotation;
import apex.jorje.semantic.symbol.type.AnnotationTypeInfos;
+import apex.jorje.semantic.symbol.type.ModifierOrAnnotationTypeInfo;
import apex.jorje.semantic.symbol.type.TypeInfoEquivalence;
import apex.jorje.services.Version;
@@ -54,9 +56,10 @@ private Object checkForSeeAllData(final ApexNode<?> node, final Object data) {
final ASTModifierNode modifierNode = node.getFirstChildOfType(ASTModifierNode.class);
if (modifierNode != null) {
- for (final ModifierOrAnnotation modifierOrAnnotation : modifierNode.getNode().getModifiers().allNodes()) {
+ for (final ModifierOrAnnotationTypeInfo modifierOrAnnotationTypeInfo : modifierNode.getNode().getModifiers().all()) {
+ ModifierOrAnnotation modifierOrAnnotation = modifierNode.getNode().getModifiers().get(modifierOrAnnotationTypeInfo);
if (modifierOrAnnotation instanceof Annotation && TypeInfoEquivalence
- .isEquivalent(modifierOrAnnotation.getType(), AnnotationTypeInfos.IS_TEST)) {
+ .isEquivalent(modifierOrAnnotationTypeInfo, AnnotationTypeInfos.IS_TEST)) {
final Annotation annotation = (Annotation) modifierOrAnnotation;
final AnnotationParameter parameter = annotation.getParameter("seeAllData");
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/bestpractices/AvoidGlobalModifierRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/bestpractices/AvoidGlobalModifierRule.java
new file mode 100644
index 00000000000..9d583e7f0c8
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/bestpractices/AvoidGlobalModifierRule.java
@@ -0,0 +1,75 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.bestpractices;
+
+import java.util.List;
+
+import net.sourceforge.pmd.lang.apex.ast.ASTAnnotation;
+import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
+import net.sourceforge.pmd.lang.apex.ast.ASTModifierNode;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserInterface;
+import net.sourceforge.pmd.lang.apex.ast.ApexNode;
+import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
+
+import apex.jorje.semantic.symbol.type.ModifierTypeInfos;
+
+public class AvoidGlobalModifierRule extends AbstractApexRule {
+
+ public AvoidGlobalModifierRule() {
+ setProperty(CODECLIMATE_CATEGORIES, "Style");
+ setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 100);
+ setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
+ }
+
+ @Override
+ public Object visit(ASTUserClass node, Object data) {
+ return checkForGlobal(node, data);
+ }
+
+ @Override
+ public Object visit(ASTUserInterface node, Object data) {
+ return checkForGlobal(node, data);
+ }
+
+ private Object checkForGlobal(ApexNode<?> node, Object data) {
+ ASTModifierNode modifierNode = node.getFirstChildOfType(ASTModifierNode.class);
+
+ if (isGlobal(modifierNode) && !hasRestAnnotation(modifierNode) && !hasWebServices(node)) {
+ addViolation(data, node);
+ }
+
+ return data;
+ }
+
+ private boolean hasWebServices(ApexNode<?> node) {
+ List<ASTMethod> methods = node.findChildrenOfType(ASTMethod.class);
+ for (ASTMethod method : methods) {
+ ASTModifierNode methodModifier = method.getFirstChildOfType(ASTModifierNode.class);
+ if (isWebService(methodModifier)) {
+ return true;
+ }
+ }
+ return false;
+ }
+
+ private boolean isWebService(ASTModifierNode modifierNode) {
+ return modifierNode != null && modifierNode.getNode().getModifiers().has(ModifierTypeInfos.WEB_SERVICE);
+ }
+
+ private boolean isGlobal(ASTModifierNode modifierNode) {
+ return modifierNode != null && modifierNode.getNode().getModifiers().has(ModifierTypeInfos.GLOBAL);
+ }
+
+ private boolean hasRestAnnotation(ASTModifierNode modifierNode) {
+ List<ASTAnnotation> annotations = modifierNode.findChildrenOfType(ASTAnnotation.class);
+ for (ASTAnnotation annotation : annotations) {
+ if (annotation.hasImageEqualTo("RestResource")) {
+ return true;
+ }
+ }
+ return false;
+ }
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/style/AvoidLogicInTriggerRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/bestpractices/AvoidLogicInTriggerRule.java
similarity index 93%
rename from pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/style/AvoidLogicInTriggerRule.java
rename to pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/bestpractices/AvoidLogicInTriggerRule.java
index c282ca9e68b..3d74db85c07 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/style/AvoidLogicInTriggerRule.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/bestpractices/AvoidLogicInTriggerRule.java
@@ -2,7 +2,7 @@
* BSD-style license; for more info see http://pmd.sourceforge.net/license.html
*/
-package net.sourceforge.pmd.lang.apex.rule.style;
+package net.sourceforge.pmd.lang.apex.rule.bestpractices;
import java.util.List;
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/codestyle/ClassNamingConventionsRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/codestyle/ClassNamingConventionsRule.java
new file mode 100644
index 00000000000..433acc7fe30
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/codestyle/ClassNamingConventionsRule.java
@@ -0,0 +1,35 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.codestyle;
+
+import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserInterface;
+import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
+
+public class ClassNamingConventionsRule extends AbstractApexRule {
+
+ public ClassNamingConventionsRule() {
+ setProperty(CODECLIMATE_CATEGORIES, "Style");
+ // Note: x10 as Apex has not automatic refactoring
+ setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 5);
+ setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
+ }
+
+ @Override
+ public Object visit(ASTUserClass node, Object data) {
+ if (Character.isLowerCase(node.getImage().charAt(0))) {
+ addViolation(data, node);
+ }
+ return data;
+ }
+
+ @Override
+ public Object visit(ASTUserInterface node, Object data) {
+ if (Character.isLowerCase(node.getImage().charAt(0))) {
+ addViolation(data, node);
+ }
+ return data;
+ }
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/codestyle/MethodNamingConventionsRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/codestyle/MethodNamingConventionsRule.java
new file mode 100644
index 00000000000..7192e57900d
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/codestyle/MethodNamingConventionsRule.java
@@ -0,0 +1,56 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.codestyle;
+
+import static apex.jorje.semantic.symbol.type.ModifierTypeInfos.OVERRIDE;
+
+import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
+import net.sourceforge.pmd.lang.apex.ast.ASTProperty;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
+import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
+
+public class MethodNamingConventionsRule extends AbstractApexRule {
+
+ public MethodNamingConventionsRule() {
+ setProperty(CODECLIMATE_CATEGORIES, "Style");
+ // Note: x10 as Apex has not automatic refactoring
+ setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 1);
+ setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
+ }
+
+ @Override
+ public Object visit(ASTUserClass node, Object data) {
+ return super.visit(node, data);
+ }
+
+ @Override
+ public Object visit(ASTMethod node, Object data) {
+ if (isOverriddenMethod(node) || isPropertyAccessor(node) || isConstructor(node)) {
+ return data;
+ }
+
+ String methodName = node.getImage();
+
+ if (Character.isUpperCase(methodName.charAt(0))) {
+ addViolationWithMessage(data, node, "Method names should not start with capital letters");
+ }
+ if (methodName.indexOf('_') >= 0) {
+ addViolationWithMessage(data, node, "Method names should not contain underscores");
+ }
+ return data;
+ }
+
+ private boolean isOverriddenMethod(ASTMethod node) {
+ return node.getNode().getModifiers().has(OVERRIDE);
+ }
+
+ private boolean isPropertyAccessor(ASTMethod node) {
+ return !node.getParentsOfType(ASTProperty.class).isEmpty();
+ }
+
+ private boolean isConstructor(ASTMethod node) {
+ return node.getNode().getMethodInfo().isConstructor();
+ }
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/codestyle/VariableNamingConventionsRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/codestyle/VariableNamingConventionsRule.java
new file mode 100644
index 00000000000..ec189d0ebca
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/codestyle/VariableNamingConventionsRule.java
@@ -0,0 +1,229 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.codestyle;
+
+import static apex.jorje.semantic.symbol.type.ModifierTypeInfos.FINAL;
+import static apex.jorje.semantic.symbol.type.ModifierTypeInfos.STATIC;
+
+import java.util.List;
+import java.util.Locale;
+
+import net.sourceforge.pmd.lang.apex.ast.ASTField;
+import net.sourceforge.pmd.lang.apex.ast.ASTParameter;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserInterface;
+import net.sourceforge.pmd.lang.apex.ast.ASTVariableDeclaration;
+import net.sourceforge.pmd.lang.apex.ast.ApexNode;
+import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
+import net.sourceforge.pmd.properties.BooleanProperty;
+import net.sourceforge.pmd.properties.PropertyDescriptor;
+import net.sourceforge.pmd.properties.StringMultiProperty;
+
+public class VariableNamingConventionsRule extends AbstractApexRule {
+
+ private boolean checkMembers;
+ private boolean checkLocals;
+ private boolean checkParameters;
+ private List<String> staticPrefixes;
+ private List<String> staticSuffixes;
+ private List<String> memberPrefixes;
+ private List<String> memberSuffixes;
+ private List<String> localPrefixes;
+ private List<String> localSuffixes;
+ private List<String> parameterPrefixes;
+ private List<String> parameterSuffixes;
+
+ private static final BooleanProperty CHECK_MEMBERS_DESCRIPTOR = new BooleanProperty("checkMembers",
+ "Check member variables", true, 1.0f);
+
+ private static final BooleanProperty CHECK_LOCALS_DESCRIPTOR = new BooleanProperty("checkLocals",
+ "Check local variables", true, 2.0f);
+
+ private static final BooleanProperty CHECK_PARAMETERS_DESCRIPTOR = new BooleanProperty("checkParameters",
+ "Check constructor and method parameter variables", true, 3.0f);
+
+ private static final StringMultiProperty STATIC_PREFIXES_DESCRIPTOR = new StringMultiProperty("staticPrefix",
+ "Static variable prefixes", new String[] { "" }, 4.0f, ',');
+
+ private static final StringMultiProperty STATIC_SUFFIXES_DESCRIPTOR = new StringMultiProperty("staticSuffix",
+ "Static variable suffixes", new String[] { "" }, 5.0f, ',');
+
+ private static final StringMultiProperty MEMBER_PREFIXES_DESCRIPTOR = new StringMultiProperty("memberPrefix",
+ "Member variable prefixes", new String[] { "" }, 6.0f, ',');
+
+ private static final StringMultiProperty MEMBER_SUFFIXES_DESCRIPTOR = new StringMultiProperty("memberSuffix",
+ "Member variable suffixes", new String[] { "" }, 7.0f, ',');
+
+ private static final StringMultiProperty LOCAL_PREFIXES_DESCRIPTOR = new StringMultiProperty("localPrefix",
+ "Local variable prefixes", new String[] { "" }, 8.0f, ',');
+
+ private static final StringMultiProperty LOCAL_SUFFIXES_DESCRIPTOR = new StringMultiProperty("localSuffix",
+ "Local variable suffixes", new String[] { "" }, 9.0f, ',');
+
+ private static final StringMultiProperty PARAMETER_PREFIXES_DESCRIPTOR = new StringMultiProperty("parameterPrefix",
+ "Method parameter variable prefixes", new String[] { "" }, 10.0f, ',');
+
+ private static final StringMultiProperty PARAMETER_SUFFIXES_DESCRIPTOR = new StringMultiProperty("parameterSuffix",
+ "Method parameter variable suffixes", new String[] { "" }, 11.0f, ',');
+
+ public VariableNamingConventionsRule() {
+ definePropertyDescriptor(CHECK_MEMBERS_DESCRIPTOR);
+ definePropertyDescriptor(CHECK_LOCALS_DESCRIPTOR);
+ definePropertyDescriptor(CHECK_PARAMETERS_DESCRIPTOR);
+ definePropertyDescriptor(STATIC_PREFIXES_DESCRIPTOR);
+ definePropertyDescriptor(STATIC_SUFFIXES_DESCRIPTOR);
+ definePropertyDescriptor(MEMBER_PREFIXES_DESCRIPTOR);
+ definePropertyDescriptor(MEMBER_SUFFIXES_DESCRIPTOR);
+ definePropertyDescriptor(LOCAL_PREFIXES_DESCRIPTOR);
+ definePropertyDescriptor(LOCAL_SUFFIXES_DESCRIPTOR);
+ definePropertyDescriptor(PARAMETER_PREFIXES_DESCRIPTOR);
+ definePropertyDescriptor(PARAMETER_SUFFIXES_DESCRIPTOR);
+
+ setProperty(CODECLIMATE_CATEGORIES, "Style");
+ // Note: x10 as Apex has not automatic refactoring
+ setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 5);
+ setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
+ }
+
+ @Override
+ public Object visit(ASTUserClass node, Object data) {
+ init();
+ return super.visit(node, data);
+ }
+
+ @Override
+ public Object visit(ASTUserInterface node, Object data) {
+ init();
+ return super.visit(node, data);
+ }
+
+ protected void init() {
+ checkMembers = getProperty(CHECK_MEMBERS_DESCRIPTOR);
+ checkLocals = getProperty(CHECK_LOCALS_DESCRIPTOR);
+ checkParameters = getProperty(CHECK_PARAMETERS_DESCRIPTOR);
+ staticPrefixes = getProperty(STATIC_PREFIXES_DESCRIPTOR);
+ staticSuffixes = getProperty(STATIC_SUFFIXES_DESCRIPTOR);
+ memberPrefixes = getProperty(MEMBER_PREFIXES_DESCRIPTOR);
+ memberSuffixes = getProperty(MEMBER_SUFFIXES_DESCRIPTOR);
+ localPrefixes = getProperty(LOCAL_PREFIXES_DESCRIPTOR);
+ localSuffixes = getProperty(LOCAL_SUFFIXES_DESCRIPTOR);
+ parameterPrefixes = getProperty(PARAMETER_PREFIXES_DESCRIPTOR);
+ parameterSuffixes = getProperty(PARAMETER_SUFFIXES_DESCRIPTOR);
+ }
+
+ @Override
+ public Object visit(ASTField node, Object data) {
+ if (!checkMembers) {
+ return data;
+ }
+ boolean isStatic = node.getNode().getFieldInfo().getModifiers().has(STATIC);
+ boolean isFinal = node.getNode().getFieldInfo().getModifiers().has(FINAL);
+
+ return checkName(isStatic ? staticPrefixes : memberPrefixes, isStatic ? staticSuffixes : memberSuffixes, node,
+ isStatic, isFinal, data);
+ }
+
+ @Override
+ public Object visit(ASTVariableDeclaration node, Object data) {
+
+ if (!checkLocals) {
+ return data;
+ }
+
+ boolean isFinal = node.getNode().getLocalInfo().getModifiers().has(FINAL);
+ return checkName(localPrefixes, localSuffixes, node, false, isFinal, data);
+ }
+
+ @Override
+ public Object visit(ASTParameter node, Object data) {
+ if (!checkParameters) {
+ return data;
+ }
+
+ boolean isFinal = node.getNode().getModifierInfo().has(FINAL);
+ return checkName(parameterPrefixes, parameterSuffixes, node, false, isFinal, data);
+ }
+
+ private Object checkName(List<String> prefixes, List<String> suffixes, ApexNode<?> node, boolean isStatic, boolean isFinal,
+ Object data) {
+
+ String varName = node.getImage();
+
+ // Skip on null (with exception classes) and serialVersionUID
+ if (varName == null || "serialVersionUID".equals(varName)) {
+ return data;
+ }
+
+ // Static finals should be uppercase
+ if (isStatic && isFinal) {
+ if (!varName.equals(varName.toUpperCase(Locale.ROOT))) {
+ addViolationWithMessage(data, node,
+ "Variables that are final and static should be all capitals, ''{0}'' is not all capitals.",
+ new Object[] { varName });
+ }
+ return data;
+ } else if (!isFinal) {
+ String normalizedVarName = normalizeVariableName(varName, prefixes, suffixes);
+
+ if (normalizedVarName.indexOf('_') >= 0) {
+ addViolationWithMessage(data, node,
+ "Only variables that are final should contain underscores (except for underscores in standard prefix/suffix), ''{0}'' is not final.",
+ new Object[] { varName });
+ }
+ if (Character.isUpperCase(varName.charAt(0))) {
+ addViolationWithMessage(data, node,
+ "Variables should start with a lowercase character, ''{0}'' starts with uppercase character.",
+ new Object[] { varName });
+ }
+ }
+ return data;
+ }
+
+ private String normalizeVariableName(String varName, List<String> prefixes, List<String> suffixes) {
+ return stripSuffix(stripPrefix(varName, prefixes), suffixes);
+ }
+
+ private String stripSuffix(String varName, List<String> suffixes) {
+ if (suffixes != null) {
+ for (String suffix : suffixes) {
+ if (varName.endsWith(suffix)) {
+ varName = varName.substring(0, varName.length() - suffix.length());
+ break;
+ }
+ }
+ }
+ return varName;
+ }
+
+ private String stripPrefix(String varName, List<String> prefixes) {
+ if (prefixes != null) {
+ for (String prefix : prefixes) {
+ if (varName.startsWith(prefix)) {
+ return varName.substring(prefix.length());
+ }
+ }
+ }
+ return varName;
+ }
+
+ public boolean hasPrefixesOrSuffixes() {
+
+ for (PropertyDescriptor<?> desc : getPropertyDescriptors()) {
+ if (desc instanceof StringMultiProperty) {
+ List<String> values = getProperty((StringMultiProperty) desc);
+ if (!values.isEmpty()) {
+ return true;
+ }
+ }
+ }
+ return false;
+ }
+
+ @Override
+ public String dysfunctionReason() {
+ return hasPrefixesOrSuffixes() ? null : "No prefixes or suffixes specified";
+ }
+
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/AbstractNcssCountRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/AbstractNcssCountRule.java
deleted file mode 100644
index e1bcf2b59af..00000000000
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/AbstractNcssCountRule.java
+++ /dev/null
@@ -1,164 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.rule.complexity;
-
-import net.sourceforge.pmd.lang.apex.ast.ASTBreakStatement;
-import net.sourceforge.pmd.lang.apex.ast.ASTContinueStatement;
-import net.sourceforge.pmd.lang.apex.ast.ASTDoLoopStatement;
-import net.sourceforge.pmd.lang.apex.ast.ASTForEachStatement;
-import net.sourceforge.pmd.lang.apex.ast.ASTForLoopStatement;
-import net.sourceforge.pmd.lang.apex.ast.ASTIfBlockStatement;
-import net.sourceforge.pmd.lang.apex.ast.ASTIfElseBlockStatement;
-import net.sourceforge.pmd.lang.apex.ast.ASTMethodCallExpression;
-import net.sourceforge.pmd.lang.apex.ast.ASTReturnStatement;
-import net.sourceforge.pmd.lang.apex.ast.ASTStatement;
-import net.sourceforge.pmd.lang.apex.ast.ASTThrowStatement;
-import net.sourceforge.pmd.lang.apex.ast.ASTTryCatchFinallyBlockStatement;
-import net.sourceforge.pmd.lang.apex.ast.ASTWhileLoopStatement;
-import net.sourceforge.pmd.lang.apex.ast.ApexNode;
-import net.sourceforge.pmd.lang.apex.rule.AbstractStatisticalApexRule;
-import net.sourceforge.pmd.lang.ast.Node;
-import net.sourceforge.pmd.stat.DataPoint;
-import net.sourceforge.pmd.util.NumericConstants;
-
-/**
- * Abstract superclass for NCSS counting methods. Counts tokens according to
- * <a href="http://www.kclee.de/clemens/java/javancss/">JavaNCSS rules</a>.
- *
- * @author ported from Java original of Jason Bennett
- */
-public abstract class AbstractNcssCountRule extends AbstractStatisticalApexRule {
-
- private Class<?> nodeClass;
-
- /**
- * Count the nodes of the given type using NCSS rules.
- *
- * @param nodeClass
- * class of node to count
- */
- protected AbstractNcssCountRule(Class<?> nodeClass) {
- this.nodeClass = nodeClass;
-
- setProperty(MINIMUM_DESCRIPTOR, 1000d);
- setProperty(CODECLIMATE_CATEGORIES, "Complexity");
- setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 100);
- setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
- }
-
- @Override
- public Object visit(ApexNode<?> node, Object data) {
- int numNodes = 0;
-
- for (int i = 0; i < node.jjtGetNumChildren(); i++) {
- ApexNode<?> n = (ApexNode<?>) node.jjtGetChild(i);
- Integer treeSize = (Integer) n.jjtAccept(this, data);
- numNodes += treeSize.intValue();
- }
-
- if (this.nodeClass.isInstance(node)) {
- // Add 1 to account for base node
- numNodes++;
- DataPoint point = new DataPoint();
- point.setNode(node);
- point.setScore(1.0 * numNodes);
- point.setMessage(getMessage());
- addDataPoint(point);
- }
-
- return Integer.valueOf(numNodes);
- }
-
- /**
- * Count the number of children of the given node. Adds one to count the
- * node itself.
- *
- * @param node
- * node having children counted
- * @param data
- * node data
- * @return count of the number of children of the node, plus one
- */
- protected Integer countNodeChildren(Node node, Object data) {
- Integer nodeCount;
- int lineCount = 0;
- for (int i = 0; i < node.jjtGetNumChildren(); i++) {
- nodeCount = (Integer) ((ApexNode<?>) node.jjtGetChild(i)).jjtAccept(this, data);
- lineCount += nodeCount.intValue();
- }
- return ++lineCount;
- }
-
- @Override
- public Object visit(ASTForLoopStatement node, Object data) {
- return countNodeChildren(node, data);
- }
-
- @Override
- public Object visit(ASTForEachStatement node, Object data) {
- return countNodeChildren(node, data);
- }
-
- @Override
- public Object visit(ASTDoLoopStatement node, Object data) {
- return countNodeChildren(node, data);
- }
-
- @Override
- public Object visit(ASTIfBlockStatement node, Object data) {
-
- Integer lineCount = countNodeChildren(node, data);
- return lineCount;
- }
-
- @Override
- public Object visit(ASTIfElseBlockStatement node, Object data) {
-
- Integer lineCount = countNodeChildren(node, data);
- lineCount++;
-
- return lineCount;
- }
-
- @Override
- public Object visit(ASTWhileLoopStatement node, Object data) {
- return countNodeChildren(node, data);
- }
-
- @Override
- public Object visit(ASTBreakStatement node, Object data) {
- return NumericConstants.ONE;
- }
-
- @Override
- public Object visit(ASTTryCatchFinallyBlockStatement node, Object data) {
- return countNodeChildren(node, data);
- }
-
- @Override
- public Object visit(ASTContinueStatement node, Object data) {
- return NumericConstants.ONE;
- }
-
- @Override
- public Object visit(ASTReturnStatement node, Object data) {
- return countNodeChildren(node, data);
- }
-
- @Override
- public Object visit(ASTThrowStatement node, Object data) {
- return countNodeChildren(node, data);
- }
-
- @Override
- public Object visit(ASTStatement node, Object data) {
- return NumericConstants.ONE;
- }
-
- @Override
- public Object visit(ASTMethodCallExpression node, Object data) {
- return NumericConstants.ONE;
- }
-}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/AvoidDeeplyNestedIfStmtsRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/AvoidDeeplyNestedIfStmtsRule.java
deleted file mode 100644
index 8c657d2f44b..00000000000
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/AvoidDeeplyNestedIfStmtsRule.java
+++ /dev/null
@@ -1,47 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.rule.complexity;
-
-import net.sourceforge.pmd.lang.apex.ast.ASTIfBlockStatement;
-import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
-import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
-import net.sourceforge.pmd.properties.IntegerProperty;
-
-public class AvoidDeeplyNestedIfStmtsRule extends AbstractApexRule {
-
- private int depth;
- private int depthLimit;
-
- private static final IntegerProperty PROBLEM_DEPTH_DESCRIPTOR = new IntegerProperty("problemDepth",
- "The if statement depth reporting threshold", 1, 25, 3, 1.0f);
-
- public AvoidDeeplyNestedIfStmtsRule() {
- definePropertyDescriptor(PROBLEM_DEPTH_DESCRIPTOR);
-
- setProperty(CODECLIMATE_CATEGORIES, "Complexity");
- // Note: Remedy needs better OO design and therefore high effort
- setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 200);
- setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
- }
-
- public Object visit(ASTUserClass node, Object data) {
- depth = 0;
- depthLimit = getProperty(PROBLEM_DEPTH_DESCRIPTOR);
-
- return super.visit(node, data);
- }
-
- public Object visit(ASTIfBlockStatement node, Object data) {
- depth++;
-
- super.visit(node, data);
- if (depth == depthLimit) {
- addViolation(data, node);
- }
- depth--;
-
- return data;
- }
-}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/ExcessiveClassLengthRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/ExcessiveClassLengthRule.java
deleted file mode 100644
index 66961ef5341..00000000000
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/ExcessiveClassLengthRule.java
+++ /dev/null
@@ -1,33 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.rule.complexity;
-
-import static apex.jorje.semantic.symbol.type.AnnotationTypeInfos.IS_TEST;
-
-import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
-
-/**
- * This rule detects when a class exceeds a certain threshold. i.e. if a class
- * has more than 1000 lines of code.
- */
-public class ExcessiveClassLengthRule extends ExcessiveLengthRule {
- public ExcessiveClassLengthRule() {
- super(ASTUserClass.class);
- setProperty(MINIMUM_DESCRIPTOR, 1000d);
-
- setProperty(CODECLIMATE_CATEGORIES, "Complexity");
- setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 150);
- setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
- }
-
- @Override
- public Object visit(ASTUserClass node, Object data) {
- if (node.getNode().getModifiers().getModifiers().not(IS_TEST)) {
- return super.visit(node, data);
- }
-
- return data;
- }
-}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/ExcessiveParameterListRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/ExcessiveParameterListRule.java
deleted file mode 100644
index 08f6abd87b9..00000000000
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/ExcessiveParameterListRule.java
+++ /dev/null
@@ -1,28 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.rule.complexity;
-
-import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
-import net.sourceforge.pmd.lang.apex.ast.ASTParameter;
-import net.sourceforge.pmd.util.NumericConstants;
-
-/**
- * This rule detects an abnormally long parameter list. Note: This counts Nodes,
- * and not necessarily parameters, so the numbers may not match up. (But
- * topcount and sigma should work.)
- */
-public class ExcessiveParameterListRule extends ExcessiveNodeCountRule {
- public ExcessiveParameterListRule() {
- super(ASTMethod.class);
- setProperty(MINIMUM_DESCRIPTOR, 4d);
- setProperty(CODECLIMATE_CATEGORIES, "Complexity");
- setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 50);
- setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
- }
-
- public Object visit(ASTParameter node, Object data) {
- return NumericConstants.ONE;
- }
-}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/ExcessivePublicCountRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/ExcessivePublicCountRule.java
deleted file mode 100644
index 1da2781e3ea..00000000000
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/ExcessivePublicCountRule.java
+++ /dev/null
@@ -1,52 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.rule.complexity;
-
-import static apex.jorje.semantic.symbol.type.ModifierTypeInfos.PUBLIC;
-import static apex.jorje.semantic.symbol.type.ModifierTypeInfos.STATIC;
-
-import net.sourceforge.pmd.lang.apex.ast.ASTFieldDeclarationStatements;
-import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
-import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
-import net.sourceforge.pmd.util.NumericConstants;
-
-/**
- * Rule attempts to count all public methods and public attributes
- * defined in a class.
- *
- * <p>If a class has a high number of public operations, it might be wise
- * to consider whether it would be appropriate to divide it into
- * subclasses.</p>
- *
- * <p>A large proportion of public members and operations means the class
- * has high potential to be affected by external classes. Futhermore,
- * increased effort will be required to thoroughly test the class.</p>
- *
- * @author ported from Java original of aglover
- */
-public class ExcessivePublicCountRule extends ExcessiveNodeCountRule {
-
- public ExcessivePublicCountRule() {
- super(ASTUserClass.class);
- setProperty(MINIMUM_DESCRIPTOR, 20d);
- setProperty(CODECLIMATE_CATEGORIES, "Complexity");
- setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 150);
- setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
- }
-
- public Object visit(ASTMethod node, Object data) {
- if (node.getNode().getModifiers().has(PUBLIC) && !node.getImage().matches("<clinit>|<init>|clone")) {
- return NumericConstants.ONE;
- }
- return NumericConstants.ZERO;
- }
-
- public Object visit(ASTFieldDeclarationStatements node, Object data) {
- if (node.getNode().getModifiers().has(PUBLIC) && !node.getNode().getModifiers().has(STATIC)) {
- return NumericConstants.ONE;
- }
- return NumericConstants.ZERO;
- }
-}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/NcssConstructorCountRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/NcssConstructorCountRule.java
deleted file mode 100644
index 912e7688b94..00000000000
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/NcssConstructorCountRule.java
+++ /dev/null
@@ -1,43 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.rule.complexity;
-
-import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
-import net.sourceforge.pmd.stat.DataPoint;
-import net.sourceforge.pmd.util.NumericConstants;
-
-/**
- * Non-commented source statement counter for constructors.
- *
- * @author ported from Java original by Jason Bennett
- */
-public class NcssConstructorCountRule extends AbstractNcssCountRule {
-
- /**
- * Count constructor declarations. This includes any explicit super() calls.
- */
- public NcssConstructorCountRule() {
- super(ASTMethod.class);
- setProperty(MINIMUM_DESCRIPTOR, 20d);
- setProperty(CODECLIMATE_CATEGORIES, "Complexity");
- setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 50);
- setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
- }
-
- @Override
- public Object visit(ASTMethod node, Object data) {
- if (node.getNode().getMethodInfo().isConstructor()) {
- return super.visit(node, data);
- }
-
- return NumericConstants.ZERO;
- }
-
- @Override
- public Object[] getViolationParameters(DataPoint point) {
- // TODO need to put class name or constructor ID in string
- return new String[] { String.valueOf((int) point.getScore()) };
- }
-}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/NcssMethodCountRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/NcssMethodCountRule.java
deleted file mode 100644
index 19a3261ee38..00000000000
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/NcssMethodCountRule.java
+++ /dev/null
@@ -1,43 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.rule.complexity;
-
-import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
-import net.sourceforge.pmd.stat.DataPoint;
-import net.sourceforge.pmd.util.NumericConstants;
-
-/**
- * Non-commented source statement counter for methods.
- *
- * @author ported from Java original of Jason Bennett
- */
-public class NcssMethodCountRule extends AbstractNcssCountRule {
-
- /**
- * Count the size of all non-constructor methods.
- */
- public NcssMethodCountRule() {
- super(ASTMethod.class);
- setProperty(MINIMUM_DESCRIPTOR, 40d);
- setProperty(CODECLIMATE_CATEGORIES, "Complexity");
- setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 50);
- setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
- }
-
- @Override
- public Object visit(ASTMethod node, Object data) {
- if (!node.getNode().getMethodInfo().isConstructor()) {
- return super.visit(node, data);
- }
-
- return NumericConstants.ZERO;
- }
-
- @Override
- public Object[] getViolationParameters(DataPoint point) {
- return new String[] { ((ASTMethod) point.getNode()).getNode().getMethodInfo().getName(),
- String.valueOf((int) point.getScore()), };
- }
-}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/NcssTypeCountRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/NcssTypeCountRule.java
deleted file mode 100644
index 1d1fb9489ec..00000000000
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/NcssTypeCountRule.java
+++ /dev/null
@@ -1,77 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.rule.complexity;
-
-import net.sourceforge.pmd.lang.apex.ast.ASTFieldDeclaration;
-import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
-import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
-import net.sourceforge.pmd.lang.apex.ast.ASTUserEnum;
-import net.sourceforge.pmd.lang.apex.ast.ASTUserInterface;
-import net.sourceforge.pmd.stat.DataPoint;
-import net.sourceforge.pmd.util.NumericConstants;
-
-/**
- * Non-commented source statement counter for type declarations.
- *
- * @author ported from Java original of Jason Bennett
- */
-public class NcssTypeCountRule extends AbstractNcssCountRule {
-
- /**
- * Count type declarations. This includes classes as well as enums and
- * annotations.
- */
- public NcssTypeCountRule() {
- super(ASTUserClass.class);
- setProperty(MINIMUM_DESCRIPTOR, 500d);
- setProperty(CODECLIMATE_CATEGORIES, "Complexity");
- setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 250);
- setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
- }
-
- @Override
- public Object visit(ASTUserClass node, Object data) {
-
- if (!node.hasDecendantOfAnyType(ASTUserClass.class)) {
- return super.visit(node, data);
- }
-
- return countNodeChildren(node, data);
- }
-
- @Override
- public Object visit(ASTUserInterface node, Object data) {
-
- if (!node.hasDecendantOfAnyType(ASTUserClass.class)) {
- return super.visit(node, data);
- }
-
- return countNodeChildren(node, data);
- }
-
- @Override
- public Object visit(ASTUserEnum node, Object data) {
- return countNodeChildren(node, data);
- }
-
- @Override
- public Object visit(ASTMethod node, Object data) {
- if (!node.getImage().matches("<clinit>|<init>|clone")) {
- return countNodeChildren(node, data);
- }
-
- return NumericConstants.ZERO;
- }
-
- @Override
- public Object visit(ASTFieldDeclaration node, Object data) {
- return NumericConstants.ONE;
- }
-
- @Override
- public Object[] getViolationParameters(DataPoint point) {
- return new String[] { String.valueOf((int) point.getScore()) };
- }
-}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/StdCyclomaticComplexityRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/StdCyclomaticComplexityRule.java
deleted file mode 100644
index 2eabcf788a2..00000000000
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/StdCyclomaticComplexityRule.java
+++ /dev/null
@@ -1,214 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.rule.complexity;
-
-import java.util.Stack;
-
-import net.sourceforge.pmd.lang.apex.ast.ASTBooleanExpression;
-import net.sourceforge.pmd.lang.apex.ast.ASTDoLoopStatement;
-import net.sourceforge.pmd.lang.apex.ast.ASTForEachStatement;
-import net.sourceforge.pmd.lang.apex.ast.ASTForLoopStatement;
-import net.sourceforge.pmd.lang.apex.ast.ASTIfBlockStatement;
-import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
-import net.sourceforge.pmd.lang.apex.ast.ASTTernaryExpression;
-import net.sourceforge.pmd.lang.apex.ast.ASTTryCatchFinallyBlockStatement;
-import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
-import net.sourceforge.pmd.lang.apex.ast.ASTUserEnum;
-import net.sourceforge.pmd.lang.apex.ast.ASTUserInterface;
-import net.sourceforge.pmd.lang.apex.ast.ASTUserTrigger;
-import net.sourceforge.pmd.lang.apex.ast.ASTWhileLoopStatement;
-import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
-import net.sourceforge.pmd.lang.ast.Node;
-import net.sourceforge.pmd.properties.BooleanProperty;
-import net.sourceforge.pmd.properties.IntegerProperty;
-
-/**
- * Implements the standard cyclomatic complexity rule
- * <p>
- * Standard rules: +1 for each decision point, but not including boolean
- * operators unlike CyclomaticComplexityRule.
- *
- * @author ported on Java version of Alan Hohn, based on work by Donald A.
- * Leckie
- *
- * @since June 18, 2014
- */
-public class StdCyclomaticComplexityRule extends AbstractApexRule {
-
- public static final IntegerProperty REPORT_LEVEL_DESCRIPTOR = new IntegerProperty("reportLevel",
- "Cyclomatic Complexity reporting threshold", 1, 30, 10, 1.0f);
-
- public static final BooleanProperty SHOW_CLASSES_COMPLEXITY_DESCRIPTOR = new BooleanProperty(
- "showClassesComplexity", "Add class average violations to the report", true, 2.0f);
-
- public static final BooleanProperty SHOW_METHODS_COMPLEXITY_DESCRIPTOR = new BooleanProperty(
- "showMethodsComplexity", "Add method average violations to the report", true, 3.0f);
-
- private int reportLevel;
- private boolean showClassesComplexity = true;
- private boolean showMethodsComplexity = true;
-
- protected static class Entry {
- private int decisionPoints = 1;
- public int highestDecisionPoints;
- public int methodCount;
-
- private Entry(Node node) {
- }
-
- public void bumpDecisionPoints() {
- decisionPoints++;
- }
-
- public void bumpDecisionPoints(int size) {
- decisionPoints += size;
- }
-
- public int getComplexityAverage() {
- return (double) methodCount == 0 ? 1 : (int) Math.rint((double) decisionPoints / (double) methodCount);
- }
- }
-
- protected Stack<Entry> entryStack = new Stack<>();
-
- public StdCyclomaticComplexityRule() {
- definePropertyDescriptor(REPORT_LEVEL_DESCRIPTOR);
- definePropertyDescriptor(SHOW_CLASSES_COMPLEXITY_DESCRIPTOR);
- definePropertyDescriptor(SHOW_METHODS_COMPLEXITY_DESCRIPTOR);
-
- setProperty(CODECLIMATE_CATEGORIES, "Complexity");
- setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 250);
- setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
- }
-
- @Override
- public Object visit(ASTUserClass node, Object data) {
- reportLevel = getProperty(REPORT_LEVEL_DESCRIPTOR);
- showClassesComplexity = getProperty(SHOW_CLASSES_COMPLEXITY_DESCRIPTOR);
- showMethodsComplexity = getProperty(SHOW_METHODS_COMPLEXITY_DESCRIPTOR);
- entryStack.push(new Entry(node));
- super.visit(node, data);
- Entry classEntry = entryStack.pop();
- if (showClassesComplexity) {
- if (classEntry.getComplexityAverage() >= reportLevel || classEntry.highestDecisionPoints >= reportLevel) {
- addViolation(data, node, new String[] { "class", node.getImage(),
- classEntry.getComplexityAverage() + " (Highest = " + classEntry.highestDecisionPoints + ')', });
- }
- }
- return data;
- }
-
- @Override
- public Object visit(ASTUserTrigger node, Object data) {
- reportLevel = getProperty(REPORT_LEVEL_DESCRIPTOR);
- showClassesComplexity = getProperty(SHOW_CLASSES_COMPLEXITY_DESCRIPTOR);
- showMethodsComplexity = getProperty(SHOW_METHODS_COMPLEXITY_DESCRIPTOR);
- entryStack.push(new Entry(node));
- super.visit(node, data);
- Entry classEntry = entryStack.pop();
- if (showClassesComplexity) {
- if (classEntry.getComplexityAverage() >= reportLevel || classEntry.highestDecisionPoints >= reportLevel) {
- addViolation(data, node, new String[] { "trigger", node.getImage(),
- classEntry.getComplexityAverage() + " (Highest = " + classEntry.highestDecisionPoints + ')', });
- }
- }
- return data;
- }
-
- @Override
- public Object visit(ASTUserInterface node, Object data) {
- return data;
- }
-
- @Override
- public Object visit(ASTUserEnum node, Object data) {
- entryStack.push(new Entry(node));
- super.visit(node, data);
- Entry classEntry = entryStack.pop();
- if (classEntry.getComplexityAverage() >= reportLevel || classEntry.highestDecisionPoints >= reportLevel) {
- addViolation(data, node, new String[] { "class", node.getImage(),
- classEntry.getComplexityAverage() + "(Highest = " + classEntry.highestDecisionPoints + ')', });
- }
- return data;
- }
-
- @Override
- public Object visit(ASTMethod node, Object data) {
- if (!node.getImage().matches("<clinit>|<init>|clone")) {
- entryStack.push(new Entry(node));
- super.visit(node, data);
- Entry methodEntry = entryStack.pop();
- int methodDecisionPoints = methodEntry.decisionPoints;
- Entry classEntry = entryStack.peek();
- classEntry.methodCount++;
- classEntry.bumpDecisionPoints(methodDecisionPoints);
-
- if (methodDecisionPoints > classEntry.highestDecisionPoints) {
- classEntry.highestDecisionPoints = methodDecisionPoints;
- }
-
- if (showMethodsComplexity && methodEntry.decisionPoints >= reportLevel) {
- String methodType = (node.getNode().getMethodInfo().isConstructor()) ? "constructor" : "method";
- addViolation(data, node,
- new String[] { methodType, node.getImage(), String.valueOf(methodEntry.decisionPoints) });
- }
- }
- return data;
- }
-
- @Override
- public Object visit(ASTIfBlockStatement node, Object data) {
- entryStack.peek().bumpDecisionPoints();
- super.visit(node, data);
- return data;
- }
-
- @Override
- public Object visit(ASTTryCatchFinallyBlockStatement node, Object data) {
- entryStack.peek().bumpDecisionPoints();
- super.visit(node, data);
- return data;
- }
-
- @Override
- public Object visit(ASTForLoopStatement node, Object data) {
- entryStack.peek().bumpDecisionPoints();
- super.visit(node, data);
- return data;
- }
-
- @Override
- public Object visit(ASTForEachStatement node, Object data) {
- entryStack.peek().bumpDecisionPoints();
- super.visit(node, data);
- return data;
- }
-
- @Override
- public Object visit(ASTWhileLoopStatement node, Object data) {
- entryStack.peek().bumpDecisionPoints();
- super.visit(node, data);
- return data;
- }
-
- @Override
- public Object visit(ASTDoLoopStatement node, Object data) {
- entryStack.peek().bumpDecisionPoints();
- super.visit(node, data);
- return data;
- }
-
- @Override
- public Object visit(ASTTernaryExpression node, Object data) {
- entryStack.peek().bumpDecisionPoints();
- super.visit(node, data);
- return data;
- }
-
- @Override
- public Object visit(ASTBooleanExpression node, Object data) {
- return data;
- }
-}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/TooManyFieldsRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/TooManyFieldsRule.java
deleted file mode 100644
index d26e0521f32..00000000000
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/TooManyFieldsRule.java
+++ /dev/null
@@ -1,77 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.rule.complexity;
-
-import static apex.jorje.semantic.symbol.type.ModifierTypeInfos.FINAL;
-import static apex.jorje.semantic.symbol.type.ModifierTypeInfos.STATIC;
-
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-
-import net.sourceforge.pmd.lang.apex.ast.ASTField;
-import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
-import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
-import net.sourceforge.pmd.lang.ast.Node;
-import net.sourceforge.pmd.properties.IntegerProperty;
-import net.sourceforge.pmd.util.NumericConstants;
-
-public class TooManyFieldsRule extends AbstractApexRule {
-
- private static final int DEFAULT_MAXFIELDS = 15;
-
- private Map<String, Integer> stats;
- private Map<String, ASTUserClass> nodes;
-
- private static final IntegerProperty MAX_FIELDS_DESCRIPTOR = new IntegerProperty("maxfields",
- "Max allowable fields", 1, 300, DEFAULT_MAXFIELDS, 1.0f);
-
- public TooManyFieldsRule() {
- definePropertyDescriptor(MAX_FIELDS_DESCRIPTOR);
-
- setProperty(CODECLIMATE_CATEGORIES, "Complexity");
- setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 200);
- setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
- }
-
- @Override
- public Object visit(ASTUserClass node, Object data) {
-
- int maxFields = getProperty(MAX_FIELDS_DESCRIPTOR);
-
- stats = new HashMap<>(5);
- nodes = new HashMap<>(5);
-
- List<ASTField> l = node.findDescendantsOfType(ASTField.class);
-
- for (ASTField fd : l) {
- if (fd.getNode().getModifierInfo().all(FINAL, STATIC)) {
- continue;
- }
- ASTUserClass clazz = fd.getFirstParentOfType(ASTUserClass.class);
- if (clazz != null) {
- bumpCounterFor(clazz);
- }
- }
- for (Map.Entry<String, Integer> entry : stats.entrySet()) {
- int val = entry.getValue();
- Node n = nodes.get(entry.getKey());
- if (val > maxFields) {
- addViolation(data, n);
- }
- }
- return data;
- }
-
- private void bumpCounterFor(ASTUserClass clazz) {
- String key = clazz.getImage();
- if (!stats.containsKey(key)) {
- stats.put(key, NumericConstants.ZERO);
- nodes.put(key, clazz);
- }
- Integer i = Integer.valueOf(stats.get(key) + 1);
- stats.put(key, i);
- }
-}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/AbstractNcssCountRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/AbstractNcssCountRule.java
new file mode 100644
index 00000000000..80612b84e16
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/AbstractNcssCountRule.java
@@ -0,0 +1,162 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.design;
+
+import net.sourceforge.pmd.lang.apex.ast.ASTBreakStatement;
+import net.sourceforge.pmd.lang.apex.ast.ASTContinueStatement;
+import net.sourceforge.pmd.lang.apex.ast.ASTDoLoopStatement;
+import net.sourceforge.pmd.lang.apex.ast.ASTForEachStatement;
+import net.sourceforge.pmd.lang.apex.ast.ASTForLoopStatement;
+import net.sourceforge.pmd.lang.apex.ast.ASTIfBlockStatement;
+import net.sourceforge.pmd.lang.apex.ast.ASTIfElseBlockStatement;
+import net.sourceforge.pmd.lang.apex.ast.ASTMethodCallExpression;
+import net.sourceforge.pmd.lang.apex.ast.ASTReturnStatement;
+import net.sourceforge.pmd.lang.apex.ast.ASTStatement;
+import net.sourceforge.pmd.lang.apex.ast.ASTThrowStatement;
+import net.sourceforge.pmd.lang.apex.ast.ASTTryCatchFinallyBlockStatement;
+import net.sourceforge.pmd.lang.apex.ast.ASTWhileLoopStatement;
+import net.sourceforge.pmd.lang.apex.ast.AbstractApexNodeBase;
+import net.sourceforge.pmd.lang.apex.rule.AbstractStatisticalApexRule;
+import net.sourceforge.pmd.lang.ast.Node;
+import net.sourceforge.pmd.stat.DataPoint;
+import net.sourceforge.pmd.util.NumericConstants;
+
+/**
+ * Abstract superclass for NCSS counting methods. Counts tokens according to
+ * <a href="http://www.kclee.de/clemens/java/javancss/">JavaNCSS rules</a>.
+ *
+ * @author ported from Java original of Jason Bennett
+ */
+public abstract class AbstractNcssCountRule extends AbstractStatisticalApexRule {
+
+ private Class<?> nodeClass;
+
+ /**
+ * Count the nodes of the given type using NCSS rules.
+ *
+ * @param nodeClass
+ * class of node to count
+ */
+ protected AbstractNcssCountRule(Class<?> nodeClass) {
+ this.nodeClass = nodeClass;
+
+ setProperty(MINIMUM_DESCRIPTOR, 1000d);
+ setProperty(CODECLIMATE_CATEGORIES, "Complexity");
+ setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 100);
+ setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
+ }
+
+ @Override
+ public Object visit(AbstractApexNodeBase node, Object data) {
+ int numNodes = 0;
+
+ for (int i = 0; i < node.jjtGetNumChildren(); i++) {
+ AbstractApexNodeBase n = (AbstractApexNodeBase) node.jjtGetChild(i);
+ Integer treeSize = (Integer) n.jjtAccept(this, data);
+ numNodes += treeSize.intValue();
+ }
+
+ if (this.nodeClass.isInstance(node)) {
+ // Add 1 to account for base node
+ numNodes++;
+ DataPoint point = new DataPoint();
+ point.setNode(node);
+ point.setScore(1.0 * numNodes);
+ point.setMessage(getMessage());
+ addDataPoint(point);
+ }
+
+ return Integer.valueOf(numNodes);
+ }
+
+ /**
+ * Count the number of children of the given node. Adds one to count the
+ * node itself.
+ *
+ * @param node
+ * node having children counted
+ * @param data
+ * node data
+ * @return count of the number of children of the node, plus one
+ */
+ protected Integer countNodeChildren(Node node, Object data) {
+ Integer nodeCount;
+ int lineCount = 0;
+ for (int i = 0; i < node.jjtGetNumChildren(); i++) {
+ nodeCount = (Integer) ((AbstractApexNodeBase) node.jjtGetChild(i)).jjtAccept(this, data);
+ lineCount += nodeCount.intValue();
+ }
+ return ++lineCount;
+ }
+
+ @Override
+ public Object visit(ASTForLoopStatement node, Object data) {
+ return countNodeChildren(node, data);
+ }
+
+ @Override
+ public Object visit(ASTForEachStatement node, Object data) {
+ return countNodeChildren(node, data);
+ }
+
+ @Override
+ public Object visit(ASTDoLoopStatement node, Object data) {
+ return countNodeChildren(node, data);
+ }
+
+ @Override
+ public Object visit(ASTIfBlockStatement node, Object data) {
+ return countNodeChildren(node, data);
+ }
+
+ @Override
+ public Object visit(ASTIfElseBlockStatement node, Object data) {
+
+ Integer lineCount = countNodeChildren(node, data);
+ lineCount++;
+
+ return lineCount;
+ }
+
+ @Override
+ public Object visit(ASTWhileLoopStatement node, Object data) {
+ return countNodeChildren(node, data);
+ }
+
+ @Override
+ public Object visit(ASTBreakStatement node, Object data) {
+ return NumericConstants.ONE;
+ }
+
+ @Override
+ public Object visit(ASTTryCatchFinallyBlockStatement node, Object data) {
+ return countNodeChildren(node, data);
+ }
+
+ @Override
+ public Object visit(ASTContinueStatement node, Object data) {
+ return NumericConstants.ONE;
+ }
+
+ @Override
+ public Object visit(ASTReturnStatement node, Object data) {
+ return countNodeChildren(node, data);
+ }
+
+ @Override
+ public Object visit(ASTThrowStatement node, Object data) {
+ return countNodeChildren(node, data);
+ }
+
+ @Override
+ public Object visit(ASTStatement node, Object data) {
+ return NumericConstants.ONE;
+ }
+
+ @Override
+ public Object visit(ASTMethodCallExpression node, Object data) {
+ return NumericConstants.ONE;
+ }
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/AvoidDeeplyNestedIfStmtsRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/AvoidDeeplyNestedIfStmtsRule.java
new file mode 100644
index 00000000000..dc9e4d52d2d
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/AvoidDeeplyNestedIfStmtsRule.java
@@ -0,0 +1,51 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.design;
+
+import net.sourceforge.pmd.lang.apex.ast.ASTIfBlockStatement;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
+import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
+import net.sourceforge.pmd.properties.IntegerProperty;
+
+public class AvoidDeeplyNestedIfStmtsRule extends AbstractApexRule {
+
+ private int depth;
+ private int depthLimit;
+
+ private static final IntegerProperty PROBLEM_DEPTH_DESCRIPTOR
+ = IntegerProperty.named("problemDepth")
+ .desc("The if statement depth reporting threshold")
+ .range(1, 25).defaultValue(3).uiOrder(1.0f).build();
+
+ public AvoidDeeplyNestedIfStmtsRule() {
+ definePropertyDescriptor(PROBLEM_DEPTH_DESCRIPTOR);
+
+ setProperty(CODECLIMATE_CATEGORIES, "Complexity");
+ // Note: Remedy needs better OO design and therefore high effort
+ setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 200);
+ setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
+ }
+
+ @Override
+ public Object visit(ASTUserClass node, Object data) {
+ depth = 0;
+ depthLimit = getProperty(PROBLEM_DEPTH_DESCRIPTOR);
+
+ return super.visit(node, data);
+ }
+
+ @Override
+ public Object visit(ASTIfBlockStatement node, Object data) {
+ depth++;
+
+ super.visit(node, data);
+ if (depth == depthLimit) {
+ addViolation(data, node);
+ }
+ depth--;
+
+ return data;
+ }
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/CyclomaticComplexityRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/CyclomaticComplexityRule.java
new file mode 100644
index 00000000000..08b6c567c5a
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/CyclomaticComplexityRule.java
@@ -0,0 +1,104 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.design;
+
+
+import java.util.Stack;
+
+import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserTrigger;
+import net.sourceforge.pmd.lang.apex.metrics.ApexMetrics;
+import net.sourceforge.pmd.lang.apex.metrics.api.ApexClassMetricKey;
+import net.sourceforge.pmd.lang.apex.metrics.api.ApexOperationMetricKey;
+import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
+import net.sourceforge.pmd.lang.metrics.ResultOption;
+import net.sourceforge.pmd.properties.IntegerProperty;
+
+
+/**
+ * Cyclomatic complexity rule using metrics. Uses Wmc to report classes.
+ *
+ * @author Clément Fournier
+ */
+public class CyclomaticComplexityRule extends AbstractApexRule {
+
+ private static final IntegerProperty CLASS_LEVEL_DESCRIPTOR
+ = IntegerProperty.named("classReportLevel")
+ .desc("Total class complexity reporting threshold")
+ .range(1, 200)
+ .defaultValue(40)
+ .uiOrder(1.0f).build();
+
+ private static final IntegerProperty METHOD_LEVEL_DESCRIPTOR
+ = IntegerProperty.named("methodReportLevel")
+ .desc("Cyclomatic complexity reporting threshold")
+ .range(1, 30)
+ .defaultValue(10)
+ .uiOrder(2.0f).build();
+
+ private Stack<String> classNames = new Stack<>();
+ private boolean inTrigger;
+
+
+ public CyclomaticComplexityRule() {
+ definePropertyDescriptor(CLASS_LEVEL_DESCRIPTOR);
+ definePropertyDescriptor(METHOD_LEVEL_DESCRIPTOR);
+ }
+
+
+ @Override
+ public Object visit(ASTUserTrigger node, Object data) {
+ inTrigger = true;
+ super.visit(node, data);
+ inTrigger = false;
+ return data;
+ }
+
+
+ @Override
+ public Object visit(ASTUserClass node, Object data) {
+
+ classNames.push(node.getImage());
+ super.visit(node, data);
+ classNames.pop();
+
+ if (ApexClassMetricKey.WMC.supports(node)) {
+ int classWmc = (int) ApexMetrics.get(ApexClassMetricKey.WMC, node);
+
+ if (classWmc >= getProperty(CLASS_LEVEL_DESCRIPTOR)) {
+ int classHighest = (int) ApexMetrics.get(ApexOperationMetricKey.CYCLO, node, ResultOption.HIGHEST);
+
+ String[] messageParams = {"class",
+ node.getImage(),
+ " total",
+ classWmc + " (highest " + classHighest + ")", };
+
+ addViolation(data, node, messageParams);
+ }
+ }
+ return data;
+ }
+
+
+ @Override
+ public final Object visit(ASTMethod node, Object data) {
+
+ int cyclo = (int) ApexMetrics.get(ApexOperationMetricKey.CYCLO, node);
+ if (cyclo >= getProperty(METHOD_LEVEL_DESCRIPTOR)) {
+ String opType = inTrigger ? "trigger"
+ : node.getImage().equals(classNames.peek()) ? "constructor"
+ : "method";
+
+ addViolation(data, node, new String[]{opType,
+ node.getQualifiedName().getOperation(),
+ "",
+ "" + cyclo, });
+ }
+
+ return data;
+ }
+
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/ExcessiveClassLengthRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/ExcessiveClassLengthRule.java
new file mode 100644
index 00000000000..5bd4156c04b
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/ExcessiveClassLengthRule.java
@@ -0,0 +1,33 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.design;
+
+import static apex.jorje.semantic.symbol.type.AnnotationTypeInfos.IS_TEST;
+
+import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
+
+/**
+ * This rule detects when a class exceeds a certain threshold. i.e. if a class
+ * has more than 1000 lines of code.
+ */
+public class ExcessiveClassLengthRule extends ExcessiveLengthRule {
+ public ExcessiveClassLengthRule() {
+ super(ASTUserClass.class);
+ setProperty(MINIMUM_DESCRIPTOR, 1000d);
+
+ setProperty(CODECLIMATE_CATEGORIES, "Complexity");
+ setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 150);
+ setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
+ }
+
+ @Override
+ public Object visit(ASTUserClass node, Object data) {
+ if (node.getNode().getModifiers().getModifiers().not(IS_TEST)) {
+ return super.visit(node, data);
+ }
+
+ return data;
+ }
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/ExcessiveLengthRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/ExcessiveLengthRule.java
similarity index 80%
rename from pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/ExcessiveLengthRule.java
rename to pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/ExcessiveLengthRule.java
index 61930b833a6..75a03280422 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/ExcessiveLengthRule.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/ExcessiveLengthRule.java
@@ -2,9 +2,9 @@
* BSD-style license; for more info see http://pmd.sourceforge.net/license.html
*/
-package net.sourceforge.pmd.lang.apex.rule.complexity;
+package net.sourceforge.pmd.lang.apex.rule.design;
-import net.sourceforge.pmd.lang.apex.ast.ApexNode;
+import net.sourceforge.pmd.lang.apex.ast.AbstractApexNodeBase;
import net.sourceforge.pmd.lang.apex.rule.AbstractStatisticalApexRule;
import net.sourceforge.pmd.stat.DataPoint;
@@ -16,7 +16,7 @@ public ExcessiveLengthRule(Class<?> nodeClass) {
}
@Override
- public Object visit(ApexNode<?> node, Object data) {
+ public Object visit(AbstractApexNodeBase node, Object data) {
if (nodeClass.isInstance(node)) {
DataPoint point = new DataPoint();
point.setNode(node);
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/ExcessiveNodeCountRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/ExcessiveNodeCountRule.java
similarity index 82%
rename from pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/ExcessiveNodeCountRule.java
rename to pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/ExcessiveNodeCountRule.java
index 5a348f0e497..5819e105256 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/complexity/ExcessiveNodeCountRule.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/ExcessiveNodeCountRule.java
@@ -2,9 +2,9 @@
* BSD-style license; for more info see http://pmd.sourceforge.net/license.html
*/
-package net.sourceforge.pmd.lang.apex.rule.complexity;
+package net.sourceforge.pmd.lang.apex.rule.design;
-import net.sourceforge.pmd.lang.apex.ast.ApexNode;
+import net.sourceforge.pmd.lang.apex.ast.AbstractApexNodeBase;
import net.sourceforge.pmd.lang.apex.rule.AbstractStatisticalApexRule;
import net.sourceforge.pmd.stat.DataPoint;
@@ -35,11 +35,11 @@ public ExcessiveNodeCountRule(Class<?> nodeClass) {
}
@Override
- public Object visit(ApexNode<?> node, Object data) {
+ public Object visit(AbstractApexNodeBase node, Object data) {
int numNodes = 0;
for (int i = 0; i < node.jjtGetNumChildren(); i++) {
- Integer treeSize = (Integer) ((ApexNode<?>) node.jjtGetChild(i)).jjtAccept(this, data);
+ Integer treeSize = (Integer) ((AbstractApexNodeBase) node.jjtGetChild(i)).jjtAccept(this, data);
numNodes += treeSize;
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/ExcessiveParameterListRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/ExcessiveParameterListRule.java
new file mode 100644
index 00000000000..f3239586831
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/ExcessiveParameterListRule.java
@@ -0,0 +1,29 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.design;
+
+import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
+import net.sourceforge.pmd.lang.apex.ast.ASTParameter;
+import net.sourceforge.pmd.util.NumericConstants;
+
+/**
+ * This rule detects an abnormally long parameter list. Note: This counts Nodes,
+ * and not necessarily parameters, so the numbers may not match up. (But
+ * topcount and sigma should work.)
+ */
+public class ExcessiveParameterListRule extends ExcessiveNodeCountRule {
+ public ExcessiveParameterListRule() {
+ super(ASTMethod.class);
+ setProperty(MINIMUM_DESCRIPTOR, 4d);
+ setProperty(CODECLIMATE_CATEGORIES, "Complexity");
+ setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 50);
+ setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
+ }
+
+ @Override
+ public Object visit(ASTParameter node, Object data) {
+ return NumericConstants.ONE;
+ }
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/ExcessivePublicCountRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/ExcessivePublicCountRule.java
new file mode 100644
index 00000000000..8c8be1c6981
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/ExcessivePublicCountRule.java
@@ -0,0 +1,54 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.design;
+
+import static apex.jorje.semantic.symbol.type.ModifierTypeInfos.PUBLIC;
+import static apex.jorje.semantic.symbol.type.ModifierTypeInfos.STATIC;
+
+import net.sourceforge.pmd.lang.apex.ast.ASTFieldDeclarationStatements;
+import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
+import net.sourceforge.pmd.util.NumericConstants;
+
+/**
+ * Rule attempts to count all public methods and public attributes
+ * defined in a class.
+ *
+ * <p>If a class has a high number of public operations, it might be wise
+ * to consider whether it would be appropriate to divide it into
+ * subclasses.</p>
+ *
+ * <p>A large proportion of public members and operations means the class
+ * has high potential to be affected by external classes. Futhermore,
+ * increased effort will be required to thoroughly test the class.</p>
+ *
+ * @author ported from Java original of aglover
+ */
+public class ExcessivePublicCountRule extends ExcessiveNodeCountRule {
+
+ public ExcessivePublicCountRule() {
+ super(ASTUserClass.class);
+ setProperty(MINIMUM_DESCRIPTOR, 20d);
+ setProperty(CODECLIMATE_CATEGORIES, "Complexity");
+ setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 150);
+ setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
+ }
+
+ @Override
+ public Object visit(ASTMethod node, Object data) {
+ if (node.getNode().getModifiers().has(PUBLIC) && !node.getImage().matches("<clinit>|<init>|clone")) {
+ return NumericConstants.ONE;
+ }
+ return NumericConstants.ZERO;
+ }
+
+ @Override
+ public Object visit(ASTFieldDeclarationStatements node, Object data) {
+ if (node.getNode().getModifiers().has(PUBLIC) && !node.getNode().getModifiers().has(STATIC)) {
+ return NumericConstants.ONE;
+ }
+ return NumericConstants.ZERO;
+ }
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/NcssConstructorCountRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/NcssConstructorCountRule.java
new file mode 100644
index 00000000000..f9ba66be189
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/NcssConstructorCountRule.java
@@ -0,0 +1,43 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.design;
+
+import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
+import net.sourceforge.pmd.stat.DataPoint;
+import net.sourceforge.pmd.util.NumericConstants;
+
+/**
+ * Non-commented source statement counter for constructors.
+ *
+ * @author ported from Java original by Jason Bennett
+ */
+public class NcssConstructorCountRule extends AbstractNcssCountRule {
+
+ /**
+ * Count constructor declarations. This includes any explicit super() calls.
+ */
+ public NcssConstructorCountRule() {
+ super(ASTMethod.class);
+ setProperty(MINIMUM_DESCRIPTOR, 20d);
+ setProperty(CODECLIMATE_CATEGORIES, "Complexity");
+ setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 50);
+ setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
+ }
+
+ @Override
+ public Object visit(ASTMethod node, Object data) {
+ if (node.getNode().getMethodInfo().isConstructor()) {
+ return super.visit(node, data);
+ }
+
+ return NumericConstants.ZERO;
+ }
+
+ @Override
+ public Object[] getViolationParameters(DataPoint point) {
+ // TODO need to put class name or constructor ID in string
+ return new String[] { String.valueOf((int) point.getScore()) };
+ }
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/NcssMethodCountRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/NcssMethodCountRule.java
new file mode 100644
index 00000000000..0604ecfa073
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/NcssMethodCountRule.java
@@ -0,0 +1,43 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.design;
+
+import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
+import net.sourceforge.pmd.stat.DataPoint;
+import net.sourceforge.pmd.util.NumericConstants;
+
+/**
+ * Non-commented source statement counter for methods.
+ *
+ * @author ported from Java original of Jason Bennett
+ */
+public class NcssMethodCountRule extends AbstractNcssCountRule {
+
+ /**
+ * Count the size of all non-constructor methods.
+ */
+ public NcssMethodCountRule() {
+ super(ASTMethod.class);
+ setProperty(MINIMUM_DESCRIPTOR, 40d);
+ setProperty(CODECLIMATE_CATEGORIES, "Complexity");
+ setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 50);
+ setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
+ }
+
+ @Override
+ public Object visit(ASTMethod node, Object data) {
+ if (!node.getNode().getMethodInfo().isConstructor()) {
+ return super.visit(node, data);
+ }
+
+ return NumericConstants.ZERO;
+ }
+
+ @Override
+ public Object[] getViolationParameters(DataPoint point) {
+ return new String[] { ((ASTMethod) point.getNode()).getNode().getMethodInfo().getName(),
+ String.valueOf((int) point.getScore()), };
+ }
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/NcssTypeCountRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/NcssTypeCountRule.java
new file mode 100644
index 00000000000..578a9f6dd41
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/NcssTypeCountRule.java
@@ -0,0 +1,77 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.design;
+
+import net.sourceforge.pmd.lang.apex.ast.ASTFieldDeclaration;
+import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserEnum;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserInterface;
+import net.sourceforge.pmd.stat.DataPoint;
+import net.sourceforge.pmd.util.NumericConstants;
+
+/**
+ * Non-commented source statement counter for type declarations.
+ *
+ * @author ported from Java original of Jason Bennett
+ */
+public class NcssTypeCountRule extends AbstractNcssCountRule {
+
+ /**
+ * Count type declarations. This includes classes as well as enums and
+ * annotations.
+ */
+ public NcssTypeCountRule() {
+ super(ASTUserClass.class);
+ setProperty(MINIMUM_DESCRIPTOR, 500d);
+ setProperty(CODECLIMATE_CATEGORIES, "Complexity");
+ setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 250);
+ setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
+ }
+
+ @Override
+ public Object visit(ASTUserClass node, Object data) {
+
+ if (!node.hasDescendantOfAnyType(ASTUserClass.class)) {
+ return super.visit(node, data);
+ }
+
+ return countNodeChildren(node, data);
+ }
+
+ @Override
+ public Object visit(ASTUserInterface node, Object data) {
+
+ if (!node.hasDescendantOfAnyType(ASTUserClass.class)) {
+ return super.visit(node, data);
+ }
+
+ return countNodeChildren(node, data);
+ }
+
+ @Override
+ public Object visit(ASTUserEnum node, Object data) {
+ return countNodeChildren(node, data);
+ }
+
+ @Override
+ public Object visit(ASTMethod node, Object data) {
+ if (!node.getImage().matches("<clinit>|<init>|clone")) {
+ return countNodeChildren(node, data);
+ }
+
+ return NumericConstants.ZERO;
+ }
+
+ @Override
+ public Object visit(ASTFieldDeclaration node, Object data) {
+ return NumericConstants.ONE;
+ }
+
+ @Override
+ public Object[] getViolationParameters(DataPoint point) {
+ return new String[] { String.valueOf((int) point.getScore()) };
+ }
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/StdCyclomaticComplexityRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/StdCyclomaticComplexityRule.java
new file mode 100644
index 00000000000..323dd086ffc
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/StdCyclomaticComplexityRule.java
@@ -0,0 +1,215 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.design;
+
+import java.util.Stack;
+
+import net.sourceforge.pmd.lang.apex.ast.ASTBooleanExpression;
+import net.sourceforge.pmd.lang.apex.ast.ASTDoLoopStatement;
+import net.sourceforge.pmd.lang.apex.ast.ASTForEachStatement;
+import net.sourceforge.pmd.lang.apex.ast.ASTForLoopStatement;
+import net.sourceforge.pmd.lang.apex.ast.ASTIfBlockStatement;
+import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
+import net.sourceforge.pmd.lang.apex.ast.ASTTernaryExpression;
+import net.sourceforge.pmd.lang.apex.ast.ASTTryCatchFinallyBlockStatement;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserEnum;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserInterface;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserTrigger;
+import net.sourceforge.pmd.lang.apex.ast.ASTWhileLoopStatement;
+import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
+import net.sourceforge.pmd.properties.BooleanProperty;
+import net.sourceforge.pmd.properties.IntegerProperty;
+
+/**
+ * Implements the standard cyclomatic complexity rule
+ * <p>
+ * Standard rules: +1 for each decision point, but not including boolean
+ * operators unlike CyclomaticComplexityRule.
+ *
+ * @author ported on Java version of Alan Hohn, based on work by Donald A.
+ * Leckie
+ *
+ * @since June 18, 2014
+ */
+public class StdCyclomaticComplexityRule extends AbstractApexRule {
+
+ public static final IntegerProperty REPORT_LEVEL_DESCRIPTOR
+ = IntegerProperty.named("reportLevel")
+ .desc("Cyclomatic Complexity reporting threshold")
+ .range(1, 30).defaultValue(10).uiOrder(1.0f).build();
+
+ public static final BooleanProperty SHOW_CLASSES_COMPLEXITY_DESCRIPTOR = new BooleanProperty(
+ "showClassesComplexity", "Add class average violations to the report", true, 2.0f);
+
+ public static final BooleanProperty SHOW_METHODS_COMPLEXITY_DESCRIPTOR = new BooleanProperty(
+ "showMethodsComplexity", "Add method average violations to the report", true, 3.0f);
+
+ private int reportLevel;
+ private boolean showClassesComplexity = true;
+ private boolean showMethodsComplexity = true;
+
+ protected static class Entry {
+ private int decisionPoints = 1;
+ public int highestDecisionPoints;
+ public int methodCount;
+
+ private Entry() {
+ }
+
+ public void bumpDecisionPoints() {
+ decisionPoints++;
+ }
+
+ public void bumpDecisionPoints(int size) {
+ decisionPoints += size;
+ }
+
+ public int getComplexityAverage() {
+ return (double) methodCount == 0 ? 1 : (int) Math.rint((double) decisionPoints / (double) methodCount);
+ }
+ }
+
+ protected Stack<Entry> entryStack = new Stack<>();
+
+ public StdCyclomaticComplexityRule() {
+ definePropertyDescriptor(REPORT_LEVEL_DESCRIPTOR);
+ definePropertyDescriptor(SHOW_CLASSES_COMPLEXITY_DESCRIPTOR);
+ definePropertyDescriptor(SHOW_METHODS_COMPLEXITY_DESCRIPTOR);
+
+ setProperty(CODECLIMATE_CATEGORIES, "Complexity");
+ setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 250);
+ setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
+ }
+
+ @Override
+ public Object visit(ASTUserClass node, Object data) {
+ reportLevel = getProperty(REPORT_LEVEL_DESCRIPTOR);
+ showClassesComplexity = getProperty(SHOW_CLASSES_COMPLEXITY_DESCRIPTOR);
+ showMethodsComplexity = getProperty(SHOW_METHODS_COMPLEXITY_DESCRIPTOR);
+ entryStack.push(new Entry());
+ super.visit(node, data);
+ Entry classEntry = entryStack.pop();
+ if (showClassesComplexity) {
+ if (classEntry.getComplexityAverage() >= reportLevel || classEntry.highestDecisionPoints >= reportLevel) {
+ addViolation(data, node, new String[] { "class", node.getImage(),
+ classEntry.getComplexityAverage() + " (Highest = " + classEntry.highestDecisionPoints + ')', });
+ }
+ }
+ return data;
+ }
+
+ @Override
+ public Object visit(ASTUserTrigger node, Object data) {
+ reportLevel = getProperty(REPORT_LEVEL_DESCRIPTOR);
+ showClassesComplexity = getProperty(SHOW_CLASSES_COMPLEXITY_DESCRIPTOR);
+ showMethodsComplexity = getProperty(SHOW_METHODS_COMPLEXITY_DESCRIPTOR);
+ entryStack.push(new Entry());
+ super.visit(node, data);
+ Entry classEntry = entryStack.pop();
+ if (showClassesComplexity) {
+ if (classEntry.getComplexityAverage() >= reportLevel || classEntry.highestDecisionPoints >= reportLevel) {
+ addViolation(data, node, new String[] { "trigger", node.getImage(),
+ classEntry.getComplexityAverage() + " (Highest = " + classEntry.highestDecisionPoints + ')', });
+ }
+ }
+ return data;
+ }
+
+ @Override
+ public Object visit(ASTUserInterface node, Object data) {
+ return data;
+ }
+
+ @Override
+ public Object visit(ASTUserEnum node, Object data) {
+ entryStack.push(new Entry());
+ super.visit(node, data);
+ Entry classEntry = entryStack.pop();
+ if (classEntry.getComplexityAverage() >= reportLevel || classEntry.highestDecisionPoints >= reportLevel) {
+ addViolation(data, node, new String[] { "class", node.getImage(),
+ classEntry.getComplexityAverage() + "(Highest = " + classEntry.highestDecisionPoints + ')', });
+ }
+ return data;
+ }
+
+ @Override
+ public Object visit(ASTMethod node, Object data) {
+ if (!node.getImage().matches("<clinit>|<init>|clone")) {
+ entryStack.push(new Entry());
+ super.visit(node, data);
+ Entry methodEntry = entryStack.pop();
+ int methodDecisionPoints = methodEntry.decisionPoints;
+ Entry classEntry = entryStack.peek();
+ classEntry.methodCount++;
+ classEntry.bumpDecisionPoints(methodDecisionPoints);
+
+ if (methodDecisionPoints > classEntry.highestDecisionPoints) {
+ classEntry.highestDecisionPoints = methodDecisionPoints;
+ }
+
+ if (showMethodsComplexity && methodEntry.decisionPoints >= reportLevel) {
+ String methodType = node.getNode().getMethodInfo().isConstructor() ? "constructor" : "method";
+ addViolation(data, node,
+ new String[] { methodType, node.getImage(), String.valueOf(methodEntry.decisionPoints) });
+ }
+ }
+ return data;
+ }
+
+ @Override
+ public Object visit(ASTIfBlockStatement node, Object data) {
+ entryStack.peek().bumpDecisionPoints();
+ super.visit(node, data);
+ return data;
+ }
+
+ @Override
+ public Object visit(ASTTryCatchFinallyBlockStatement node, Object data) {
+ entryStack.peek().bumpDecisionPoints();
+ super.visit(node, data);
+ return data;
+ }
+
+ @Override
+ public Object visit(ASTForLoopStatement node, Object data) {
+ entryStack.peek().bumpDecisionPoints();
+ super.visit(node, data);
+ return data;
+ }
+
+ @Override
+ public Object visit(ASTForEachStatement node, Object data) {
+ entryStack.peek().bumpDecisionPoints();
+ super.visit(node, data);
+ return data;
+ }
+
+ @Override
+ public Object visit(ASTWhileLoopStatement node, Object data) {
+ entryStack.peek().bumpDecisionPoints();
+ super.visit(node, data);
+ return data;
+ }
+
+ @Override
+ public Object visit(ASTDoLoopStatement node, Object data) {
+ entryStack.peek().bumpDecisionPoints();
+ super.visit(node, data);
+ return data;
+ }
+
+ @Override
+ public Object visit(ASTTernaryExpression node, Object data) {
+ entryStack.peek().bumpDecisionPoints();
+ super.visit(node, data);
+ return data;
+ }
+
+ @Override
+ public Object visit(ASTBooleanExpression node, Object data) {
+ return data;
+ }
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/TooManyFieldsRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/TooManyFieldsRule.java
new file mode 100644
index 00000000000..58ac9101898
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/design/TooManyFieldsRule.java
@@ -0,0 +1,77 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.design;
+
+import static apex.jorje.semantic.symbol.type.ModifierTypeInfos.FINAL;
+import static apex.jorje.semantic.symbol.type.ModifierTypeInfos.STATIC;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import net.sourceforge.pmd.lang.apex.ast.ASTField;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
+import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
+import net.sourceforge.pmd.lang.ast.Node;
+import net.sourceforge.pmd.properties.IntegerProperty;
+import net.sourceforge.pmd.util.NumericConstants;
+
+public class TooManyFieldsRule extends AbstractApexRule {
+
+ private static final int DEFAULT_MAXFIELDS = 15;
+
+ private Map<String, Integer> stats;
+ private Map<String, ASTUserClass> nodes;
+
+ private static final IntegerProperty MAX_FIELDS_DESCRIPTOR = new IntegerProperty("maxfields",
+ "Max allowable fields", 1, 300, DEFAULT_MAXFIELDS, 1.0f);
+
+ public TooManyFieldsRule() {
+ definePropertyDescriptor(MAX_FIELDS_DESCRIPTOR);
+
+ setProperty(CODECLIMATE_CATEGORIES, "Complexity");
+ setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 200);
+ setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
+ }
+
+ @Override
+ public Object visit(ASTUserClass node, Object data) {
+
+ int maxFields = getProperty(MAX_FIELDS_DESCRIPTOR);
+
+ stats = new HashMap<>(5);
+ nodes = new HashMap<>(5);
+
+ List<ASTField> l = node.findDescendantsOfType(ASTField.class);
+
+ for (ASTField fd : l) {
+ if (fd.getNode().getModifierInfo().all(FINAL, STATIC)) {
+ continue;
+ }
+ ASTUserClass clazz = fd.getFirstParentOfType(ASTUserClass.class);
+ if (clazz != null) {
+ bumpCounterFor(clazz);
+ }
+ }
+ for (Map.Entry<String, Integer> entry : stats.entrySet()) {
+ int val = entry.getValue();
+ Node n = nodes.get(entry.getKey());
+ if (val > maxFields) {
+ addViolation(data, n);
+ }
+ }
+ return data;
+ }
+
+ private void bumpCounterFor(ASTUserClass clazz) {
+ String key = clazz.getImage();
+ if (!stats.containsKey(key)) {
+ stats.put(key, NumericConstants.ZERO);
+ nodes.put(key, clazz);
+ }
+ Integer i = Integer.valueOf(stats.get(key) + 1);
+ stats.put(key, i);
+ }
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/documentation/ApexDocRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/documentation/ApexDocRule.java
new file mode 100644
index 00000000000..d50277fd236
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/documentation/ApexDocRule.java
@@ -0,0 +1,180 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.documentation;
+
+import static apex.jorje.semantic.symbol.type.ModifierTypeInfos.GLOBAL;
+import static apex.jorje.semantic.symbol.type.ModifierTypeInfos.OVERRIDE;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import java.util.stream.Collectors;
+
+import net.sourceforge.pmd.lang.apex.ast.ASTAnnotation;
+import net.sourceforge.pmd.lang.apex.ast.ASTFormalComment;
+import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
+import net.sourceforge.pmd.lang.apex.ast.ASTModifierNode;
+import net.sourceforge.pmd.lang.apex.ast.ASTProperty;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserInterface;
+import net.sourceforge.pmd.lang.apex.ast.ApexNode;
+import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
+
+import apex.jorje.data.Locations;
+import apex.jorje.semantic.ast.modifier.ModifierGroup;
+
+public class ApexDocRule extends AbstractApexRule {
+ private static final Pattern DESCRIPTION_PATTERN = Pattern.compile("@description\\s");
+ private static final Pattern RETURN_PATTERN = Pattern.compile("@return\\s");
+ private static final Pattern PARAM_PATTERN = Pattern.compile("@param\\s+(\\w+)\\s");
+
+ private static final String MISSING_COMMENT_MESSAGE = "Missing ApexDoc comment";
+ private static final String MISSING_DESCRIPTION_MESSAGE = "Missing ApexDoc @description";
+ private static final String MISSING_RETURN_MESSAGE = "Missing ApexDoc @return";
+ private static final String UNEXPECTED_RETURN_MESSAGE = "Unexpected ApexDoc @return";
+ private static final String MISMATCHED_PARAM_MESSAGE = "Missing or mismatched ApexDoc @param";
+
+ public ApexDocRule() {
+ addRuleChainVisit(ASTUserClass.class);
+ addRuleChainVisit(ASTUserInterface.class);
+ addRuleChainVisit(ASTMethod.class);
+ addRuleChainVisit(ASTProperty.class);
+ }
+
+ @Override
+ public Object visit(ASTUserClass node, Object data) {
+ handleClassOrInterface(node, data);
+ return data;
+ }
+
+ @Override
+ public Object visit(ASTUserInterface node, Object data) {
+ handleClassOrInterface(node, data);
+ return data;
+ }
+
+ @Override
+ public Object visit(ASTMethod node, Object data) {
+ if (node.jjtGetParent() instanceof ASTProperty) {
+ // Skip property methods, doc is required on the property itself
+ return data;
+ }
+
+ ApexDocComment comment = getApexDocComment(node);
+ if (comment == null) {
+ if (shouldHaveApexDocs(node)) {
+ addViolationWithMessage(data, node, MISSING_COMMENT_MESSAGE);
+ }
+ } else {
+ if (!comment.hasDescription) {
+ addViolationWithMessage(data, node, MISSING_DESCRIPTION_MESSAGE);
+ }
+
+ String returnType = node.getNode().getReturnTypeRef().toString();
+ boolean shouldHaveReturn = !(returnType.isEmpty() || "void".equalsIgnoreCase(returnType));
+ if (comment.hasReturn != shouldHaveReturn) {
+ if (shouldHaveReturn) {
+ addViolationWithMessage(data, node, MISSING_RETURN_MESSAGE);
+ } else {
+ addViolationWithMessage(data, node, UNEXPECTED_RETURN_MESSAGE);
+ }
+ }
+
+ // Collect parameter names in order
+ final List<String> params = node.getNode().getMethodInfo().getParameters()
+ .stream().map(p -> p.getName().getValue()).collect(Collectors.toList());
+
+ if (!comment.params.equals(params)) {
+ addViolationWithMessage(data, node, MISMATCHED_PARAM_MESSAGE);
+ }
+ }
+
+ return data;
+ }
+
+ @Override
+ public Object visit(ASTProperty node, Object data) {
+ ApexDocComment comment = getApexDocComment(node);
+ if (comment == null) {
+ if (shouldHaveApexDocs(node)) {
+ addViolationWithMessage(data, node, MISSING_COMMENT_MESSAGE);
+ }
+ } else {
+ if (!comment.hasDescription) {
+ addViolationWithMessage(data, node, MISSING_DESCRIPTION_MESSAGE);
+ }
+ }
+
+ return data;
+ }
+
+ private void handleClassOrInterface(ApexNode<?> node, Object data) {
+ ApexDocComment comment = getApexDocComment(node);
+ if (comment == null) {
+ if (shouldHaveApexDocs(node)) {
+ addViolationWithMessage(data, node, MISSING_COMMENT_MESSAGE);
+ }
+ } else {
+ if (!comment.hasDescription) {
+ addViolationWithMessage(data, node, MISSING_DESCRIPTION_MESSAGE);
+ }
+ }
+ }
+
+ private boolean shouldHaveApexDocs(ApexNode<?> node) {
+ if (node.getNode().getLoc() == Locations.NONE) {
+ return false;
+ }
+
+ // is this a test?
+ for (final ASTAnnotation annotation : node.findDescendantsOfType(ASTAnnotation.class)) {
+ if (annotation.getImage().equals("IsTest")) {
+ return false;
+ }
+ }
+
+ ASTModifierNode modifier = node.getFirstChildOfType(ASTModifierNode.class);
+ if (modifier != null) {
+ boolean isPublic = modifier.isPublic();
+ ModifierGroup modifierGroup = modifier.getNode().getModifiers();
+ boolean isGlobal = modifierGroup.has(GLOBAL);
+ boolean isOverride = modifierGroup.has(OVERRIDE);
+ return (isPublic || isGlobal) && !isOverride;
+ }
+ return false;
+ }
+
+ private ApexDocComment getApexDocComment(ApexNode<?> node) {
+ ASTFormalComment comment = node.getFirstChildOfType(ASTFormalComment.class);
+ if (comment != null) {
+ String token = comment.getToken();
+
+ boolean hasDescription = DESCRIPTION_PATTERN.matcher(token).find();
+ boolean hasReturn = RETURN_PATTERN.matcher(token).find();
+
+ ArrayList<String> params = new ArrayList<>();
+ Matcher paramMatcher = PARAM_PATTERN.matcher(token);
+ while (paramMatcher.find()) {
+ params.add(paramMatcher.group(1));
+ }
+
+ return new ApexDocComment(hasDescription, hasReturn, params);
+ }
+ return null;
+ }
+
+ private static class ApexDocComment {
+ boolean hasDescription;
+ boolean hasReturn;
+ List<String> params;
+
+ ApexDocComment(boolean hasDescription, boolean hasReturn, List<String> params) {
+ this.hasDescription = hasDescription;
+ this.hasReturn = hasReturn;
+ this.params = params;
+ }
+ }
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/errorprone/AvoidHardcodingIdRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/errorprone/AvoidHardcodingIdRule.java
new file mode 100644
index 00000000000..248784713dc
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/errorprone/AvoidHardcodingIdRule.java
@@ -0,0 +1,79 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.errorprone;
+
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.regex.Pattern;
+
+import net.sourceforge.pmd.lang.apex.ast.ASTLiteralExpression;
+import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
+
+public class AvoidHardcodingIdRule extends AbstractApexRule {
+ private static final Pattern PATTERN = Pattern.compile("^[a-zA-Z0-9]{5}0[a-zA-Z0-9]{9}([a-zA-Z0-5]{3})?$");
+ private static final Map<String, Character> CHECKSUM_LOOKUP;
+
+ static {
+ final Map<String, Character> lookup = new HashMap<>();
+ final char[] chartable = "ABCDEFGHIJKLMNOPQRSTUVWXYZ012345".toCharArray();
+
+ for (int i = 0; i < chartable.length; i++) {
+ lookup.put(String.format("%5s", Integer.toBinaryString(i)).replace(' ', '0'), chartable[i]);
+ }
+
+ CHECKSUM_LOOKUP = Collections.unmodifiableMap(lookup);
+ }
+
+ public AvoidHardcodingIdRule() {
+ setProperty(CODECLIMATE_CATEGORIES, "Style");
+ setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 100);
+ setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
+
+ addRuleChainVisit(ASTLiteralExpression.class);
+ }
+
+ @Override
+ public Object visit(ASTLiteralExpression node, Object data) {
+ Object o = node.getNode().getLiteral();
+ if (o instanceof String) {
+ String literal = (String) o;
+ if (PATTERN.matcher(literal).matches()) {
+ // 18-digit ids are just 15 digit ids + checksums, validate it or it's not an id
+ if (literal.length() == 18 && !validateChecksum(literal)) {
+ return data;
+ }
+ addViolation(data, node);
+ }
+ }
+ return data;
+ }
+
+ /*
+ * ID validation - sources:
+ * https://stackoverflow.com/questions/9742913/validating-a-salesforce-id#answer-29299786
+ * https://gist.github.com/jeriley/36b29f7c46527af4532aaf092c90dd56
+ */
+ private boolean validateChecksum(String literal) {
+ final String part1 = literal.substring(0, 5);
+ final String part2 = literal.substring(5, 10);
+ final String part3 = literal.substring(10, 15);
+
+ final char checksum1 = checksum(part1);
+ final char checksum2 = checksum(part2);
+ final char checksum3 = checksum(part3);
+
+ return literal.charAt(15) == checksum1 && literal.charAt(16) == checksum2
+ && literal.charAt(17) == checksum3;
+ }
+
+ private char checksum(String part) {
+ final StringBuilder sb = new StringBuilder(5);
+ for (int i = 4; i >= 0; i--) {
+ sb.append(Character.isUpperCase(part.charAt(i)) ? '1' : '0');
+ }
+ return CHECKSUM_LOOKUP.get(sb.toString());
+ }
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/errorprone/AvoidNonExistentAnnotationsRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/errorprone/AvoidNonExistentAnnotationsRule.java
new file mode 100644
index 00000000000..11eeb52b2bd
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/errorprone/AvoidNonExistentAnnotationsRule.java
@@ -0,0 +1,106 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.errorprone;
+
+import java.util.HashSet;
+import java.util.Set;
+
+import net.sourceforge.pmd.lang.apex.ast.ASTField;
+import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
+import net.sourceforge.pmd.lang.apex.ast.ASTProperty;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserEnum;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserInterface;
+import net.sourceforge.pmd.lang.apex.ast.AbstractApexNode;
+import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
+
+import apex.jorje.semantic.ast.compilation.UserClass;
+import apex.jorje.semantic.ast.compilation.UserEnum;
+import apex.jorje.semantic.ast.compilation.UserInterface;
+import apex.jorje.semantic.ast.member.Field;
+import apex.jorje.semantic.ast.member.Method;
+import apex.jorje.semantic.ast.member.Property;
+import apex.jorje.semantic.ast.modifier.Annotation;
+import apex.jorje.semantic.ast.modifier.ModifierNode;
+import apex.jorje.semantic.symbol.type.AnnotationTypeInfos;
+import apex.jorje.semantic.symbol.type.StandardAnnotationTypeInfo;
+
+/**
+ * Apex supported non existent annotations for legacy reasons.
+ * In the future, use of such non-existent annotations could result in broken apex code that will not compile.
+ * This will prevent users of garbage annotations from being able to use legitimate annotations added to apex in the future.
+ * A full list of supported annotations can be found at https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_classes_annotation.htm
+ *
+ * @author a.subramanian
+ */
+public class AvoidNonExistentAnnotationsRule extends AbstractApexRule {
+
+ private static final Set<StandardAnnotationTypeInfo> SUPPORTED_APEX_ANNOTATIONS = getSupportedApexAnnotations();
+
+ @Override
+ public Object visit(final ASTUserClass node, final Object data) {
+ final UserClass userClass = node.getNode();
+ checkForNonExistentAnnotation(node, userClass.getModifiers(), data);
+ return super.visit(node, data);
+ }
+
+ @Override
+ public final Object visit(ASTUserInterface node, final Object data) {
+ final UserInterface userInterface = node.getNode();
+ checkForNonExistentAnnotation(node, userInterface.getModifiers(), data);
+ return super.visit(node, data);
+ }
+
+ @Override
+ public Object visit(final ASTUserEnum node, final Object data) {
+ final UserEnum userEnum = node.getNode();
+ checkForNonExistentAnnotation(node, userEnum.getModifiers(), data);
+ return super.visit(node, data);
+ }
+
+ @Override
+ public Object visit(final ASTMethod node, final Object data) {
+ final Method method = node.getNode();
+ return checkForNonExistentAnnotation(node, method.getModifiersNode(), data);
+ }
+
+ @Override
+ public Object visit(final ASTProperty node, final Object data) {
+ final Property property = node.getNode();
+ // may have nested methods, don't visit children
+ return checkForNonExistentAnnotation(node, property.getModifiersNode(), data);
+ }
+
+ @Override
+ public Object visit(final ASTField node, final Object data) {
+ final Field field = node.getNode();
+ return checkForNonExistentAnnotation(node, field.getModifiers(), data);
+ }
+
+ private Object checkForNonExistentAnnotation(final AbstractApexNode<?> node, final ModifierNode modifierNode, final Object data) {
+ for (final Annotation annotation : modifierNode.getModifiers().getAnnotations()) {
+ if (!SUPPORTED_APEX_ANNOTATIONS.contains(annotation.getType())) {
+ addViolationWithMessage(data, node, "Use of non existent annotations will lead to broken Apex code which will not compile in the future.");
+ }
+ }
+ return data;
+ }
+
+ private static Set<StandardAnnotationTypeInfo> getSupportedApexAnnotations() {
+ final java.lang.reflect.Field[] fields = AnnotationTypeInfos.class.getFields();
+ final Set<StandardAnnotationTypeInfo> annotationTypeInfos = new HashSet<>();
+ for (final java.lang.reflect.Field field : fields) {
+ if (field.getType().isAssignableFrom(StandardAnnotationTypeInfo.class)) {
+ field.setAccessible(true);
+ try {
+ annotationTypeInfos.add((StandardAnnotationTypeInfo) field.get(null));
+ } catch (final Exception illegalAccessException) {
+ continue;
+ }
+ }
+ }
+ return annotationTypeInfos;
+ }
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/errorprone/MethodWithSameNameAsEnclosingClassRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/errorprone/MethodWithSameNameAsEnclosingClassRule.java
new file mode 100644
index 00000000000..835b8575c0f
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/errorprone/MethodWithSameNameAsEnclosingClassRule.java
@@ -0,0 +1,38 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.errorprone;
+
+import java.util.List;
+
+import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
+import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
+
+public class MethodWithSameNameAsEnclosingClassRule extends AbstractApexRule {
+
+ public MethodWithSameNameAsEnclosingClassRule() {
+ setProperty(CODECLIMATE_CATEGORIES, "Style");
+ // Note: x10 as Apex has not automatic refactoring
+ setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 50);
+ setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
+ }
+
+ @Override
+ public Object visit(ASTUserClass node, Object data) {
+ String className = node.getImage();
+
+ List<ASTMethod> methods = node.findDescendantsOfType(ASTMethod.class);
+
+ for (ASTMethod m : methods) {
+ String methodName = m.getImage();
+
+ if (!m.getNode().getMethodInfo().isConstructor() && methodName.equalsIgnoreCase(className)) {
+ addViolation(data, m);
+ }
+ }
+
+ return super.visit(node, data);
+ }
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/performance/AvoidSoslInLoopsRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/performance/AvoidSoslInLoopsRule.java
new file mode 100644
index 00000000000..3d16b1871e3
--- /dev/null
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/performance/AvoidSoslInLoopsRule.java
@@ -0,0 +1,55 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.performance;
+
+import net.sourceforge.pmd.lang.apex.ast.ASTDoLoopStatement;
+import net.sourceforge.pmd.lang.apex.ast.ASTForEachStatement;
+import net.sourceforge.pmd.lang.apex.ast.ASTForLoopStatement;
+import net.sourceforge.pmd.lang.apex.ast.ASTReturnStatement;
+import net.sourceforge.pmd.lang.apex.ast.ASTSoslExpression;
+import net.sourceforge.pmd.lang.apex.ast.ASTWhileLoopStatement;
+import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
+import net.sourceforge.pmd.lang.ast.Node;
+
+public class AvoidSoslInLoopsRule extends AbstractApexRule {
+
+ public AvoidSoslInLoopsRule() {
+ setProperty(CODECLIMATE_CATEGORIES, "Performance");
+ // Note: Often more complicated as just moving the SOSL a few lines.
+ // Involves Maps...
+ setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 150);
+ setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
+ }
+
+ @Override
+ public Object visit(ASTSoslExpression node, Object data) {
+ if (insideLoop(node) && parentNotReturn(node) && parentNotForEach(node)) {
+ addViolation(data, node);
+ }
+ return data;
+ }
+
+ private boolean parentNotReturn(ASTSoslExpression node) {
+ return !(node.jjtGetParent() instanceof ASTReturnStatement);
+ }
+
+ private boolean parentNotForEach(ASTSoslExpression node) {
+ return !(node.jjtGetParent() instanceof ASTForEachStatement);
+ }
+
+ private boolean insideLoop(ASTSoslExpression node) {
+ Node n = node.jjtGetParent();
+
+ while (n != null) {
+ if (n instanceof ASTDoLoopStatement || n instanceof ASTWhileLoopStatement
+ || n instanceof ASTForLoopStatement || n instanceof ASTForEachStatement) {
+ return true;
+ }
+ n = n.jjtGetParent();
+ }
+
+ return false;
+ }
+}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexCRUDViolationRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexCRUDViolationRule.java
index 0cc1d463410..7e208cd8cf0 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexCRUDViolationRule.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexCRUDViolationRule.java
@@ -4,14 +4,14 @@
package net.sourceforge.pmd.lang.apex.rule.security;
-import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
-import java.util.Optional;
+import java.util.Locale;
+import java.util.Map;
import java.util.Set;
import java.util.WeakHashMap;
import java.util.regex.Matcher;
@@ -44,10 +44,11 @@
import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
import net.sourceforge.pmd.lang.ast.Node;
-import apex.jorje.data.ast.Identifier;
+import apex.jorje.data.Identifier;
import apex.jorje.data.ast.TypeRef;
-import apex.jorje.data.ast.TypeRef.ArrayTypeRef;
-import apex.jorje.data.ast.TypeRef.ClassTypeRef;
+import apex.jorje.data.ast.TypeRefs.ArrayTypeRef;
+import apex.jorje.data.ast.TypeRefs.ClassTypeRef;
+import com.google.common.base.Objects;
import com.google.common.collect.ArrayListMultimap;
import com.google.common.collect.ListMultimap;
@@ -62,10 +63,11 @@ public class ApexCRUDViolationRule extends AbstractApexRule {
private static final Pattern SELECT_FROM_PATTERN = Pattern.compile("[\\S|\\s]+?FROM[\\s]+?(\\w+)",
Pattern.CASE_INSENSITIVE);
- private final HashMap<String, String> varToTypeMapping = new HashMap<>();
+ private final Map<String, String> varToTypeMapping = new HashMap<>();
private final ListMultimap<String, String> typeToDMLOperationMapping = ArrayListMultimap.create();
- private final HashMap<String, String> checkedTypeToDMLOperationViaESAPI = new HashMap<>();
- private final WeakHashMap<String, ASTMethod> classMethods = new WeakHashMap<>();
+ private final Map<String, String> checkedTypeToDMLOperationViaESAPI = new HashMap<>();
+ private final Map<String, ASTMethod> classMethods = new WeakHashMap<>();
+ private String className;
private static final String IS_CREATEABLE = "isCreateable";
private static final String IS_DELETABLE = "isDeletable";
@@ -100,6 +102,8 @@ public Object visit(ASTUserClass node, Object data) {
return data; // stops all the rules
}
+ className = node.getImage();
+
for (ASTMethod n : node.findDescendantsOfType(ASTMethod.class)) {
StringBuilder sb = new StringBuilder().append(n.getNode().getDefiningType().getApexName()).append(":")
.append(n.getNode().getMethodInfo().getCanonicalName()).append(":")
@@ -107,8 +111,7 @@ public Object visit(ASTUserClass node, Object data) {
classMethods.put(sb.toString(), n);
}
- node.childrenAccept(this, data);
- return data;
+ return super.visit(node, data);
}
@Override
@@ -176,42 +179,28 @@ public Object visit(final ASTVariableDeclaration node, Object data) {
public Object visit(final ASTFieldDeclaration node, Object data) {
ASTFieldDeclarationStatements field = node.getFirstParentOfType(ASTFieldDeclarationStatements.class);
if (field != null) {
- try {
- TypeRef a = field.getNode().getTypeName();
- Field classNameField = a.getClass().getDeclaredField("className");
- Field typeArgsField = a.getClass().getDeclaredField("typeArguments");
- classNameField.setAccessible(true);
- typeArgsField.setAccessible(true);
-
- if (classNameField.get(a) instanceof ArrayList<?>) {
- @SuppressWarnings("unchecked")
- ArrayList<Identifier> innerField = (ArrayList<Identifier>) classNameField.get(a);
- if (!innerField.isEmpty()) {
- StringBuffer sb = new StringBuffer();
- for (Identifier id : innerField) {
- sb.append(id.value).append(".");
- }
- sb.deleteCharAt(sb.length() - 1);
-
- switch (sb.toString().toLowerCase()) {
- case "list":
- case "map":
- if (typeArgsField.get(a) instanceof Optional<?>) {
- addParametersToMapping(node, a, typeArgsField);
- }
- break;
- default:
- varToTypeMapping.put(Helper.getFQVariableName(node), getSimpleType(sb.toString()));
- break;
- }
+ TypeRef a = field.getNode().getTypeName();
+ List<Identifier> names = a.getNames();
+ List<TypeRef> typeArgs = a.getTypeArguments();
+
+ if (!names.isEmpty()) {
+ StringBuffer sb = new StringBuffer();
+ for (Identifier id : names) {
+ sb.append(id.getValue()).append(".");
+ }
+ sb.deleteCharAt(sb.length() - 1);
- }
+ switch (sb.toString().toLowerCase(Locale.ROOT)) {
+ case "list":
+ case "map":
+ addParametersToMapping(node, typeArgs);
+ break;
+ default:
+ varToTypeMapping.put(Helper.getFQVariableName(node), getSimpleType(sb.toString()));
+ break;
}
- } catch (NoSuchFieldException | IllegalArgumentException | IllegalAccessException | SecurityException e) {
- e.printStackTrace();
}
-
}
final ASTSoqlExpression soql = node.getFirstChildOfType(ASTSoqlExpression.class);
if (soql != null) {
@@ -222,31 +211,25 @@ public Object visit(final ASTFieldDeclaration node, Object data) {
}
- private void addParametersToMapping(final ASTFieldDeclaration node, TypeRef a, Field typeArgsField)
- throws IllegalAccessException {
- Optional<?> optionalContainer = (Optional<?>) typeArgsField.get(a);
- if (optionalContainer.isPresent()) {
- ArrayList<?> inner = (ArrayList<?>) optionalContainer.get();
- for (int i = 0; i < inner.size(); i++) {
- if (inner.get(i) instanceof ClassTypeRef) {
- innerAddParametrizedClassToMapping(node, (ClassTypeRef) inner.get(i));
- }
- if (inner.get(i) instanceof ArrayTypeRef) {
- ArrayTypeRef atr = (ArrayTypeRef) inner.get(i);
- if (atr.heldType instanceof ClassTypeRef) {
- innerAddParametrizedClassToMapping(node, (ClassTypeRef) atr.heldType);
- }
+ private void addParametersToMapping(final ASTFieldDeclaration node, List<TypeRef> typeArgs) {
+ for (int i = 0; i < typeArgs.size(); i++) {
+ if (typeArgs.get(i) instanceof ClassTypeRef) {
+ innerAddParametrizedClassToMapping(node, (ClassTypeRef) typeArgs.get(i));
+ }
+ if (typeArgs.get(i) instanceof ArrayTypeRef) {
+ ArrayTypeRef atr = (ArrayTypeRef) typeArgs.get(i);
+ if (atr.getHeldType() instanceof ClassTypeRef) {
+ innerAddParametrizedClassToMapping(node, (ClassTypeRef) atr.getHeldType());
}
-
}
}
}
private void innerAddParametrizedClassToMapping(final ASTFieldDeclaration node, final ClassTypeRef innerClassRef) {
- List<Identifier> ids = innerClassRef.className;
+ List<Identifier> ids = innerClassRef.getNames();
StringBuffer argType = new StringBuffer();
for (Identifier id : ids) {
- argType.append(id.value).append(".");
+ argType.append(id.getValue()).append(".");
}
argType.deleteCharAt(argType.length() - 1);
addVariableToMapping(Helper.getFQVariableName(node), argType.toString());
@@ -263,12 +246,13 @@ public Object visit(final ASTReturnStatement node, Object data) {
}
private void addVariableToMapping(final String variableName, final String type) {
- switch (type.toLowerCase()) {
+ switch (type.toLowerCase(Locale.ROOT)) {
case "list":
case "map":
- return;
+ break;
default:
varToTypeMapping.put(variableName, getSimpleType(type));
+ break;
}
}
@@ -303,7 +287,7 @@ private void collectCRUDMethodLevelChecks(final ASTMethodCallExpression node) {
return;
}
- List<Identifier> a = ref.getNode().getJadtIdentifiers();
+ List<Identifier> a = ref.getNode().getNames();
if (!a.isEmpty()) {
extractObjectAndFields(a, method, node.getNode().getDefiningType().getApexName());
} else {
@@ -342,8 +326,8 @@ private void collectCRUDMethodLevelChecks(final ASTMethodCallExpression node) {
private boolean isLastMethodName(final ASTMethodCallExpression methodNode, final String className,
final String methodName) {
final ASTReferenceExpression reference = methodNode.getFirstChildOfType(ASTReferenceExpression.class);
- if (reference.getNode().getJadtIdentifiers().size() > 0) {
- if (reference.getNode().getJadtIdentifiers().get(reference.getNode().getJadtIdentifiers().size() - 1).value
+ if (reference != null && reference.getNode().getNames().size() > 0) {
+ if (reference.getNode().getNames().get(reference.getNode().getNames().size() - 1).getValue()
.equalsIgnoreCase(className) && Helper.isMethodName(methodNode, methodName)) {
return true;
}
@@ -354,16 +338,16 @@ private boolean isLastMethodName(final ASTMethodCallExpression methodNode, final
private String getType(final ASTMethodCallExpression methodNode) {
final ASTReferenceExpression reference = methodNode.getFirstChildOfType(ASTReferenceExpression.class);
- if (reference.getNode().getJadtIdentifiers().size() > 0) {
+ if (reference.getNode().getNames().size() > 0) {
return new StringBuilder().append(reference.getNode().getDefiningType().getApexName()).append(":")
- .append(reference.getNode().getJadtIdentifiers().get(0).value).toString();
+ .append(reference.getNode().getNames().get(0).getValue()).toString();
}
return "";
}
private void extractObjectAndFields(final List<Identifier> listIdentifiers, final String method,
final String definingType) {
- final List<String> strings = listIdentifiers.stream().map(id -> id.value).collect(Collectors.toList());
+ final List<String> strings = listIdentifiers.stream().map(id -> id.getValue()).collect(Collectors.toList());
int flsIndex = Collections.lastIndexOfSubList(strings, Arrays.asList(RESERVED_KEYS_FLS));
if (flsIndex != -1) {
@@ -375,7 +359,7 @@ private void extractObjectAndFields(final List<Identifier> listIdentifiers, fina
}
private void checkForCRUD(final AbstractApexNode<?> node, final Object data, final String crudMethod) {
- final HashSet<ASTMethodCallExpression> prevCalls = getPreviousMethodCalls(node);
+ final Set<ASTMethodCallExpression> prevCalls = getPreviousMethodCalls(node);
for (ASTMethodCallExpression prevCall : prevCalls) {
collectCRUDMethodLevelChecks(prevCall);
}
@@ -383,8 +367,8 @@ private void checkForCRUD(final AbstractApexNode<?> node, final Object data, fin
final ASTMethod wrappingMethod = node.getFirstParentOfType(ASTMethod.class);
final ASTUserClass wrappingClass = node.getFirstParentOfType(ASTUserClass.class);
- if ((wrappingClass != null && Helper.isTestMethodOrClass(wrappingClass))
- || (wrappingMethod != null && Helper.isTestMethodOrClass(wrappingMethod))) {
+ if (wrappingClass != null && Helper.isTestMethodOrClass(wrappingClass)
+ || wrappingMethod != null && Helper.isTestMethodOrClass(wrappingMethod)) {
return;
}
@@ -406,14 +390,14 @@ private void checkForCRUD(final AbstractApexNode<?> node, final Object data, fin
}
}
- private HashSet<ASTMethodCallExpression> getPreviousMethodCalls(final AbstractApexNode<?> self) {
- final HashSet<ASTMethodCallExpression> innerMethodCalls = new HashSet<>();
+ private Set<ASTMethodCallExpression> getPreviousMethodCalls(final AbstractApexNode<?> self) {
+ final Set<ASTMethodCallExpression> innerMethodCalls = new HashSet<>();
final ASTMethod outerMethod = self.getFirstParentOfType(ASTMethod.class);
if (outerMethod != null) {
final ASTBlockStatement blockStatement = outerMethod.getFirstChildOfType(ASTBlockStatement.class);
recursivelyEvaluateCRUDMethodCalls(self, innerMethodCalls, blockStatement);
- final List<ASTMethod> constructorMethods = findConstructorlMethods(self);
+ final List<ASTMethod> constructorMethods = findConstructorlMethods();
for (ASTMethod method : constructorMethods) {
innerMethodCalls.addAll(method.findDescendantsOfType(ASTMethodCallExpression.class));
}
@@ -426,7 +410,7 @@ private HashSet<ASTMethodCallExpression> getPreviousMethodCalls(final AbstractAp
}
private void recursivelyEvaluateCRUDMethodCalls(final AbstractApexNode<?> self,
- final HashSet<ASTMethodCallExpression> innerMethodCalls, final ASTBlockStatement blockStatement) {
+ final Set<ASTMethodCallExpression> innerMethodCalls, final ASTBlockStatement blockStatement) {
if (blockStatement != null) {
int numberOfStatements = blockStatement.jjtGetNumChildren();
for (int i = 0; i < numberOfStatements; i++) {
@@ -440,7 +424,7 @@ private void recursivelyEvaluateCRUDMethodCalls(final AbstractApexNode<?> self,
}
AbstractApexNode<?> match = n.getFirstDescendantOfType(self.getClass());
- if (match == self) {
+ if (Objects.equal(match, self)) {
break;
}
ASTMethodCallExpression methodCall = n.getFirstDescendantOfType(ASTMethodCallExpression.class);
@@ -453,9 +437,9 @@ private void recursivelyEvaluateCRUDMethodCalls(final AbstractApexNode<?> self,
}
private void mapCallToMethodDecl(final AbstractApexNode<?> self,
- final HashSet<ASTMethodCallExpression> innerMethodCalls, final List<ASTMethodCallExpression> nodes) {
+ final Set<ASTMethodCallExpression> innerMethodCalls, final List<ASTMethodCallExpression> nodes) {
for (ASTMethodCallExpression node : nodes) {
- if (node == self) {
+ if (Objects.equal(node, self)) {
break;
}
@@ -467,10 +451,11 @@ private void mapCallToMethodDecl(final AbstractApexNode<?> self,
}
}
- private List<ASTMethod> findConstructorlMethods(final AbstractApexNode<?> node) {
+ private List<ASTMethod> findConstructorlMethods() {
final ArrayList<ASTMethod> ret = new ArrayList<>();
final Set<String> constructors = classMethods.keySet().stream()
- .filter(p -> (p.contains("<init>") || p.contains("<clinit>"))).collect(Collectors.toSet());
+ .filter(p -> p.contains("<init>") || p.contains("<clinit>")
+ || p.startsWith(className + ":" + className + ":")).collect(Collectors.toSet());
for (String c : constructors) {
ret.add(classMethods.get(c));
@@ -504,10 +489,10 @@ private void extractObjectTypeFromESAPI(final ASTMethodCallExpression node, fina
if (var != null) {
final ASTReferenceExpression reference = var.getFirstChildOfType(ASTReferenceExpression.class);
if (reference != null) {
- List<Identifier> identifiers = reference.getNode().getJadtIdentifiers();
+ List<Identifier> identifiers = reference.getNode().getNames();
if (identifiers.size() == 1) {
StringBuilder sb = new StringBuilder().append(node.getNode().getDefiningType().getApexName())
- .append(":").append(identifiers.get(0).value);
+ .append(":").append(identifiers.get(0).getValue());
checkedTypeToDMLOperationViaESAPI.put(sb.toString(), dmlOperation);
}
@@ -547,7 +532,7 @@ private void checkForAccessibility(final ASTSoqlExpression node, Object data) {
final boolean isCount = node.getNode().getCanonicalQuery().startsWith("SELECT COUNT()");
final Set<String> typesFromSOQL = getTypesFromSOQLQuery(node);
- final HashSet<ASTMethodCallExpression> prevCalls = getPreviousMethodCalls(node);
+ final Set<ASTMethodCallExpression> prevCalls = getPreviousMethodCalls(node);
for (ASTMethodCallExpression prevCall : prevCalls) {
collectCRUDMethodLevelChecks(prevCall);
}
@@ -558,8 +543,9 @@ private void checkForAccessibility(final ASTSoqlExpression node, Object data) {
final ASTMethod wrappingMethod = node.getFirstParentOfType(ASTMethod.class);
final ASTUserClass wrappingClass = node.getFirstParentOfType(ASTUserClass.class);
- if (isCount || (wrappingClass != null && Helper.isTestMethodOrClass(wrappingClass))
- || (wrappingMethod != null && Helper.isTestMethodOrClass(wrappingMethod))) {
+ if (isCount
+ || wrappingClass != null && Helper.isTestMethodOrClass(wrappingClass)
+ || wrappingMethod != null && Helper.isTestMethodOrClass(wrappingMethod)) {
return;
}
@@ -646,6 +632,6 @@ private boolean isMethodAGetter(final ASTMethod method) {
.matcher(method.getNode().getMethodInfo().getEmitSignature().getReturnType().getApexName()).matches();
final boolean noParams = method.findChildrenOfType(ASTParameter.class).isEmpty();
- return (startsWithGet && noParams && !voidOrString);
+ return startsWithGet && noParams && !voidOrString;
}
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexCSRFRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexCSRFRule.java
index d4aff9c94d8..0d24dc782c3 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexCSRFRule.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexCSRFRule.java
@@ -6,7 +6,6 @@
import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
-import net.sourceforge.pmd.lang.apex.ast.ApexNode;
import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
/**
@@ -31,7 +30,7 @@ public Object visit(ASTUserClass node, Object data) {
return data; // stops all the rules
}
- return visit((ApexNode<?>) node, data);
+ return super.visit(node, data);
}
@Override
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexDangerousMethodsRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexDangerousMethodsRule.java
index c3726a8b893..91d9a6dfe4a 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexDangerousMethodsRule.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexDangerousMethodsRule.java
@@ -6,6 +6,7 @@
import java.util.HashSet;
import java.util.List;
+import java.util.Set;
import java.util.regex.Pattern;
import net.sourceforge.pmd.lang.apex.ast.ASTField;
@@ -19,8 +20,8 @@
* Flags dangerous method calls, e.g. FinancialForce
* Configuration.disableTriggerCRUDSecurity() or System.debug with sensitive
* input
- *
- *
+ *
+ *
* @author sergey.gorbaty
*
*/
@@ -35,7 +36,7 @@ public class ApexDangerousMethodsRule extends AbstractApexRule {
private static final String SYSTEM = "System";
private static final String DEBUG = "debug";
- private final HashSet<String> whiteListedVariables = new HashSet<>();
+ private final Set<String> whiteListedVariables = new HashSet<>();
public ApexDangerousMethodsRule() {
super.addRuleChainVisit(ASTUserClass.class);
@@ -45,6 +46,7 @@ public ApexDangerousMethodsRule() {
}
+ @Override
public Object visit(ASTUserClass node, Object data) {
if (Helper.isTestMethodOrClass(node)) {
return data;
@@ -89,7 +91,7 @@ private void collectBenignVariables(ASTUserClass node) {
private void validateParameters(ASTMethodCallExpression methodCall, Object data) {
List<ASTVariableExpression> variables = methodCall.findDescendantsOfType(ASTVariableExpression.class);
for (ASTVariableExpression var : variables) {
- if (REGEXP.matcher(var.getNode().getIdentifier().value).matches()) {
+ if (REGEXP.matcher(var.getNode().getIdentifier().getValue()).matches()) {
if (!whiteListedVariables.contains(Helper.getFQVariableName(var))) {
addViolation(data, methodCall);
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexInsecureEndpointRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexInsecureEndpointRule.java
index 847c6ce4cd9..aff2755b474 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexInsecureEndpointRule.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexInsecureEndpointRule.java
@@ -39,23 +39,23 @@ public ApexInsecureEndpointRule() {
@Override
public Object visit(ASTAssignmentExpression node, Object data) {
- findInsecureEndpoints(node, data);
+ findInsecureEndpoints(node);
return data;
}
@Override
public Object visit(ASTVariableDeclaration node, Object data) {
- findInsecureEndpoints(node, data);
+ findInsecureEndpoints(node);
return data;
}
@Override
public Object visit(ASTFieldDeclaration node, Object data) {
- findInsecureEndpoints(node, data);
+ findInsecureEndpoints(node);
return data;
}
- private void findInsecureEndpoints(AbstractApexNode<?> node, Object data) {
+ private void findInsecureEndpoints(AbstractApexNode<?> node) {
ASTVariableExpression variableNode = node.getFirstChildOfType(ASTVariableExpression.class);
findInnerInsecureEndpoints(node, variableNode);
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexOpenRedirectRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexOpenRedirectRule.java
index 7a3e25e35bc..3485828004a 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexOpenRedirectRule.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexOpenRedirectRule.java
@@ -22,8 +22,8 @@
import net.sourceforge.pmd.lang.apex.ast.ApexNode;
import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
-import apex.jorje.data.ast.Identifier;
-import apex.jorje.data.ast.TypeRef.ClassTypeRef;
+import apex.jorje.data.Identifier;
+import apex.jorje.data.ast.TypeRefs.ClassTypeRef;
import apex.jorje.semantic.symbol.member.variable.StandardFieldInfo;
/**
@@ -121,7 +121,7 @@ private void findSafeLiterals(AbstractApexNode<?> node) {
} catch (NoSuchFieldException | SecurityException | IllegalArgumentException
| IllegalAccessException e) {
- // preventing exceptions from this code
+ throw new RuntimeException(e);
}
}
}
@@ -160,9 +160,9 @@ private void checkNewObjects(ASTNewObjectExpression node, Object data) {
}
ClassTypeRef classRef = (ClassTypeRef) node.getNode().getTypeRef();
- Identifier identifier = classRef.className.get(0);
+ Identifier identifier = classRef.getNames().get(0);
- if (identifier.value.equalsIgnoreCase(PAGEREFERENCE)) {
+ if (identifier.getValue().equalsIgnoreCase(PAGEREFERENCE)) {
getObjectValue(node, data);
}
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexSOQLInjectionRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexSOQLInjectionRule.java
index 94a46f32114..ced42d6b7e7 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexSOQLInjectionRule.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexSOQLInjectionRule.java
@@ -7,6 +7,9 @@
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
+import java.util.Locale;
+import java.util.Map;
+import java.util.Set;
import java.util.regex.Pattern;
import net.sourceforge.pmd.lang.apex.ast.ASTAssignmentExpression;
@@ -45,8 +48,8 @@ public class ApexSOQLInjectionRule extends AbstractApexRule {
private static final String DATABASE = "Database";
private static final String QUERY = "query";
private static final Pattern SELECT_PATTERN = Pattern.compile("^select[\\s]+?.*?$", Pattern.CASE_INSENSITIVE);
- private final HashSet<String> safeVariables = new HashSet<>();
- private final HashMap<String, Boolean> selectContainingVariables = new HashMap<>();
+ private final Set<String> safeVariables = new HashSet<>();
+ private final Map<String, Boolean> selectContainingVariables = new HashMap<>();
public ApexSOQLInjectionRule() {
setProperty(CODECLIMATE_CATEGORIES, "Security");
@@ -106,7 +109,7 @@ public Object visit(ASTUserClass node, Object data) {
private void findSafeVariablesInSignature(ASTMethod m) {
List<Parameter> parameters = m.getNode().getMethodInfo().getParameters();
for (Parameter p : parameters) {
- switch (p.getType().getApexName().toLowerCase()) {
+ switch (p.getType().getApexName().toLowerCase(Locale.ROOT)) {
case ID:
case INTEGER:
case BOOLEAN:
@@ -157,7 +160,7 @@ private void findSanitizedVariables(AbstractApexNode<?> node) {
if (node instanceof ASTVariableDeclaration) {
VariableDeclaration o = (VariableDeclaration) node.getNode();
- switch (o.getLocalInfo().getType().getApexName().toLowerCase()) {
+ switch (o.getLocalInfo().getType().getApexName().toLowerCase(Locale.ROOT)) {
case INTEGER:
case ID:
case BOOLEAN:
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexSuggestUsingNamedCredRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexSuggestUsingNamedCredRule.java
index 234a023d168..ed17d500025 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexSuggestUsingNamedCredRule.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexSuggestUsingNamedCredRule.java
@@ -67,7 +67,7 @@ public Object visit(ASTUserClass node, Object data) {
private void findFieldLiterals(final ASTField fDecl) {
Object f = fDecl.getNode().getFieldInfo().getValue();
- if (f != null && f instanceof String) {
+ if (f instanceof String) {
final String fieldValue = (String) f;
if (AUTHORIZATION.equalsIgnoreCase(fieldValue)) {
listOfAuthorizationVariables.add(Helper.getFQVariableName(fDecl));
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexXSSFromURLParamRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexXSSFromURLParamRule.java
index 73db6e61112..1a2e588442a 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexXSSFromURLParamRule.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/ApexXSSFromURLParamRule.java
@@ -18,7 +18,6 @@
import net.sourceforge.pmd.lang.apex.ast.ASTVariableDeclaration;
import net.sourceforge.pmd.lang.apex.ast.ASTVariableExpression;
import net.sourceforge.pmd.lang.apex.ast.AbstractApexNode;
-import net.sourceforge.pmd.lang.apex.ast.ApexNode;
import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
/**
@@ -61,7 +60,7 @@ public Object visit(ASTUserClass node, Object data) {
return data; // stops all the rules
}
- return visit((ApexNode<?>) node, data);
+ return super.visit(node, data);
}
@Override
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/Helper.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/Helper.java
index 9a266138f5a..4aae2678930 100644
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/Helper.java
+++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/security/Helper.java
@@ -4,9 +4,9 @@
package net.sourceforge.pmd.lang.apex.rule.security;
-import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
+import java.util.Locale;
import net.sourceforge.pmd.lang.apex.ast.ASTDmlDeleteStatement;
import net.sourceforge.pmd.lang.apex.ast.ASTDmlInsertStatement;
@@ -27,9 +27,8 @@
import net.sourceforge.pmd.lang.apex.ast.ASTVariableExpression;
import net.sourceforge.pmd.lang.apex.ast.ApexNode;
-import apex.jorje.data.ast.Identifier;
+import apex.jorje.data.Identifier;
import apex.jorje.data.ast.TypeRef;
-import apex.jorje.data.ast.TypeRef.ClassTypeRef;
import apex.jorje.semantic.ast.expression.MethodCallExpression;
import apex.jorje.semantic.ast.expression.NewKeyValueObjectExpression;
import apex.jorje.semantic.ast.expression.VariableExpression;
@@ -45,7 +44,7 @@
*
*/
public final class Helper {
- protected static final String ANY_METHOD = "*";
+ static final String ANY_METHOD = "*";
private Helper() {
throw new AssertionError("Can't instantiate helper classes");
@@ -60,22 +59,14 @@ static boolean isTestMethodOrClass(final ApexNode<?> node) {
}
final String className = node.getNode().getDefiningType().getApexName();
- if (className.endsWith("Test")) {
- return true;
- }
-
- return false;
+ return className.endsWith("Test");
}
static boolean foundAnySOQLorSOSL(final ApexNode<?> node) {
final List<ASTSoqlExpression> dmlSoqlExpression = node.findDescendantsOfType(ASTSoqlExpression.class);
final List<ASTSoslExpression> dmlSoslExpression = node.findDescendantsOfType(ASTSoslExpression.class);
- if (dmlSoqlExpression.isEmpty() && dmlSoslExpression.isEmpty()) {
- return false;
- }
-
- return true;
+ return !dmlSoqlExpression.isEmpty() || !dmlSoslExpression.isEmpty();
}
/**
@@ -95,27 +86,17 @@ static boolean foundAnyDML(final ApexNode<?> node) {
final List<ASTDmlInsertStatement> dmlInsertStatement = node.findDescendantsOfType(ASTDmlInsertStatement.class);
final List<ASTDmlDeleteStatement> dmlDeleteStatement = node.findDescendantsOfType(ASTDmlDeleteStatement.class);
- if (dmlUpsertStatement.isEmpty() && dmlUpdateStatement.isEmpty() && dmlUndeleteStatement.isEmpty()
- && dmlMergeStatement.isEmpty() && dmlInsertStatement.isEmpty() && dmlDeleteStatement.isEmpty()) {
- return false;
- }
-
- return true;
+ return !dmlUpsertStatement.isEmpty() || !dmlUpdateStatement.isEmpty() || !dmlUndeleteStatement.isEmpty()
+ || !dmlMergeStatement.isEmpty() || !dmlInsertStatement.isEmpty() || !dmlDeleteStatement.isEmpty();
}
static boolean isMethodName(final ASTMethodCallExpression methodNode, final String className,
final String methodName) {
final ASTReferenceExpression reference = methodNode.getFirstChildOfType(ASTReferenceExpression.class);
- if (reference.getNode().getJadtIdentifiers().size() == 1) {
- if (reference.getNode().getJadtIdentifiers().get(0).value.equalsIgnoreCase(className)) {
- if (methodName.equals(ANY_METHOD) || isMethodName(methodNode, methodName)) {
- return true;
- }
- }
- }
-
- return false;
+ return reference != null && reference.getNode().getNames().size() == 1
+ && reference.getNode().getNames().get(0).getValue().equalsIgnoreCase(className)
+ && (methodName.equals(ANY_METHOD) || isMethodName(methodNode, methodName));
}
static boolean isMethodName(final ASTMethodCallExpression m, final String methodName) {
@@ -152,14 +133,14 @@ static String getFQVariableName(final ASTVariableExpression variable) {
final ASTReferenceExpression ref = variable.getFirstChildOfType(ASTReferenceExpression.class);
String objectName = "";
if (ref != null) {
- if (ref.getNode().getJadtIdentifiers().size() == 1) {
- objectName = ref.getNode().getJadtIdentifiers().get(0).value + ".";
+ if (ref.getNode().getNames().size() == 1) {
+ objectName = ref.getNode().getNames().get(0).getValue() + ".";
}
}
VariableExpression n = variable.getNode();
StringBuilder sb = new StringBuilder().append(n.getDefiningType().getApexName()).append(":").append(objectName)
- .append(n.getIdentifier().value);
+ .append(n.getIdentifier().getValue());
return sb.toString();
}
@@ -192,9 +173,10 @@ static String getFQVariableName(final ASTFieldDeclaration variable) {
java.lang.reflect.Field f = n.getClass().getDeclaredField("name");
f.setAccessible(true);
Identifier nameField = (Identifier) f.get(n);
- name = nameField.value;
+ name = nameField.getValue();
} catch (NoSuchFieldException | SecurityException | IllegalArgumentException | IllegalAccessException e) {
+ throw new RuntimeException(e);
}
StringBuilder sb = new StringBuilder().append(n.getDefiningType().getApexName()).append(":").append(name);
@@ -203,15 +185,8 @@ static String getFQVariableName(final ASTFieldDeclaration variable) {
static String getFQVariableName(final ASTNewKeyValueObjectExpression variable) {
NewKeyValueObjectExpression n = variable.getNode();
- String objType = "";
- try {
- // no other way to get this field, Apex Jorje does not expose it
- java.lang.reflect.Field f = n.getClass().getDeclaredField("typeRef");
- f.setAccessible(true);
- ClassTypeRef hiddenField = (ClassTypeRef) f.get(n);
- objType = hiddenField.className.get(0).value;
- } catch (NoSuchFieldException | SecurityException | IllegalArgumentException | IllegalAccessException e) {
- }
+ TypeRef typeRef = n.getTypeRef();
+ String objType = typeRef.getNames().get(0).getValue();
StringBuilder sb = new StringBuilder().append(n.getDefiningType().getApexName()).append(":").append(objType);
return sb.toString();
@@ -219,19 +194,11 @@ static String getFQVariableName(final ASTNewKeyValueObjectExpression variable) {
static boolean isSystemLevelClass(ASTUserClass node) {
List<TypeRef> interfaces = node.getNode().getDefiningType().getCodeUnitDetails().getInterfaceTypeRefs();
- for (TypeRef intObject : interfaces) {
- try {
- java.lang.reflect.Field f = intObject.getClass().getDeclaredField("className");
- f.setAccessible(true);
- @SuppressWarnings("unchecked")
- ArrayList<Identifier> ids = (ArrayList<Identifier>) f.get(intObject);
- if (isWhitelisted(ids)) {
- return true;
- }
- } catch (NoSuchFieldException | SecurityException | IllegalArgumentException | IllegalAccessException e) {
+ for (TypeRef intObject : interfaces) {
+ if (isWhitelisted(intObject.getNames())) {
+ return true;
}
-
}
return false;
@@ -241,14 +208,14 @@ private static boolean isWhitelisted(List<Identifier> ids) {
StringBuffer sb = new StringBuffer();
for (int i = 0; i < ids.size(); i++) {
- sb.append(ids.get(i).value);
+ sb.append(ids.get(i).getValue());
- if (i != (ids.size() - 1)) {
+ if (i != ids.size() - 1) {
sb.append(".");
}
}
- switch (sb.toString().toLowerCase()) {
+ switch (sb.toString().toLowerCase(Locale.ROOT)) {
case "queueable":
case "database.batchable":
case "installhandler":
@@ -260,8 +227,8 @@ private static boolean isWhitelisted(List<Identifier> ids) {
}
public static String getFQVariableName(Parameter p) {
- StringBuffer sb = new StringBuffer();
- sb.append(p.getDefiningType()).append(":").append(p.getName().value);
+ StringBuffer sb = new StringBuffer();
+ sb.append(p.getDefiningType()).append(":").append(p.getName().getValue());
return sb.toString();
}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/style/AvoidGlobalModifierRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/style/AvoidGlobalModifierRule.java
deleted file mode 100644
index 46045bd4979..00000000000
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/style/AvoidGlobalModifierRule.java
+++ /dev/null
@@ -1,42 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.rule.style;
-
-import static apex.jorje.semantic.symbol.type.ModifierTypeInfos.GLOBAL;
-
-import net.sourceforge.pmd.lang.apex.ast.ASTModifierNode;
-import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
-import net.sourceforge.pmd.lang.apex.ast.ASTUserInterface;
-import net.sourceforge.pmd.lang.apex.ast.ApexNode;
-import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
-
-public class AvoidGlobalModifierRule extends AbstractApexRule {
-
- public AvoidGlobalModifierRule() {
- setProperty(CODECLIMATE_CATEGORIES, "Style");
- setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 100);
- setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
- }
-
- @Override
- public Object visit(ASTUserClass node, Object data) {
- return checkForGlobal(node, data);
- }
-
- @Override
- public Object visit(ASTUserInterface node, Object data) {
- return checkForGlobal(node, data);
- }
-
- private Object checkForGlobal(ApexNode<?> node, Object data) {
- ASTModifierNode modifierNode = node.getFirstChildOfType(ASTModifierNode.class);
-
- if (modifierNode != null && modifierNode.getNode().getModifiers().has(GLOBAL)) {
- addViolation(data, node);
- }
-
- return data;
- }
-}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/style/ClassNamingConventionsRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/style/ClassNamingConventionsRule.java
deleted file mode 100644
index 8a9a1dfaa36..00000000000
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/style/ClassNamingConventionsRule.java
+++ /dev/null
@@ -1,33 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.rule.style;
-
-import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
-import net.sourceforge.pmd.lang.apex.ast.ASTUserInterface;
-import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
-
-public class ClassNamingConventionsRule extends AbstractApexRule {
-
- public ClassNamingConventionsRule() {
- setProperty(CODECLIMATE_CATEGORIES, "Style");
- // Note: x10 as Apex has not automatic refactoring
- setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 5);
- setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
- }
-
- public Object visit(ASTUserClass node, Object data) {
- if (Character.isLowerCase(node.getImage().charAt(0))) {
- addViolation(data, node);
- }
- return data;
- }
-
- public Object visit(ASTUserInterface node, Object data) {
- if (Character.isLowerCase(node.getImage().charAt(0))) {
- addViolation(data, node);
- }
- return data;
- }
-}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/style/MethodNamingConventionsRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/style/MethodNamingConventionsRule.java
deleted file mode 100644
index 1d251a6fdf7..00000000000
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/style/MethodNamingConventionsRule.java
+++ /dev/null
@@ -1,54 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.rule.style;
-
-import static apex.jorje.semantic.symbol.type.ModifierTypeInfos.OVERRIDE;
-
-import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
-import net.sourceforge.pmd.lang.apex.ast.ASTProperty;
-import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
-import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
-
-public class MethodNamingConventionsRule extends AbstractApexRule {
-
- public MethodNamingConventionsRule() {
- setProperty(CODECLIMATE_CATEGORIES, "Style");
- // Note: x10 as Apex has not automatic refactoring
- setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 1);
- setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
- }
-
- public Object visit(ASTUserClass node, Object data) {
- return super.visit(node, data);
- }
-
- public Object visit(ASTMethod node, Object data) {
- if (isOverriddenMethod(node) || isPropertyAccessor(node) || isConstructor(node)) {
- return data;
- }
-
- String methodName = node.getImage();
-
- if (Character.isUpperCase(methodName.charAt(0))) {
- addViolationWithMessage(data, node, "Method names should not start with capital letters");
- }
- if (methodName.indexOf('_') >= 0) {
- addViolationWithMessage(data, node, "Method names should not contain underscores");
- }
- return data;
- }
-
- private boolean isOverriddenMethod(ASTMethod node) {
- return node.getNode().getModifiers().has(OVERRIDE);
- }
-
- private boolean isPropertyAccessor(ASTMethod node) {
- return (node.getParentsOfType(ASTProperty.class).size() > 0);
- }
-
- private boolean isConstructor(ASTMethod node) {
- return (node.getNode().getMethodInfo().isConstructor());
- }
-}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/style/MethodWithSameNameAsEnclosingClassRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/style/MethodWithSameNameAsEnclosingClassRule.java
deleted file mode 100644
index 1cbc197aacb..00000000000
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/style/MethodWithSameNameAsEnclosingClassRule.java
+++ /dev/null
@@ -1,38 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.rule.style;
-
-import java.util.List;
-
-import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
-import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
-import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
-
-public class MethodWithSameNameAsEnclosingClassRule extends AbstractApexRule {
-
- public MethodWithSameNameAsEnclosingClassRule() {
- setProperty(CODECLIMATE_CATEGORIES, "Style");
- // Note: x10 as Apex has not automatic refactoring
- setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 50);
- setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
- }
-
- @Override
- public Object visit(ASTUserClass node, Object data) {
- String className = node.getImage();
-
- List<ASTMethod> methods = node.findDescendantsOfType(ASTMethod.class);
-
- for (ASTMethod m : methods) {
- String methodName = m.getImage();
-
- if (!m.getNode().getMethodInfo().isConstructor() && methodName.equalsIgnoreCase(className)) {
- addViolation(data, m);
- }
- }
-
- return super.visit(node, data);
- }
-}
diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/style/VariableNamingConventionsRule.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/style/VariableNamingConventionsRule.java
deleted file mode 100644
index 38252a66f62..00000000000
--- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/style/VariableNamingConventionsRule.java
+++ /dev/null
@@ -1,222 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.rule.style;
-
-import static apex.jorje.semantic.symbol.type.ModifierTypeInfos.FINAL;
-import static apex.jorje.semantic.symbol.type.ModifierTypeInfos.STATIC;
-
-import java.util.List;
-
-import net.sourceforge.pmd.lang.apex.ast.ASTField;
-import net.sourceforge.pmd.lang.apex.ast.ASTParameter;
-import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
-import net.sourceforge.pmd.lang.apex.ast.ASTUserInterface;
-import net.sourceforge.pmd.lang.apex.ast.ASTVariableDeclaration;
-import net.sourceforge.pmd.lang.apex.ast.ApexNode;
-import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
-import net.sourceforge.pmd.properties.BooleanProperty;
-import net.sourceforge.pmd.properties.PropertyDescriptor;
-import net.sourceforge.pmd.properties.StringMultiProperty;
-
-public class VariableNamingConventionsRule extends AbstractApexRule {
-
- private boolean checkMembers;
- private boolean checkLocals;
- private boolean checkParameters;
- private List<String> staticPrefixes;
- private List<String> staticSuffixes;
- private List<String> memberPrefixes;
- private List<String> memberSuffixes;
- private List<String> localPrefixes;
- private List<String> localSuffixes;
- private List<String> parameterPrefixes;
- private List<String> parameterSuffixes;
-
- private static final BooleanProperty CHECK_MEMBERS_DESCRIPTOR = new BooleanProperty("checkMembers",
- "Check member variables", true, 1.0f);
-
- private static final BooleanProperty CHECK_LOCALS_DESCRIPTOR = new BooleanProperty("checkLocals",
- "Check local variables", true, 2.0f);
-
- private static final BooleanProperty CHECK_PARAMETERS_DESCRIPTOR = new BooleanProperty("checkParameters",
- "Check constructor and method parameter variables", true, 3.0f);
-
- private static final StringMultiProperty STATIC_PREFIXES_DESCRIPTOR = new StringMultiProperty("staticPrefix",
- "Static variable prefixes", new String[] { "" }, 4.0f, ',');
-
- private static final StringMultiProperty STATIC_SUFFIXES_DESCRIPTOR = new StringMultiProperty("staticSuffix",
- "Static variable suffixes", new String[] { "" }, 5.0f, ',');
-
- private static final StringMultiProperty MEMBER_PREFIXES_DESCRIPTOR = new StringMultiProperty("memberPrefix",
- "Member variable prefixes", new String[] { "" }, 6.0f, ',');
-
- private static final StringMultiProperty MEMBER_SUFFIXES_DESCRIPTOR = new StringMultiProperty("memberSuffix",
- "Member variable suffixes", new String[] { "" }, 7.0f, ',');
-
- private static final StringMultiProperty LOCAL_PREFIXES_DESCRIPTOR = new StringMultiProperty("localPrefix",
- "Local variable prefixes", new String[] { "" }, 8.0f, ',');
-
- private static final StringMultiProperty LOCAL_SUFFIXES_DESCRIPTOR = new StringMultiProperty("localSuffix",
- "Local variable suffixes", new String[] { "" }, 9.0f, ',');
-
- private static final StringMultiProperty PARAMETER_PREFIXES_DESCRIPTOR = new StringMultiProperty("parameterPrefix",
- "Method parameter variable prefixes", new String[] { "" }, 10.0f, ',');
-
- private static final StringMultiProperty PARAMETER_SUFFIXES_DESCRIPTOR = new StringMultiProperty("parameterSuffix",
- "Method parameter variable suffixes", new String[] { "" }, 11.0f, ',');
-
- public VariableNamingConventionsRule() {
- definePropertyDescriptor(CHECK_MEMBERS_DESCRIPTOR);
- definePropertyDescriptor(CHECK_LOCALS_DESCRIPTOR);
- definePropertyDescriptor(CHECK_PARAMETERS_DESCRIPTOR);
- definePropertyDescriptor(STATIC_PREFIXES_DESCRIPTOR);
- definePropertyDescriptor(STATIC_SUFFIXES_DESCRIPTOR);
- definePropertyDescriptor(MEMBER_PREFIXES_DESCRIPTOR);
- definePropertyDescriptor(MEMBER_SUFFIXES_DESCRIPTOR);
- definePropertyDescriptor(LOCAL_PREFIXES_DESCRIPTOR);
- definePropertyDescriptor(LOCAL_SUFFIXES_DESCRIPTOR);
- definePropertyDescriptor(PARAMETER_PREFIXES_DESCRIPTOR);
- definePropertyDescriptor(PARAMETER_SUFFIXES_DESCRIPTOR);
-
- setProperty(CODECLIMATE_CATEGORIES, "Style");
- // Note: x10 as Apex has not automatic refactoring
- setProperty(CODECLIMATE_REMEDIATION_MULTIPLIER, 5);
- setProperty(CODECLIMATE_BLOCK_HIGHLIGHTING, false);
- }
-
- public Object visit(ASTUserClass node, Object data) {
- init();
- return super.visit(node, data);
- }
-
- public Object visit(ASTUserInterface node, Object data) {
- init();
- return super.visit(node, data);
- }
-
- protected void init() {
- checkMembers = getProperty(CHECK_MEMBERS_DESCRIPTOR);
- checkLocals = getProperty(CHECK_LOCALS_DESCRIPTOR);
- checkParameters = getProperty(CHECK_PARAMETERS_DESCRIPTOR);
- staticPrefixes = getProperty(STATIC_PREFIXES_DESCRIPTOR);
- staticSuffixes = getProperty(STATIC_SUFFIXES_DESCRIPTOR);
- memberPrefixes = getProperty(MEMBER_PREFIXES_DESCRIPTOR);
- memberSuffixes = getProperty(MEMBER_SUFFIXES_DESCRIPTOR);
- localPrefixes = getProperty(LOCAL_PREFIXES_DESCRIPTOR);
- localSuffixes = getProperty(LOCAL_SUFFIXES_DESCRIPTOR);
- parameterPrefixes = getProperty(PARAMETER_PREFIXES_DESCRIPTOR);
- parameterSuffixes = getProperty(PARAMETER_SUFFIXES_DESCRIPTOR);
- }
-
- public Object visit(ASTField node, Object data) {
- if (!checkMembers) {
- return data;
- }
- boolean isStatic = node.getNode().getFieldInfo().getModifiers().has(STATIC);
- boolean isFinal = node.getNode().getFieldInfo().getModifiers().has(FINAL);
-
- return checkName(isStatic ? staticPrefixes : memberPrefixes, isStatic ? staticSuffixes : memberSuffixes, node,
- isStatic, isFinal, data);
- }
-
- public Object visit(ASTVariableDeclaration node, Object data) {
-
- if (!checkLocals) {
- return data;
- }
-
- boolean isFinal = node.getNode().getLocalInfo().getModifiers().has(FINAL);
- return checkName(localPrefixes, localSuffixes, node, false, isFinal, data);
- }
-
- public Object visit(ASTParameter node, Object data) {
- if (!checkParameters) {
- return data;
- }
-
- boolean isFinal = node.getNode().getModifierInfo().has(FINAL);
- return checkName(parameterPrefixes, parameterSuffixes, node, false, isFinal, data);
- }
-
- private Object checkName(List<String> prefixes, List<String> suffixes, ApexNode<?> node, boolean isStatic, boolean isFinal,
- Object data) {
-
- String varName = node.getImage();
-
- // Skip on null (with exception classes) and serialVersionUID
- if (varName == null || "serialVersionUID".equals(varName)) {
- return data;
- }
-
- // Static finals should be uppercase
- if (isStatic && isFinal) {
- if (!varName.equals(varName.toUpperCase())) {
- addViolationWithMessage(data, node,
- "Variables that are final and static should be all capitals, ''{0}'' is not all capitals.",
- new Object[] { varName });
- }
- return data;
- } else if (!isFinal) {
- String normalizedVarName = normalizeVariableName(varName, prefixes, suffixes);
-
- if (normalizedVarName.indexOf('_') >= 0) {
- addViolationWithMessage(data, node,
- "Only variables that are final should contain underscores (except for underscores in standard prefix/suffix), ''{0}'' is not final.",
- new Object[] { varName });
- }
- if (Character.isUpperCase(varName.charAt(0))) {
- addViolationWithMessage(data, node,
- "Variables should start with a lowercase character, ''{0}'' starts with uppercase character.",
- new Object[] { varName });
- }
- }
- return data;
- }
-
- private String normalizeVariableName(String varName, List<String> prefixes, List<String> suffixes) {
- return stripSuffix(stripPrefix(varName, prefixes), suffixes);
- }
-
- private String stripSuffix(String varName, List<String> suffixes) {
- if (suffixes != null) {
- for (String suffix : suffixes) {
- if (varName.endsWith(suffix)) {
- varName = varName.substring(0, varName.length() - suffix.length());
- break;
- }
- }
- }
- return varName;
- }
-
- private String stripPrefix(String varName, List<String> prefixes) {
- if (prefixes != null) {
- for (String prefix : prefixes) {
- if (varName.startsWith(prefix)) {
- return varName.substring(prefix.length());
- }
- }
- }
- return varName;
- }
-
- public boolean hasPrefixesOrSuffixes() {
-
- for (PropertyDescriptor<?> desc : getPropertyDescriptors()) {
- if (desc instanceof StringMultiProperty) {
- List<String> values = getProperty((StringMultiProperty) desc);
- if (!values.isEmpty()) {
- return true;
- }
- }
- }
- return false;
- }
-
- public String dysfunctionReason() {
- return hasPrefixesOrSuffixes() ? null : "No prefixes or suffixes specified";
- }
-
-}
diff --git a/pmd-apex/src/main/resources/category/apex/bestpractices.xml b/pmd-apex/src/main/resources/category/apex/bestpractices.xml
new file mode 100644
index 00000000000..1ac782d8b18
--- /dev/null
+++ b/pmd-apex/src/main/resources/category/apex/bestpractices.xml
@@ -0,0 +1,112 @@
+<?xml version="1.0"?>
+
+<ruleset name="Best Practices"
+ xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
+
+ <description>
+Rules which enforce generally accepted best practices.
+ </description>
+
+ <rule name="ApexUnitTestClassShouldHaveAsserts"
+ since="5.5.1"
+ message="Apex unit tests should System.assert() or assertEquals() or assertNotEquals()"
+ class="net.sourceforge.pmd.lang.apex.rule.bestpractices.ApexUnitTestClassShouldHaveAssertsRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_bestpractices.html#apexunittestclassshouldhaveasserts">
+ <description>
+Apex unit tests should include at least one assertion. This makes the tests more robust, and using assert
+with messages provide the developer a clearer idea of what the test does.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+@isTest
+public class Foo {
+ public static testMethod void testSomething() {
+ Account a = null;
+ // This is better than having a NullPointerException
+ // System.assertNotEquals(a, null, 'account not found');
+ a.toString();
+ }
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="ApexUnitTestShouldNotUseSeeAllDataTrue"
+ since="5.5.1"
+ message="Apex unit tests should not use @isTest(seeAllData = true)"
+ class="net.sourceforge.pmd.lang.apex.rule.bestpractices.ApexUnitTestShouldNotUseSeeAllDataTrueRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_bestpractices.html#apexunittestshouldnotuseseealldatatrue">
+ <description>
+Apex unit tests should not use @isTest(seeAllData=true) because it opens up the existing database data for unexpected modification by tests.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+@isTest(seeAllData = true)
+public class Foo {
+ public static testMethod void testSomething() {
+ Account a = null;
+ // This is better than having a NullPointerException
+ // System.assertNotEquals(a, null, 'account not found');
+ a.toString();
+ }
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="AvoidGlobalModifier"
+ since="5.5.0"
+ message="Avoid using global modifier"
+ class="net.sourceforge.pmd.lang.apex.rule.bestpractices.AvoidGlobalModifierRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_bestpractices.html#avoidglobalmodifier">
+ <description>
+Global classes should be avoided (especially in managed packages) as they can never be deleted or changed in signature. Always check twice if something needs to be global.
+Many interfaces (e.g. Batch) required global modifiers in the past but don't require this anymore. Don't lock yourself in.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+global class Unchangeable {
+ global UndeletableType unchangable(UndeletableType param) {
+ // ...
+ }
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="AvoidLogicInTrigger"
+ since="5.5.0"
+ message="Avoid logic in triggers"
+ class="net.sourceforge.pmd.lang.apex.rule.bestpractices.AvoidLogicInTriggerRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_bestpractices.html#avoidlogicintrigger">
+ <description>
+As triggers do not allow methods like regular classes they are less flexible and suited to apply good encapsulation style.
+Therefore delegate the triggers work to a regular class (often called Trigger handler class).
+
+See more here: https://developer.salesforce.com/page/Trigger_Frameworks_and_Apex_Trigger_Best_Practices
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+trigger Accounts on Account (before insert, before update, before delete, after insert, after update, after delete, after undelete) {
+ for(Account acc : Trigger.new) {
+ if(Trigger.isInsert) {
+ // ...
+ }
+
+ // ...
+
+ if(Trigger.isDelete) {
+ // ...
+ }
+ }
+}
+]]>
+ </example>
+ </rule>
+</ruleset>
diff --git a/pmd-apex/src/main/resources/category/apex/categories.properties b/pmd-apex/src/main/resources/category/apex/categories.properties
new file mode 100644
index 00000000000..4c45115d8f3
--- /dev/null
+++ b/pmd-apex/src/main/resources/category/apex/categories.properties
@@ -0,0 +1,17 @@
+#
+# BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+#
+
+rulesets.filenames=\
+ category/apex/bestpractices.xml,\
+ category/apex/codestyle.xml,\
+ category/apex/design.xml,\
+ category/apex/errorprone.xml,\
+ category/apex/performance.xml,\
+ category/apex/security.xml
+
+#
+# categories with no rules yet
+#
+#category/apex/documentation.xml
+#category/apex/multithreading.xml
diff --git a/pmd-apex/src/main/resources/category/apex/codestyle.xml b/pmd-apex/src/main/resources/category/apex/codestyle.xml
new file mode 100644
index 00000000000..ef53ac90d0a
--- /dev/null
+++ b/pmd-apex/src/main/resources/category/apex/codestyle.xml
@@ -0,0 +1,248 @@
+<?xml version="1.0"?>
+
+<ruleset name="Code Style"
+ xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
+
+ <description>
+Rules which enforce a specific coding style.
+ </description>
+
+ <rule name="ClassNamingConventions"
+ since="5.5.0"
+ message="Class names should begin with an uppercase character"
+ class="net.sourceforge.pmd.lang.apex.rule.codestyle.ClassNamingConventionsRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_codestyle.html#classnamingconventions">
+ <description>
+Class names should always begin with an upper case character.
+ </description>
+ <priority>1</priority>
+ <example>
+<![CDATA[
+public class Foo {}
+]]>
+ </example>
+ </rule>
+
+ <rule name="IfElseStmtsMustUseBraces"
+ language="apex"
+ since="5.6.0"
+ message="Avoid using 'if...else' statements without curly braces"
+ class="net.sourceforge.pmd.lang.apex.rule.ApexXPathRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_codestyle.html#ifelsestmtsmustusebraces">
+ <description>
+Avoid using if..else statements without using surrounding braces. If the code formatting
+or indentation is lost then it becomes difficult to separate the code being controlled
+from the rest.
+ </description>
+ <priority>3</priority>
+ <properties>
+ <property name="xpath">
+ <value>
+<![CDATA[
+//IfBlockStatement/BlockStatement[@CurlyBrace='false'][count(child::*) > 0]
+|
+//IfElseBlockStatement/BlockStatement[@CurlyBrace='false'][count(child::*) > 0]
+]]>
+ </value>
+ </property>
+ </properties>
+ <example>
+<![CDATA[
+// this is OK
+if (foo) x++;
+
+// but this is not
+if (foo)
+ x = x+1;
+else
+ x = x-1;
+]]>
+ </example>
+ </rule>
+
+ <rule name="IfStmtsMustUseBraces"
+ language="apex"
+ since="5.6.0"
+ message="Avoid using if statements without curly braces"
+ class="net.sourceforge.pmd.lang.apex.rule.ApexXPathRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_codestyle.html#ifstmtsmustusebraces">
+ <description>
+Avoid using if statements without using braces to surround the code block. If the code
+formatting or indentation is lost then it becomes difficult to separate the code being
+controlled from the rest.
+ </description>
+ <priority>3</priority>
+ <properties>
+ <property name="xpath">
+ <value>
+<![CDATA[
+//IfBlockStatement/BlockStatement[@CurlyBrace='false']
+]]>
+ </value>
+ </property>
+ </properties>
+ <example>
+ <![CDATA[
+if (foo) // not recommended
+ x++;
+
+if (foo) { // preferred approach
+ x++;
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="ForLoopsMustUseBraces"
+ language="apex"
+ since="5.6.0"
+ message="Avoid using 'for' statements without curly braces"
+ class="net.sourceforge.pmd.lang.apex.rule.ApexXPathRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_codestyle.html#forloopsmustusebraces">
+ <description>
+Avoid using 'for' statements without using surrounding braces. If the code formatting or
+indentation is lost then it becomes difficult to separate the code being controlled
+from the rest.
+ </description>
+ <priority>3</priority>
+ <properties>
+ <property name="xpath">
+ <value>
+<![CDATA[
+//ForLoopStatement/BlockStatement[@CurlyBrace='false']
+|
+//ForEachStatement/BlockStatement[@CurlyBrace='false']
+]]>
+ </value>
+ </property>
+ </properties>
+ <example>
+<![CDATA[
+for (int i = 0; i < 42; i++) // not recommended
+ foo();
+
+for (int i = 0; i < 42; i++) { // preferred approach
+ foo();
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="MethodNamingConventions"
+ since="5.5.0"
+ message="Method name does not begin with a lower case character."
+ class="net.sourceforge.pmd.lang.apex.rule.codestyle.MethodNamingConventionsRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_codestyle.html#methodnamingconventions">
+ <description>
+Method names should always begin with a lower case character, and should not contain underscores.
+ </description>
+ <priority>1</priority>
+ <example>
+<![CDATA[
+public class Foo {
+ public void fooStuff() {
+ }
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="OneDeclarationPerLine"
+ since="6.7.0"
+ message="Use one statement for each line, it enhances code readability."
+ class="net.sourceforge.pmd.lang.apex.rule.ApexXPathRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_codestyle.html#onedeclarationperline">
+ <description>
+Apex allows the use of several variables declaration of the same type on one line. However, it
+can lead to quite messy code. This rule looks for several declarations on the same line.
+ </description>
+ <priority>1</priority>
+ <properties>
+ <property name="xpath">
+ <value>
+<![CDATA[
+//VariableDeclarationStatements
+ [count(VariableDeclaration) > 1]
+ [$strictMode or count(distinct-values(VariableDeclaration/@BeginLine)) != count(VariableDeclaration)]
+|
+//FieldDeclarationStatements
+ [count(FieldDeclaration) > 1]
+ [$strictMode or count(distinct-values(FieldDeclaration/VariableExpression/@BeginLine)) != count(FieldDeclaration/VariableExpression)]
+]]>
+ </value>
+ </property>
+ <property name="version" value="2.0"/>
+ <property name="strictMode" type="Boolean" value="false"
+ description="If true, mark combined declaration even if the declarations are on separate lines."/>
+ </properties>
+ <example>
+<![CDATA[
+Integer a, b; // not recommended
+
+Integer a,
+ b; // ok by default, can be flagged setting the strictMode property
+
+Integer a; // preferred approach
+Integer b;
+]]>
+ </example>
+ </rule>
+
+ <rule name="VariableNamingConventions"
+ since="5.5.0"
+ message="{0} variable {1} should begin with {2}"
+ class="net.sourceforge.pmd.lang.apex.rule.codestyle.VariableNamingConventionsRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_codestyle.html#variablenamingconventions">
+ <description>
+A variable naming conventions rule - customize this to your liking. Currently, it
+checks for final variables that should be fully capitalized and non-final variables
+that should not include underscores.
+ </description>
+ <priority>1</priority>
+ <example>
+<![CDATA[
+public class Foo {
+ public static final Integer MY_NUM = 0;
+ public String myTest = '';
+ DataModule dmTest = new DataModule();
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="WhileLoopsMustUseBraces"
+ language="apex"
+ since="5.6.0"
+ message="Avoid using 'while' statements without curly braces"
+ class="net.sourceforge.pmd.lang.apex.rule.ApexXPathRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_codestyle.html#whileloopsmustusebraces">
+ <description>
+Avoid using 'while' statements without using braces to surround the code block. If the code
+formatting or indentation is lost then it becomes difficult to separate the code being
+controlled from the rest.
+ </description>
+ <priority>3</priority>
+ <properties>
+ <property name="xpath">
+ <value>
+<![CDATA[
+//WhileLoopStatement/BlockStatement[@CurlyBrace='false']
+]]>
+ </value>
+ </property>
+ </properties>
+ <example>
+<![CDATA[
+while (true) // not recommended
+ x++;
+
+while (true) { // preferred approach
+ x++;
+}
+]]>
+ </example>
+ </rule>
+
+</ruleset>
diff --git a/pmd-apex/src/main/resources/category/apex/design.xml b/pmd-apex/src/main/resources/category/apex/design.xml
new file mode 100644
index 00000000000..4ae03203820
--- /dev/null
+++ b/pmd-apex/src/main/resources/category/apex/design.xml
@@ -0,0 +1,342 @@
+<?xml version="1.0"?>
+
+<ruleset name="Design"
+ xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
+
+ <description>
+Rules that help you discover design issues.
+ </description>
+
+ <rule name="AvoidDeeplyNestedIfStmts"
+ since="5.5.0"
+ message="Deeply nested if..then statements are hard to read"
+ class="net.sourceforge.pmd.lang.apex.rule.design.AvoidDeeplyNestedIfStmtsRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_design.html#avoiddeeplynestedifstmts">
+ <description>
+Avoid creating deeply nested if-then statements since they are harder to read and error-prone to maintain.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+public class Foo {
+ public void bar(Integer x, Integer y, Integer z) {
+ if (x>y) {
+ if (y>z) {
+ if (z==x) {
+ // !! too deep
+ }
+ }
+ }
+ }
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="CyclomaticComplexity"
+ message="The {0} ''{1}'' has a{2} cyclomatic complexity of {3}."
+ since="6.0.0"
+ class="net.sourceforge.pmd.lang.apex.rule.design.CyclomaticComplexityRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_design.html#cyclomaticcomplexity">
+ <description>
+The complexity of methods directly affects maintenance costs and readability. Concentrating too much decisional logic
+in a single method makes its behaviour hard to read and change.
+
+Cyclomatic complexity assesses the complexity of a method by counting the number of decision points in a method,
+plus one for the method entry. Decision points are places where the control flow jumps to another place in the
+program. As such, they include all control flow statements, such as 'if', 'while', 'for', and 'case'.
+
+Generally, numbers ranging from 1-4 denote low complexity, 5-7 denote moderate complexity, 8-10 denote
+high complexity, and 11+ is very high complexity. By default, this rule reports methods with a complexity >= 10.
+Additionnally, classes with many methods of moderate complexity get reported as well once the total of their
+methods' complexities reaches 40, even if none of the methods was directly reported.
+
+Reported methods should be broken down into several smaller methods. Reported classes should probably be broken down
+into subcomponents.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+public class Complicated {
+ public void example() { // This method has a cyclomatic complexity of 12
+ int x = 0, y = 1, z = 2, t = 2;
+ boolean a = false, b = true, c = false, d = true;
+ if (a && b || b && d) {
+ if (y == z) {
+ x = 2;
+ } else if (y == t && !d) {
+ x = 2;
+ } else {
+ x = 2;
+ }
+ } else if (c && d) {
+ while (z < y) {
+ x = 2;
+ }
+ } else {
+ for (int n = 0; n < t; n++) {
+ x = 2;
+ }
+ }
+ }
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="ExcessiveClassLength"
+ since="5.5.0"
+ message="Avoid really long classes."
+ class="net.sourceforge.pmd.lang.apex.rule.design.ExcessiveClassLengthRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_design.html#excessiveclasslength">
+ <description>
+Excessive class file lengths are usually indications that the class may be burdened with excessive
+responsibilities that could be provided by external classes or functions. In breaking these methods
+apart the code becomes more managable and ripe for reuse.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+public class Foo {
+ public void bar1() {
+ // 1000 lines of code
+ }
+ public void bar2() {
+ // 1000 lines of code
+ }
+ public void bar3() {
+ // 1000 lines of code
+ }
+ public void barN() {
+ // 1000 lines of code
+ }
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="ExcessiveParameterList"
+ since="5.5.0"
+ message="Avoid long parameter lists."
+ class="net.sourceforge.pmd.lang.apex.rule.design.ExcessiveParameterListRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_design.html#excessiveparameterlist">
+ <description>
+Methods with numerous parameters are a challenge to maintain, especially if most of them share the
+same datatype. These situations usually denote the need for new objects to wrap the numerous parameters.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+// too many arguments liable to be mixed up
+public void addPerson(int birthYear, int birthMonth, int birthDate, int height, int weight, int ssn) {
+ // ...
+}
+// preferred approach
+public void addPerson(Date birthdate, BodyMeasurements measurements, int ssn) {
+ // ...
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="ExcessivePublicCount"
+ since="5.5.0"
+ message="This class has a bunch of public methods and attributes"
+ class="net.sourceforge.pmd.lang.apex.rule.design.ExcessivePublicCountRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_design.html#excessivepubliccount">
+ <description>
+Classes with large numbers of public methods and attributes require disproportionate testing efforts
+since combinational side effects grow rapidly and increase risk. Refactoring these classes into
+smaller ones not only increases testability and reliability but also allows new variations to be
+developed easily.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+public class Foo {
+ public String value;
+ public Bar something;
+ public Variable var;
+ // [... more more public attributes ...]
+
+ public void doWork() {}
+ public void doMoreWork() {}
+ public void doWorkAgain() {}
+ // [... more more public methods ...]
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="NcssConstructorCount"
+ since="5.5.0"
+ message="The constructor has an NCSS line count of {0}"
+ class="net.sourceforge.pmd.lang.apex.rule.design.NcssConstructorCountRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_design.html#ncssconstructorcount">
+ <description>
+This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of lines
+of code for a given constructor. NCSS ignores comments, and counts actual statements. Using this algorithm,
+lines of code that are split are counted as one.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+public class Foo extends Bar {
+ //this constructor only has 1 NCSS lines
+ public Foo() {
+ super();
+
+
+
+
+ super.foo();
+}
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="NcssMethodCount"
+ since="5.5.0"
+ message="The method ''{0}()'' has an NCSS line count of {1}"
+ class="net.sourceforge.pmd.lang.apex.rule.design.NcssMethodCountRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_design.html#ncssmethodcount">
+ <description>
+This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of lines
+of code for a given method. NCSS ignores comments, and counts actual statements. Using this algorithm,
+lines of code that are split are counted as one.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+public class Foo extends Bar {
+ //this method only has 1 NCSS lines
+ public Integer methd() {
+ super.methd();
+
+
+
+ return 1;
+ }
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="NcssTypeCount"
+ since="5.5.0"
+ message="The type has an NCSS line count of {0}"
+ class="net.sourceforge.pmd.lang.apex.rule.design.NcssTypeCountRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_design.html#ncsstypecount">
+ <description>
+This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of lines
+of code for a given type. NCSS ignores comments, and counts actual statements. Using this algorithm,
+lines of code that are split are counted as one.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+//this class only has 6 NCSS lines
+public class Foo extends Bar {
+ public Foo() {
+ super();
+
+
+
+
+
+ super.foo();
+ }
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="StdCyclomaticComplexity"
+ since="5.5.0"
+ message="The {0} ''{1}'' has a Standard Cyclomatic Complexity of {2}."
+ class="net.sourceforge.pmd.lang.apex.rule.design.StdCyclomaticComplexityRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_design.html#stdcyclomaticcomplexity">
+ <description>
+Complexity directly affects maintenance costs is determined by the number of decision points in a method
+plus one for the method entry. The decision points include 'if', 'while', 'for', and 'case labels' calls.
+Generally, numbers ranging from 1-4 denote low complexity, 5-7 denote moderate complexity, 8-10 denote
+high complexity, and 11+ is very high complexity.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+// This has a Cyclomatic Complexity = 12
+public class Foo {
+1 public void example() {
+2 if (a == b || (c == d && e == f)) {
+3 if (a1 == b1) {
+ fiddle();
+4 } else if a2 == b2) {
+ fiddle();
+ } else {
+ fiddle();
+ }
+5 } else if (c == d) {
+6 while (c == d) {
+ fiddle();
+ }
+7 } else if (e == f) {
+8 for (int n = 0; n < h; n++) {
+ fiddle();
+ }
+ } else {
+ switch (z) {
+9 case 1:
+ fiddle();
+ break;
+10 case 2:
+ fiddle();
+ break;
+11 case 3:
+ fiddle();
+ break;
+12 default:
+ fiddle();
+ break;
+ }
+ }
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="TooManyFields"
+ since="5.5.0"
+ message="Too many fields"
+ class="net.sourceforge.pmd.lang.apex.rule.design.TooManyFieldsRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_design.html#toomanyfields">
+ <description>
+Classes that have too many fields can become unwieldy and could be redesigned to have fewer fields,
+possibly through grouping related fields in new objects. For example, a class with individual
+city/state/zip fields could park them within a single Address field.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+public class Person {
+ // too many separate fields
+ int birthYear;
+ int birthMonth;
+ int birthDate;
+ float height;
+ float weight;
+}
+
+public class Person {
+ // this is more manageable
+ Date birthDate;
+ BodyMeasurements measurements;
+}
+]]>
+ </example>
+ </rule>
+
+</ruleset>
diff --git a/pmd-apex/src/main/resources/category/apex/documentation.xml b/pmd-apex/src/main/resources/category/apex/documentation.xml
new file mode 100644
index 00000000000..cafcf10d529
--- /dev/null
+++ b/pmd-apex/src/main/resources/category/apex/documentation.xml
@@ -0,0 +1,47 @@
+<?xml version="1.0"?>
+
+<ruleset name="Documentation"
+ xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
+
+ <description>
+Rules that are related to code documentation.
+ </description>
+
+ <rule name="ApexDoc"
+ since="6.8.0"
+ message="ApexDoc comment is missing or incorrect"
+ class="net.sourceforge.pmd.lang.apex.rule.documentation.ApexDocRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_documentation.html#apexdoc">
+ <description>
+This rule validates that:
+
+* ApexDoc comments are present for classes, methods, and properties that are public or global, excluding
+overrides and test classes (as well as the contents of test classes).
+* ApexDoc comments should contain @description.
+* ApexDoc comments on non-void, non-constructor methods should contain @return.
+* ApexDoc comments on void or constructor methods should not contain @return.
+* ApexDoc comments on methods with parameters should contain @param for each parameter, in the same
+order as the method signature.
+
+Method overrides and tests are both exempted from having ApexDoc.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+/**
+ * @description Hello World
+ */
+public class HelloWorld {
+ /**
+ * @description Bar
+ * @return Bar
+ */
+ public Object bar() { return null; }
+}
+]]>
+ </example>
+ </rule>
+
+</ruleset>
diff --git a/pmd-apex/src/main/resources/category/apex/errorprone.xml b/pmd-apex/src/main/resources/category/apex/errorprone.xml
new file mode 100644
index 00000000000..6eaa36f7f55
--- /dev/null
+++ b/pmd-apex/src/main/resources/category/apex/errorprone.xml
@@ -0,0 +1,291 @@
+<?xml version="1.0"?>
+
+<ruleset name="Error Prone"
+ xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
+
+ <description>
+Rules to detect constructs that are either broken, extremely confusing or prone to runtime errors.
+ </description>
+
+ <rule name="AvoidDirectAccessTriggerMap"
+ since="6.0.0"
+ message="Avoid directly accessing Trigger.old and Trigger.new"
+ class="net.sourceforge.pmd.lang.apex.rule.ApexXPathRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_errorprone.html#avoiddirectaccesstriggermap">
+ <description>
+Avoid directly accessing Trigger.old and Trigger.new as it can lead to a bug. Triggers should be bulkified and iterate through the map to handle the actions for each item separately.
+ </description>
+ <priority>3</priority>
+ <properties>
+ <property name="xpath">
+ <value>
+<![CDATA[
+//ArrayLoadExpression[TriggerVariableExpression and LiteralExpression]
+]]>
+ </value>
+ </property>
+ </properties>
+ <example>
+<![CDATA[
+trigger AccountTrigger on Account (before insert, before update) {
+ Account a = Trigger.new[0]; //Bad: Accessing the trigger array directly is not recommended.
+
+ foreach ( Account a : Trigger.new ){
+ //Good: Iterate through the trigger.new array instead.
+ }
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="AvoidHardcodingId"
+ since="6.0.0"
+ message="Hardcoding Id's is bound to break when changing environments."
+ class="net.sourceforge.pmd.lang.apex.rule.errorprone.AvoidHardcodingIdRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_errorprone.html#avoidhardcodingid">
+ <description>
+When deploying Apex code between sandbox and production environments, or installing Force.com AppExchange packages,
+it is essential to avoid hardcoding IDs in the Apex code. By doing so, if the record IDs change between environments,
+the logic can dynamically identify the proper data to operate against and not fail.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+public without sharing class Foo {
+ void foo() {
+ //Error - hardcoded the record type id
+ if(a.RecordTypeId == '012500000009WAr'){
+ //do some logic here.....
+ } else if(a.RecordTypeId == '0123000000095Km'){
+ //do some logic here for a different record type...
+ }
+ }
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="EmptyCatchBlock"
+ language="apex"
+ since="6.0.0"
+ message="Avoid empty catch blocks"
+ class="net.sourceforge.pmd.lang.apex.rule.ApexXPathRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_errorprone.html#emptycatchblock">
+ <description>
+Empty Catch Block finds instances where an exception is caught, but nothing is done.
+In most circumstances, this swallows an exception which should either be acted on
+or reported.
+ </description>
+ <priority>3</priority>
+ <properties>
+ <property name="xpath">
+ <value>
+<![CDATA[
+//CatchBlockStatement[./BlockStatement[count(*) = 0]]
+]]>
+ </value>
+ </property>
+ </properties>
+ <example>
+<![CDATA[
+public void doSomething() {
+ ...
+ try {
+ insert accounts;
+ } catch (DmlException dmle) {
+ // not good
+ }
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="EmptyIfStmt"
+ language="apex"
+ since="6.0.0"
+ message="Avoid empty 'if' statements"
+ class="net.sourceforge.pmd.lang.apex.rule.ApexXPathRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_errorprone.html#emptyifstmt">
+ <description>
+Empty If Statement finds instances where a condition is checked but nothing is done about it.
+ </description>
+ <priority>3</priority>
+ <properties>
+ <property name="xpath">
+ <value>
+<![CDATA[
+//IfBlockStatement
+ [BlockStatement[count(*) = 0]]
+]]>
+ </value>
+ </property>
+ </properties>
+ <example>
+<![CDATA[
+public class Foo {
+ public void bar(Integer x) {
+ if (x == 0) {
+ // empty!
+ }
+ }
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="EmptyStatementBlock"
+ language="apex"
+ since="6.0.0"
+ message="Avoid empty block statements."
+ class="net.sourceforge.pmd.lang.apex.rule.ApexXPathRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_errorprone.html#emptystatementblock">
+ <description>
+Empty block statements serve no purpose and should be removed.
+ </description>
+ <priority>3</priority>
+ <properties>
+ <property name="xpath">
+ <value>
+<![CDATA[
+//Method/ModifierNode[@Abstract!='true' and ../BlockStatement[count(*) = 0]]
+| //Method/BlockStatement//BlockStatement[count(*) = 0 and @Location != parent::*/@Location]
+]]>
+ </value>
+ </property>
+ </properties>
+ <example>
+<![CDATA[
+public class Foo {
+
+ private int _bar;
+
+ public void setBar(int bar) {
+ // empty
+ }
+
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="EmptyTryOrFinallyBlock"
+ language="apex"
+ since="6.0.0"
+ message="Avoid empty try or finally blocks"
+ class="net.sourceforge.pmd.lang.apex.rule.ApexXPathRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_errorprone.html#emptytryorfinallyblock">
+ <description>
+Avoid empty try or finally blocks - what's the point?
+ </description>
+ <priority>3</priority>
+ <properties>
+ <property name="xpath">
+ <value>
+<![CDATA[
+//TryCatchFinallyBlockStatement[./BlockStatement[count(*) = 0]]
+]]>
+ </value>
+ </property>
+ </properties>
+ <example>
+<![CDATA[
+public class Foo {
+ public void bar() {
+ try {
+ // empty !
+ } catch (Exception e) {
+ e.printStackTrace();
+ }
+ }
+}
+
+public class Foo {
+ public void bar() {
+ try {
+ int x=2;
+ } finally {
+ // empty!
+ }
+ }
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="EmptyWhileStmt"
+ language="apex"
+ since="6.0.0"
+ message="Avoid empty 'while' statements"
+ class="net.sourceforge.pmd.lang.apex.rule.ApexXPathRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_errorprone.html#emptywhilestmt">
+ <description>
+Empty While Statement finds all instances where a while statement does nothing.
+If it is a timing loop, then you should use Thread.sleep() for it; if it is
+a while loop that does a lot in the exit expression, rewrite it to make it clearer.
+ </description>
+ <priority>3</priority>
+ <properties>
+ <property name="xpath">
+ <value>
+<![CDATA[
+//WhileLoopStatement[./BlockStatement[count(*) = 0]]
+]]>
+ </value>
+ </property>
+ </properties>
+ <example>
+<![CDATA[
+public void bar(Integer a, Integer b) {
+ while (a == b) {
+ // empty!
+ }
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="MethodWithSameNameAsEnclosingClass"
+ since="5.5.0"
+ message="Classes should not have non-constructor methods with the same name as the class"
+ class="net.sourceforge.pmd.lang.apex.rule.errorprone.MethodWithSameNameAsEnclosingClassRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_errorprone.html#methodwithsamenameasenclosingclass">
+ <description>
+Non-constructor methods should not have the same name as the enclosing class.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+public class MyClass {
+ // this is OK because it is a constructor
+ public MyClass() {}
+ // this is bad because it is a method
+ public void MyClass() {}
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="AvoidNonExistentAnnotations"
+ since="6.5.0"
+ message="Use of non existent annotations will lead to broken Apex code which will not compile in the future."
+ class="net.sourceforge.pmd.lang.apex.rule.errorprone.AvoidNonExistentAnnotationsRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_errorprone.html#avoidnonexistentannotations">
+ <description>
+ Apex supported non existent annotations for legacy reasons.
+ In the future, use of such non-existent annotations could result in broken apex code that will not compile.
+ This will prevent users of garbage annotations from being able to use legitimate annotations added to Apex in the future.
+ A full list of supported annotations can be found at https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_classes_annotation.htm
+ </description>
+ <priority>3</priority>
+ <example>
+ <![CDATA[@NonExistentAnnotation public class ClassWithNonexistentAnnotation {
+ @NonExistentAnnotation public void methodWithNonExistentAnnotation() {
+ // ...
+ }
+}
+]]>
+ </example>
+ </rule>
+</ruleset>
diff --git a/pmd-apex/src/main/resources/category/apex/multithreading.xml b/pmd-apex/src/main/resources/category/apex/multithreading.xml
new file mode 100644
index 00000000000..88c22dfc8bc
--- /dev/null
+++ b/pmd-apex/src/main/resources/category/apex/multithreading.xml
@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+
+<ruleset name="Multithreading"
+ xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
+
+ <description>
+Rules that flag issues when dealing with multiple threads of execution.
+ </description>
+</ruleset>
diff --git a/pmd-apex/src/main/resources/category/apex/performance.xml b/pmd-apex/src/main/resources/category/apex/performance.xml
new file mode 100644
index 00000000000..01c4191bf81
--- /dev/null
+++ b/pmd-apex/src/main/resources/category/apex/performance.xml
@@ -0,0 +1,80 @@
+<?xml version="1.0"?>
+
+<ruleset name="Performance"
+ xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
+
+ <description>
+Rules that flag suboptimal code.
+ </description>
+
+ <rule name="AvoidDmlStatementsInLoops"
+ since="5.5.0"
+ message="Avoid DML statements inside loops"
+ class="net.sourceforge.pmd.lang.apex.rule.performance.AvoidDmlStatementsInLoopsRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_performance.html#avoiddmlstatementsinloops">
+ <description>
+Avoid DML statements inside loops to avoid hitting the DML governor limit. Instead, try to batch up the data into a list and invoke your DML once on that list of data outside the loop.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+public class Something {
+ public void foo() {
+ for (Integer i = 0; i < 151; i++) {
+ Account account;
+ // ...
+ insert account;
+ }
+ }
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="AvoidSoqlInLoops"
+ since="5.5.0"
+ message="Avoid Soql queries inside loops"
+ class="net.sourceforge.pmd.lang.apex.rule.performance.AvoidSoqlInLoopsRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_performance.html#avoidsoqlinloops">
+ <description>
+New objects created within loops should be checked to see if they can created outside them and reused.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+public class Something {
+ public static void main( String as[] ) {
+ for (Integer i = 0; i < 10; i++) {
+ List<Account> accounts = [SELECT Id FROM Account];
+ }
+ }
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="AvoidSoslInLoops"
+ since="6.0.0"
+ message="Avoid Sosl queries inside loops"
+ class="net.sourceforge.pmd.lang.apex.rule.performance.AvoidSoslInLoopsRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_performance.html#avoidsoslinloops">
+ <description>
+Sosl calls within loops can cause governor limit exceptions.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+public class Something {
+ public static void main( String as[] ) {
+ for (Integer i = 0; i < 10; i++) {
+ List<List<SObject>> searchList = [FIND 'map*' IN ALL FIELDS RETURNING Account (Id, Name), Contact, Opportunity, Lead];
+ }
+ }
+}
+]]>
+ </example>
+ </rule>
+
+</ruleset>
diff --git a/pmd-apex/src/main/resources/category/apex/security.xml b/pmd-apex/src/main/resources/category/apex/security.xml
new file mode 100644
index 00000000000..1c60c72bb8b
--- /dev/null
+++ b/pmd-apex/src/main/resources/category/apex/security.xml
@@ -0,0 +1,274 @@
+<?xml version="1.0"?>
+
+<ruleset name="Security"
+ xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
+
+ <description>
+Rules that flag potential security flaws.
+ </description>
+
+ <rule name="ApexBadCrypto"
+ since="5.5.3"
+ message="Apex classes should use random IV/key"
+ class="net.sourceforge.pmd.lang.apex.rule.security.ApexBadCryptoRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_security.html#apexbadcrypto">
+ <description>
+The rule makes sure you are using randomly generated IVs and keys for `Crypto` calls.
+Hard-wiring these values greatly compromises the security of encrypted data.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+public without sharing class Foo {
+ Blob hardCodedIV = Blob.valueOf('Hardcoded IV 123');
+ Blob hardCodedKey = Blob.valueOf('0000000000000000');
+ Blob data = Blob.valueOf('Data to be encrypted');
+ Blob encrypted = Crypto.encrypt('AES128', hardCodedKey, hardCodedIV, data);
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="ApexCRUDViolation"
+ since="5.5.3"
+ message="Validate CRUD permission before SOQL/DML operation"
+ class="net.sourceforge.pmd.lang.apex.rule.security.ApexCRUDViolationRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_security.html#apexcrudviolation">
+ <description>
+The rule validates you are checking for access permissions before a SOQL/SOSL/DML operation.
+Since Apex runs in system mode not having proper permissions checks results in escalation of
+privilege and may produce runtime errors. This check forces you to handle such scenarios.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+public class Foo {
+ public Contact foo(String status, String ID) {
+ Contact c = [SELECT Status__c FROM Contact WHERE Id=:ID];
+
+ // Make sure we can update the database before even trying
+ if (!Schema.sObjectType.Contact.fields.Name.isUpdateable()) {
+ return null;
+ }
+
+ c.Status__c = status;
+ update c;
+ return c;
+ }
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="ApexCSRF"
+ since="5.5.3"
+ message="Avoid making DML operations in Apex class constructor/init method"
+ class="net.sourceforge.pmd.lang.apex.rule.security.ApexCSRFRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_security.html#apexcsrf">
+ <description>
+Check to avoid making DML operations in Apex class constructor/init method. This prevents
+modification of the database just by accessing a page.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+public class Foo {
+ public init() {
+ insert data;
+ }
+
+ public Foo() {
+ insert data;
+ }
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="ApexDangerousMethods"
+ since="5.5.3"
+ message="Calling potentially dangerous method"
+ class="net.sourceforge.pmd.lang.apex.rule.security.ApexDangerousMethodsRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_security.html#apexdangerousmethods">
+ <description>
+Checks against calling dangerous methods.
+
+For the time being, it reports:
+
+* Against `FinancialForce`'s `Configuration.disableTriggerCRUDSecurity()`. Disabling CRUD security
+opens the door to several attacks and requires manual validation, which is unreliable.
+* Calling `System.debug` passing sensitive data as parameter, which could lead to exposure
+of private data.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+public class Foo {
+ public Foo() {
+ Configuration.disableTriggerCRUDSecurity();
+ }
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="ApexInsecureEndpoint"
+ since="5.5.3"
+ message="Apex callouts should use encrypted communication channels"
+ class="net.sourceforge.pmd.lang.apex.rule.security.ApexInsecureEndpointRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_security.html#apexinsecureendpoint">
+ <description>
+Checks against accessing endpoints under plain **http**. You should always use
+**https** for security.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+public without sharing class Foo {
+ void foo() {
+ HttpRequest req = new HttpRequest();
+ req.setEndpoint('http://localhost:com');
+ }
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="ApexOpenRedirect"
+ since="5.5.3"
+ message="Apex classes should safely redirect to a known location"
+ class="net.sourceforge.pmd.lang.apex.rule.security.ApexOpenRedirectRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_security.html#apexopenredirect">
+ <description>
+Checks against redirects to user-controlled locations. This prevents attackers from
+redirecting users to phishing sites.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+public without sharing class Foo {
+ String unsafeLocation = ApexPage.getCurrentPage().getParameters.get('url_param');
+ PageReference page() {
+ return new PageReference(unsafeLocation);
+ }
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="ApexSharingViolations"
+ since="5.5.3"
+ message="Apex classes should declare a sharing model if DML or SOQL/SOSL is used"
+ class="net.sourceforge.pmd.lang.apex.rule.security.ApexSharingViolationsRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_security.html#apexsharingviolations">
+ <description>
+Detect classes declared without explicit sharing mode if DML methods are used. This
+forces the developer to take access restrictions into account before modifying objects.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+public without sharing class Foo {
+ // DML operation here
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="ApexSOQLInjection"
+ since="5.5.3"
+ message="Avoid untrusted/unescaped variables in DML query"
+ class="net.sourceforge.pmd.lang.apex.rule.security.ApexSOQLInjectionRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_security.html#apexsoqlinjection">
+ <description>
+Detects the usage of untrusted / unescaped variables in DML queries.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+public class Foo {
+ public void test1(String t1) {
+ Database.query('SELECT Id FROM Account' + t1);
+ }
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="ApexSuggestUsingNamedCred"
+ since="5.5.3"
+ message="Suggest named credentials for authentication"
+ class="net.sourceforge.pmd.lang.apex.rule.security.ApexSuggestUsingNamedCredRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_security.html#apexsuggestusingnamedcred">
+ <description>
+Detects hardcoded credentials used in requests to an endpoint.
+
+You should refrain from hardcoding credentials:
+ * They are hard to mantain by being mixed in application code
+ * Particularly hard to update them when used from different classes
+ * Granting a developer access to the codebase means granting knowledge
+ of credentials, keeping a two-level access is not possible.
+ * Using different credentials for different environments is troublesome
+ and error-prone.
+
+Instead, you should use *Named Credentials* and a callout endpoint.
+
+For more information, you can check [this](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_callouts_named_credentials.htm)
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+public class Foo {
+ public void foo(String username, String password) {
+ Blob headerValue = Blob.valueOf(username + ':' + password);
+ String authorizationHeader = 'BASIC ' + EncodingUtil.base64Encode(headerValue);
+ req.setHeader('Authorization', authorizationHeader);
+ }
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="ApexXSSFromEscapeFalse"
+ since="5.5.3"
+ message="Apex classes should escape Strings in error messages"
+ class="net.sourceforge.pmd.lang.apex.rule.security.ApexXSSFromEscapeFalseRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_security.html#apexxssfromescapefalse">
+ <description>
+Reports on calls to `addError` with disabled escaping. The message passed to `addError`
+will be displayed directly to the user in the UI, making it prime ground for XSS
+attacks if unescaped.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+public without sharing class Foo {
+ Trigger.new[0].addError(vulnerableHTMLGoesHere, false);
+}
+]]>
+ </example>
+ </rule>
+
+ <rule name="ApexXSSFromURLParam"
+ since="5.5.3"
+ message="Apex classes should escape/sanitize Strings obtained from URL parameters"
+ class="net.sourceforge.pmd.lang.apex.rule.security.ApexXSSFromURLParamRule"
+ externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_security.html#apexxssfromurlparam">
+ <description>
+Makes sure that all values obtained from URL parameters are properly escaped / sanitized
+to avoid XSS attacks.
+ </description>
+ <priority>3</priority>
+ <example>
+<![CDATA[
+public without sharing class Foo {
+ String unescapedstring = ApexPage.getCurrentPage().getParameters.get('url_param');
+ String usedLater = unescapedstring;
+}
+]]>
+ </example>
+ </rule>
+
+</ruleset>
diff --git a/pmd-apex/src/main/resources/rulesets/apex/apexunit.xml b/pmd-apex/src/main/resources/rulesets/apex/apexunit.xml
index 50c11851043..efcca12aaef 100644
--- a/pmd-apex/src/main/resources/rulesets/apex/apexunit.xml
+++ b/pmd-apex/src/main/resources/rulesets/apex/apexunit.xml
@@ -3,56 +3,12 @@
<ruleset name="ApexUnit"
xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
<description>
These rules deal with different problems that can occur with Apex unit tests.
</description>
- <rule name="ApexUnitTestClassShouldHaveAsserts"
- since="5.5.1"
- message="Apex unit tests should System.assert() or assertEquals() or assertNotEquals()"
- class="net.sourceforge.pmd.lang.apex.rule.apexunit.ApexUnitTestClassShouldHaveAssertsRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_apexunit.html#apexunittestclassshouldhaveasserts">
- <description>
- Apex unit tests should include at least one assertion. This makes the tests more robust, and using assert
- with messages provide the developer a clearer idea of what the test does.
- </description>
- <priority>3</priority>
- <example>
- <![CDATA[
-@isTest
-public class Foo {
- public static testMethod void testSomething() {
- Account a = null;
- // This is better than having a NullPointerException
- // System.assertNotEquals(a, null, 'account not found');
- a.toString();
- }
-}
- ]]>
- </example>
- </rule>
- <rule name="ApexUnitTestShouldNotUseSeeAllDataTrue"
- since="5.5.1"
- message="Apex unit tests should not use @isTest(seeAllData = true)"
- class="net.sourceforge.pmd.lang.apex.rule.apexunit.ApexUnitTestShouldNotUseSeeAllDataTrueRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_apexunit.html#apexunittestshouldnotuseseealldatatrue">
- <description>
- Apex unit tests should not use @isTest(seeAllData=true) because it opens up the existing database data for unexpected modification by tests.
- </description>
- <priority>3</priority>
- <example>
- <![CDATA[
-@isTest(seeAllData = true)
-public class Foo {
- public static testMethod void testSomething() {
- Account a = null;
- // This is better than having a NullPointerException
- // System.assertNotEquals(a, null, 'account not found');
- a.toString();
- }
-}
- ]]>
- </example>
- </rule>
+ <rule ref="category/apex/bestpractices.xml/ApexUnitTestClassShouldHaveAsserts" deprecated="true" />
+ <rule ref="category/apex/bestpractices.xml/ApexUnitTestShouldNotUseSeeAllDataTrue" deprecated="true" />
+
</ruleset>
diff --git a/pmd-apex/src/main/resources/rulesets/apex/braces.xml b/pmd-apex/src/main/resources/rulesets/apex/braces.xml
index adba480da39..10a8a93bc6f 100644
--- a/pmd-apex/src/main/resources/rulesets/apex/braces.xml
+++ b/pmd-apex/src/main/resources/rulesets/apex/braces.xml
@@ -3,147 +3,14 @@
<ruleset name="Braces"
xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
<description>
The Braces ruleset contains rules regarding the use and placement of braces.
</description>
- <rule name="IfStmtsMustUseBraces"
- language="apex"
- since="5.6.0"
- message="Avoid using if statements without curly braces"
- class="net.sourceforge.pmd.lang.apex.rule.ApexXPathRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_braces.html#ifstmtsmustusebraces">
- <description>
-Avoid using if statements without using braces to surround the code block. If the code
-formatting or indentation is lost then it becomes difficult to separate the code being
-controlled from the rest.
- </description>
- <priority>3</priority>
- <properties>
- <property name="xpath">
- <value>
-<![CDATA[
-//IfBlockStatement/BlockStatement[@CurlyBrace='false']
-]]>
- </value>
- </property>
- </properties>
- <example>
- <![CDATA[
-if (foo) // not recommended
- x++;
-
-if (foo) { // preferred approach
- x++;
-}
-]]>
- </example>
- </rule>
-
- <rule name="WhileLoopsMustUseBraces"
- language="apex"
- since="5.6.0"
- message="Avoid using 'while' statements without curly braces"
- class="net.sourceforge.pmd.lang.apex.rule.ApexXPathRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_braces.html#whileloopsmustusebraces">
- <description>
-Avoid using 'while' statements without using braces to surround the code block. If the code
-formatting or indentation is lost then it becomes difficult to separate the code being
-controlled from the rest.
- </description>
- <priority>3</priority>
- <properties>
- <property name="xpath">
- <value>
-<![CDATA[
-//WhileLoopStatement/BlockStatement[@CurlyBrace='false']
-]]>
- </value>
- </property>
- </properties>
- <example>
-<![CDATA[
-while (true) // not recommended
- x++;
-
-while (true) { // preferred approach
- x++;
-}
-]]>
- </example>
- </rule>
-
- <rule name="IfElseStmtsMustUseBraces"
- language="apex"
- since="5.6.0"
- message="Avoid using 'if...else' statements without curly braces"
- class="net.sourceforge.pmd.lang.apex.rule.ApexXPathRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_braces.html#ifelsestmtsmustusebraces">
- <description>
-Avoid using if..else statements without using surrounding braces. If the code formatting
-or indentation is lost then it becomes difficult to separate the code being controlled
-from the rest.
- </description>
- <priority>3</priority>
- <properties>
- <property name="xpath">
- <value>
-<![CDATA[
-//IfBlockStatement/BlockStatement[@CurlyBrace='false'][count(child::*) > 0]
-|
-//IfElseBlockStatement/BlockStatement[@CurlyBrace='false'][count(child::*) > 0]
-]]>
- </value>
- </property>
- </properties>
- <example>
-<![CDATA[
-// this is OK
-if (foo) x++;
-
-// but this is not
-if (foo)
- x = x+1;
-else
- x = x-1;
-]]>
- </example>
- </rule>
-
- <rule name="ForLoopsMustUseBraces"
- language="apex"
- since="5.6.0"
- message="Avoid using 'for' statements without curly braces"
- class="net.sourceforge.pmd.lang.apex.rule.ApexXPathRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_braces.html#forloopsmustusebraces">
- <description>
-Avoid using 'for' statements without using surrounding braces. If the code formatting or
-indentation is lost then it becomes difficult to separate the code being controlled
-from the rest.
- </description>
- <priority>3</priority>
- <properties>
- <property name="xpath">
- <value>
-<![CDATA[
-//ForLoopStatement/BlockStatement[@CurlyBrace='false']
-|
-//ForEachStatement/BlockStatement[@CurlyBrace='false']
-]]>
- </value>
- </property>
- </properties>
- <example>
-<![CDATA[
-for (int i = 0; i < 42; i++) // not recommended
- foo();
-
-for (int i = 0; i < 42; i++) { // preferred approach
- foo();
-}
-]]>
- </example>
- </rule>
+ <rule ref="category/apex/codestyle.xml/ForLoopsMustUseBraces" deprecated="true" />
+ <rule ref="category/apex/codestyle.xml/IfElseStmtsMustUseBraces" deprecated="true" />
+ <rule ref="category/apex/codestyle.xml/IfStmtsMustUseBraces" deprecated="true" />
+ <rule ref="category/apex/codestyle.xml/WhileLoopsMustUseBraces" deprecated="true" />
</ruleset>
diff --git a/pmd-apex/src/main/resources/rulesets/apex/complexity.xml b/pmd-apex/src/main/resources/rulesets/apex/complexity.xml
index 881b89fa199..594a7bd626b 100644
--- a/pmd-apex/src/main/resources/rulesets/apex/complexity.xml
+++ b/pmd-apex/src/main/resources/rulesets/apex/complexity.xml
@@ -2,289 +2,20 @@
<ruleset name="Complexity" xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
<description>
The Complexity ruleset contains rules that find problems related to code size or complexity.
</description>
- <rule name="AvoidDeeplyNestedIfStmts"
- since="5.5.0"
- message="Deeply nested if..then statements are hard to read"
- class="net.sourceforge.pmd.lang.apex.rule.complexity.AvoidDeeplyNestedIfStmtsRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_complexity.html#avoiddeeplynestedifstmts">
- <description>
-Avoid creating deeply nested if-then statements since they are harder to read and error-prone to maintain.
- </description>
- <priority>3</priority>
- <example>
-<![CDATA[
-public class Foo {
- public void bar(Integer x, Integer y, Integer z) {
- if (x>y) {
- if (y>z) {
- if (z==x) {
- // !! too deep
- }
- }
- }
- }
-}
-]]>
- </example>
- </rule>
-
- <rule name="ExcessiveParameterList"
- since="5.5.0"
- message="Avoid long parameter lists."
- class="net.sourceforge.pmd.lang.apex.rule.complexity.ExcessiveParameterListRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_complexity.html#excessiveparameterlist">
- <description>
-Methods with numerous parameters are a challenge to maintain, especially if most of them share the
-same datatype. These situations usually denote the need for new objects to wrap the numerous parameters.
- </description>
- <priority>3</priority>
- <example>
-<![CDATA[
-// too many arguments liable to be mixed up
-public void addPerson(int birthYear, int birthMonth, int birthDate, int height, int weight, int ssn) {
- // ...
-}
-// preferred approach
-public void addPerson(Date birthdate, BodyMeasurements measurements, int ssn) {
- // ...
-}
-]]>
- </example>
- </rule>
-
- <rule name="ExcessiveClassLength"
- since="5.5.0"
- message="Avoid really long classes."
- class="net.sourceforge.pmd.lang.apex.rule.complexity.ExcessiveClassLengthRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_complexity.html#excessiveclasslength">
- <description>
-Excessive class file lengths are usually indications that the class may be burdened with excessive
-responsibilities that could be provided by external classes or functions. In breaking these methods
-apart the code becomes more managable and ripe for reuse.
- </description>
- <priority>3</priority>
- <example>
-<![CDATA[
-public class Foo {
- public void bar1() {
- // 1000 lines of code
- }
- public void bar2() {
- // 1000 lines of code
- }
- public void bar3() {
- // 1000 lines of code
- }
- public void barN() {
- // 1000 lines of code
- }
-}
-]]>
- </example>
- </rule>
-
- <rule name="NcssMethodCount"
- since="5.5.0"
- message="The method ''{0}()'' has an NCSS line count of {1}"
- class="net.sourceforge.pmd.lang.apex.rule.complexity.NcssMethodCountRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_complexity.html#ncssmethodcount">
- <description>
-This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of lines
-of code for a given method. NCSS ignores comments, and counts actual statements. Using this algorithm,
-lines of code that are split are counted as one.
- </description>
- <priority>3</priority>
- <example>
-<![CDATA[
-public class Foo extends Bar {
- //this method only has 1 NCSS lines
- public Integer methd() {
- super.methd();
-
-
-
- return 1;
- }
-}
-]]>
- </example>
- </rule>
-
- <rule name="NcssTypeCount"
- since="5.5.0"
- message="The type has an NCSS line count of {0}"
- class="net.sourceforge.pmd.lang.apex.rule.complexity.NcssTypeCountRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_complexity.html#ncsstypecount">
- <description>
-This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of lines
-of code for a given type. NCSS ignores comments, and counts actual statements. Using this algorithm,
-lines of code that are split are counted as one.
- </description>
- <priority>3</priority>
- <example>
-<![CDATA[
-//this class only has 6 NCSS lines
-public class Foo extends Bar {
- public Foo() {
- super();
-
-
-
-
-
- super.foo();
- }
-}
-]]>
- </example>
- </rule>
-
- <rule name="NcssConstructorCount"
- since="5.5.0"
- message="The constructor has an NCSS line count of {0}"
- class="net.sourceforge.pmd.lang.apex.rule.complexity.NcssConstructorCountRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_complexity.html#ncssconstructorcount">
- <description>
-This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determine the number of lines
-of code for a given constructor. NCSS ignores comments, and counts actual statements. Using this algorithm,
-lines of code that are split are counted as one.
- </description>
- <priority>3</priority>
- <example>
-<![CDATA[
-public class Foo extends Bar {
- //this constructor only has 1 NCSS lines
- public Foo() {
- super();
-
-
-
-
- super.foo();
-}
-}
-]]>
- </example>
- </rule>
-
- <rule name="StdCyclomaticComplexity"
- since="5.5.0"
- message="The {0} ''{1}'' has a Standard Cyclomatic Complexity of {2}."
- class="net.sourceforge.pmd.lang.apex.rule.complexity.StdCyclomaticComplexityRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_complexity.html#stdcyclomaticcomplexity">
- <description>
-Complexity directly affects maintenance costs is determined by the number of decision points in a method
-plus one for the method entry. The decision points include 'if', 'while', 'for', and 'case labels' calls.
-Generally, numbers ranging from 1-4 denote low complexity, 5-7 denote moderate complexity, 8-10 denote
-high complexity, and 11+ is very high complexity.
- </description>
- <priority>3</priority>
- <example>
-<![CDATA[
-// This has a Cyclomatic Complexity = 12
-public class Foo {
-1 public void example() {
-2 if (a == b || (c == d && e == f)) {
-3 if (a1 == b1) {
- fiddle();
-4 } else if a2 == b2) {
- fiddle();
- } else {
- fiddle();
- }
-5 } else if (c == d) {
-6 while (c == d) {
- fiddle();
- }
-7 } else if (e == f) {
-8 for (int n = 0; n < h; n++) {
- fiddle();
- }
- } else {
- switch (z) {
-9 case 1:
- fiddle();
- break;
-10 case 2:
- fiddle();
- break;
-11 case 3:
- fiddle();
- break;
-12 default:
- fiddle();
- break;
- }
- }
-}
-]]>
- </example>
- </rule>
-
- <rule name="TooManyFields"
- since="5.5.0"
- message="Too many fields"
- class="net.sourceforge.pmd.lang.apex.rule.complexity.TooManyFieldsRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_complexity.html#toomanyfields">
- <description>
-Classes that have too many fields can become unwieldy and could be redesigned to have fewer fields,
-possibly through grouping related fields in new objects. For example, a class with individual
-city/state/zip fields could park them within a single Address field.
- </description>
- <priority>3</priority>
- <example>
-<![CDATA[
-public class Person {
- // too many separate fields
- int birthYear;
- int birthMonth;
- int birthDate;
- float height;
- float weight;
-}
-
-public class Person {
- // this is more manageable
- Date birthDate;
- BodyMeasurements measurements;
-}
-]]>
- </example>
- </rule>
-
- <rule name="ExcessivePublicCount"
- since="5.5.0"
- message="This class has a bunch of public methods and attributes"
- class="net.sourceforge.pmd.lang.apex.rule.complexity.ExcessivePublicCountRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_complexity.html#excessivepubliccount">
- <description>
-Classes with large numbers of public methods and attributes require disproportionate testing efforts
-since combinational side effects grow rapidly and increase risk. Refactoring these classes into
-smaller ones not only increases testability and reliability but also allows new variations to be
-developed easily.
- </description>
- <priority>3</priority>
- <example>
-<![CDATA[
-public class Foo {
- public String value;
- public Bar something;
- public Variable var;
- // [... more more public attributes ...]
-
- public void doWork() {}
- public void doMoreWork() {}
- public void doWorkAgain() {}
- // [... more more public methods ...]
-}
-]]>
- </example>
- </rule>
+ <rule ref="category/apex/design.xml/AvoidDeeplyNestedIfStmts" deprecated="true" />
+ <rule ref="category/apex/design.xml/ExcessiveClassLength" deprecated="true" />
+ <rule ref="category/apex/design.xml/ExcessiveParameterList" deprecated="true" />
+ <rule ref="category/apex/design.xml/ExcessivePublicCount" deprecated="true" />
+ <rule ref="category/apex/design.xml/NcssConstructorCount" deprecated="true" />
+ <rule ref="category/apex/design.xml/NcssMethodCount" deprecated="true" />
+ <rule ref="category/apex/design.xml/NcssTypeCount" deprecated="true" />
+ <rule ref="category/apex/design.xml/StdCyclomaticComplexity" deprecated="true" />
+ <rule ref="category/apex/design.xml/TooManyFields" deprecated="true" />
</ruleset>
diff --git a/pmd-apex/src/main/resources/rulesets/apex/empty.xml b/pmd-apex/src/main/resources/rulesets/apex/empty.xml
new file mode 100644
index 00000000000..73dad3a46ec
--- /dev/null
+++ b/pmd-apex/src/main/resources/rulesets/apex/empty.xml
@@ -0,0 +1,18 @@
+<?xml version="1.0"?>
+
+<ruleset name="Empty Code"
+ xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
+ <description>
+The Empty Code ruleset contains rules that find empty statements of any kind (empty method,
+empty block statement, empty try or catch block,...).
+ </description>
+
+ <rule ref="category/apex/errorprone.xml/EmptyCatchBlock" deprecated="true" />
+ <rule ref="category/apex/errorprone.xml/EmptyIfStmt" deprecated="true" />
+ <rule ref="category/apex/errorprone.xml/EmptyStatementBlock" deprecated="true" />
+ <rule ref="category/apex/errorprone.xml/EmptyTryOrFinallyBlock" deprecated="true" />
+ <rule ref="category/apex/errorprone.xml/EmptyWhileStmt" deprecated="true" />
+
+</ruleset>
diff --git a/pmd-apex/src/main/resources/rulesets/apex/metrics.xml b/pmd-apex/src/main/resources/rulesets/apex/metrics.xml
index 99452747339..f8ee4a72547 100644
--- a/pmd-apex/src/main/resources/rulesets/apex/metrics.xml
+++ b/pmd-apex/src/main/resources/rulesets/apex/metrics.xml
@@ -1,66 +1,13 @@
<?xml version="1.0"?>
<ruleset name="Metrics temporary ruleset"
- xmlns="http://pmd.sourceforge.net/ruleset/3.0.0"
+ xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/3.0.0 http://pmd.sourceforge.net/ruleset_3_0_0.xsd">
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
<description>
These are rules which use the Metrics Framework to calculate metrics.
</description>
- <rule name="CyclomaticComplexity"
- message="The {0} ''{1}'' has a{2} cyclomatic complexity of {3}."
- since="6.0.0"
- class="net.sourceforge.pmd.lang.apex.metrics.rule.CyclomaticComplexityRule"
- metrics="true"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_metrics.html#cyclomaticcomplexity">
- <description>
- <![CDATA[
-The complexity of methods directly affects maintenance costs and readability. Concentrating too much decisional logic
-in a single method makes its behaviour hard to read and change.
-
-Cyclomatic complexity assesses the complexity of a method by counting the number of decision points in a method,
-plus one for the method entry. Decision points are places where the control flow jumps to another place in the
-program. As such, they include all control flow statements, such as 'if', 'while', 'for', and 'case'.
-
-Generally, numbers ranging from 1-4 denote low complexity, 5-7 denote moderate complexity, 8-10 denote
-high complexity, and 11+ is very high complexity. By default, this rule reports methods with a complexity >= 10.
-Additionnally, classes with many methods of moderate complexity get reported as well once the total of their
-methods' complexities reaches 40, even if none of the methods was directly reported.
-
-Reported methods should be broken down into several smaller methods. Reported classes should probably be broken down
-into subcomponents.
- ]]>
- </description>
- <priority>3</priority>
- <example>
- <![CDATA[
-public class Complicated {
- public void example() { // This method has a cyclomatic complexity of 12
- int x = 0, y = 1, z = 2, t = 2;
- boolean a = false, b = true, c = false, d = true;
- if (a && b || b && d) {
- if (y == z) {
- x = 2;
- } else if (y == t && !d) {
- x = 2;
- } else {
- x = 2;
- }
- } else if (c && d) {
- while (z < y) {
- x = 2;
- }
- } else {
- for (int n = 0; n < t; n++) {
- x = 2;
- }
- }
- }
-}
-]]>
- </example>
- </rule>
-
+ <rule ref="category/apex/design.xml/CyclomaticComplexity" deprecated="true" />
</ruleset>
diff --git a/pmd-apex/src/main/resources/rulesets/apex/performance.xml b/pmd-apex/src/main/resources/rulesets/apex/performance.xml
index 89e47f739c8..347ca6bcbca 100644
--- a/pmd-apex/src/main/resources/rulesets/apex/performance.xml
+++ b/pmd-apex/src/main/resources/rulesets/apex/performance.xml
@@ -3,55 +3,13 @@
<ruleset name="Performance"
xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
<description>
The Performance ruleset contains a collection of good practices which should be followed.
</description>
- <rule name="AvoidSoqlInLoops"
- since="5.5.0"
- message="Avoid Soql queries inside loops"
- class="net.sourceforge.pmd.lang.apex.rule.performance.AvoidSoqlInLoopsRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_performance.html#avoidsoqlinloops">
- <description>
-New objects created within loops should be checked to see if they can created outside them and reused.
- </description>
- <priority>3</priority>
- <example>
-<![CDATA[
-public class Something {
- public static void main( String as[] ) {
- for (Integer i = 0; i < 10; i++) {
- List<Account> accounts = [SELECT Id FROM Account];
- }
- }
-}
-]]>
- </example>
- </rule>
-
- <rule name="AvoidDmlStatementsInLoops"
- since="5.5.0"
- message="Avoid DML statements inside loops"
- class="net.sourceforge.pmd.lang.apex.rule.performance.AvoidDmlStatementsInLoopsRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_performance.html#avoiddmlstatementsinloops">
- <description>
-Avoid DML statements inside loops to avoid hitting the DML governor limit. Instead, try to batch up the data into a list and invoke your DML once on that list of data outside the loop.
- </description>
- <priority>3</priority>
- <example>
-<![CDATA[
-public class Something {
- public void foo() {
- for (Integer i = 0; i < 151; i++) {
- Account account;
- // ...
- insert account;
- }
- }
-}
-]]>
- </example>
- </rule>
+ <rule ref="category/apex/performance.xml/AvoidDmlStatementsInLoops" deprecated="true" />
+ <rule ref="category/apex/performance.xml/AvoidSoqlInLoops" deprecated="true" />
+ <rule ref="category/apex/performance.xml/AvoidSoslInLoops" deprecated="true" />
</ruleset>
diff --git a/pmd-apex/src/main/resources/rulesets/apex/ruleset.xml b/pmd-apex/src/main/resources/rulesets/apex/ruleset.xml
index 768ecd89942..993f33a7724 100644
--- a/pmd-apex/src/main/resources/rulesets/apex/ruleset.xml
+++ b/pmd-apex/src/main/resources/rulesets/apex/ruleset.xml
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
-<ruleset xmlns="http://pmd.sourceforge.net/ruleset/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Default ruleset used by the CodeClimate Engine for Salesforce.com Apex" xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">
+<ruleset xmlns="http://pmd.sourceforge.net/ruleset/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Default ruleset used by the CodeClimate Engine for Salesforce.com Apex" xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
<description>Default ruleset used by the Code Climate Engine for Salesforce.com Apex</description>
-
+
<!-- COMPLEXITY -->
- <rule ref="rulesets/apex/complexity.xml/ExcessiveClassLength" message="Avoid really long classes (lines of code)">
+ <rule ref="category/apex/design.xml/ExcessiveClassLength" message="Avoid really long classes (lines of code)">
<priority>3</priority>
<properties>
<property name="minimum" value="1000" />
@@ -13,7 +13,7 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
- <rule ref="rulesets/apex/complexity.xml/ExcessiveParameterList" message="Avoid long parameter lists">
+ <rule ref="category/apex/design.xml/ExcessiveParameterList" message="Avoid long parameter lists">
<priority>3</priority>
<properties>
<property name="minimum" value="4" />
@@ -23,7 +23,7 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
- <rule ref="rulesets/apex/complexity.xml/ExcessivePublicCount" message="This class has too many public methods and attributes">
+ <rule ref="category/apex/design.xml/ExcessivePublicCount" message="This class has too many public methods and attributes">
<priority>3</priority>
<properties>
<property name="minimum" value="25" />
@@ -33,7 +33,7 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
- <rule ref="rulesets/apex/complexity.xml/NcssConstructorCount" message="The constructor has an NCSS line count of {0}">
+ <rule ref="category/apex/design.xml/NcssConstructorCount" message="The constructor has an NCSS line count of {0}">
<priority>3</priority>
<properties>
<property name="minimum" value="20" />
@@ -43,7 +43,7 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
- <rule ref="rulesets/apex/complexity.xml/NcssMethodCount" message="The method {0}() has an NCSS line count of {1}">
+ <rule ref="category/apex/design.xml/NcssMethodCount" message="The method {0}() has an NCSS line count of {1}">
<priority>3</priority>
<properties>
<property name="minimum" value="60" />
@@ -53,7 +53,7 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
- <rule ref="rulesets/apex/complexity.xml/NcssTypeCount" message="The type has an NCSS line count of {0}">
+ <rule ref="category/apex/design.xml/NcssTypeCount" message="The type has an NCSS line count of {0}">
<priority>3</priority>
<properties>
<property name="minimum" value="700" />
@@ -63,7 +63,7 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
- <rule ref="rulesets/apex/complexity.xml/StdCyclomaticComplexity" message="The {0} ''{1}'' has a Standard Cyclomatic Complexity of {2}.">
+ <rule ref="category/apex/design.xml/StdCyclomaticComplexity" message="The {0} ''{1}'' has a Standard Cyclomatic Complexity of {2}.">
<priority>3</priority>
<properties>
<property name="reportLevel" value="10" />
@@ -73,7 +73,7 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
- <rule ref="rulesets/apex/complexity.xml/TooManyFields" message="Too many fields">
+ <rule ref="category/apex/design.xml/TooManyFields" message="Too many fields">
<priority>3</priority>
<properties>
<property name="maxfields" value="20" />
@@ -83,7 +83,7 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
- <rule ref="rulesets/apex/complexity.xml/AvoidDeeplyNestedIfStmts" message="Deeply nested if..else statements are hard to read">
+ <rule ref="category/apex/design.xml/AvoidDeeplyNestedIfStmts" message="Deeply nested if..else statements are hard to read">
<priority>3</priority>
<properties>
<property name="problemDepth" value="4" />
@@ -93,9 +93,27 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
-
+ <rule ref="category/apex/design.xml/CyclomaticComplexity">
+ <priority>3</priority>
+ <properties>
+ <!-- relevant for Code Climate output only -->
+ <property name="cc_categories" value="Complexity" />
+ <property name="cc_remediation_points_multiplier" value="200" />
+ <property name="cc_block_highlighting" value="false" />
+ </properties>
+ </rule>
+
<!-- PERFORMANCE -->
- <rule ref="rulesets/apex/performance.xml/AvoidSoqlInLoops" message="Avoid Soql queries inside loops">
+ <rule ref="category/apex/performance.xml/AvoidSoqlInLoops" message="Avoid Soql queries inside loops">
+ <priority>3</priority>
+ <properties>
+ <!-- relevant for Code Climate output only -->
+ <property name="cc_categories" value="Performance" />
+ <property name="cc_remediation_points_multiplier" value="150" />
+ <property name="cc_block_highlighting" value="false" />
+ </properties>
+ </rule>
+ <rule ref="category/apex/performance.xml/AvoidSoslInLoops" message="Avoid Sosl queries inside loops">
<priority>3</priority>
<properties>
<!-- relevant for Code Climate output only -->
@@ -104,7 +122,7 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
- <rule ref="rulesets/apex/performance.xml/AvoidDmlStatementsInLoops" message="Avoid DML Statements inside loops">
+ <rule ref="category/apex/performance.xml/AvoidDmlStatementsInLoops" message="Avoid DML Statements inside loops">
<priority>3</priority>
<properties>
<!-- relevant for Code Climate output only -->
@@ -113,7 +131,16 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
- <rule ref="rulesets/apex/style.xml/AvoidLogicInTrigger" message="Avoid logic in triggers">
+ <rule ref="category/apex/errorprone.xml/AvoidDirectAccessTriggerMap" message="Avoid directly accessing Trigger.old and Trigger.new">
+ <priority>3</priority>
+ <properties>
+ <!-- relevant for Code Climate output only -->
+ <property name="cc_categories" value="Performance" />
+ <property name="cc_remediation_points_multiplier" value="150" />
+ <property name="cc_block_highlighting" value="false" />
+ </properties>
+ </rule>
+ <rule ref="category/apex/bestpractices.xml/AvoidLogicInTrigger" message="Avoid logic in triggers">
<priority>3</priority>
<properties>
<!-- relevant for Code Climate output only -->
@@ -122,7 +149,7 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
- <rule ref="rulesets/apex/style.xml/AvoidGlobalModifier" message="Avoid using global modifier">
+ <rule ref="category/apex/bestpractices.xml/AvoidGlobalModifier" message="Avoid using global modifier">
<priority>3</priority>
<properties>
<!-- relevant for Code Climate output only -->
@@ -131,8 +158,26 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
+ <rule ref="category/apex/errorprone.xml/AvoidNonExistentAnnotations">
+ <properties>
+ <!-- relevant for Code Climate output only -->
+ <property name="cc_categories" value="Style" />
+ <property name="cc_remediation_points_multiplier" value="100" />
+ <property name="cc_block_highlighting" value="false" />
+ </properties>
+ </rule>
+ <rule ref="category/apex/errorprone.xml/AvoidHardcodingId" message="Avoid hardcoding ID's">
+ <priority>3</priority>
+ <properties>
+ <!-- relevant for Code Climate output only -->
+ <property name="cc_categories" value="Security"/>
+ <property name="cc_remediation_points_multiplier" value="20"/>
+ <property name="cc_block_highlighting" value="false"/>
+ </properties>
+ </rule>
+
<!-- NAMING -->
- <rule ref="rulesets/apex/style.xml/ClassNamingConventions" message="Class names should begin with an uppercase character">
+ <rule ref="category/apex/codestyle.xml/ClassNamingConventions" message="Class names should begin with an uppercase character">
<priority>3</priority>
<properties>
<!-- relevant for Code Climate output only -->
@@ -141,7 +186,7 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
- <rule ref="rulesets/apex/style.xml/MethodNamingConventions" message="Method name does not begin with a lower case character.">
+ <rule ref="category/apex/codestyle.xml/MethodNamingConventions" message="Method name does not begin with a lower case character.">
<priority>3</priority>
<properties>
<!-- relevant for Code Climate output only -->
@@ -150,7 +195,7 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
- <rule ref="rulesets/apex/style.xml/MethodWithSameNameAsEnclosingClass" message="Classes should not have non-constructor methods with the same name as the class">
+ <rule ref="category/apex/errorprone.xml/MethodWithSameNameAsEnclosingClass" message="Classes should not have non-constructor methods with the same name as the class">
<priority>3</priority>
<properties>
<!-- relevant for Code Climate output only -->
@@ -159,7 +204,7 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
- <rule ref="rulesets/apex/style.xml/VariableNamingConventions" message="{0} variable {1} should begin with {2}">
+ <rule ref="category/apex/codestyle.xml/VariableNamingConventions" message="{0} variable {1} should begin with {2}">
<priority>3</priority>
<properties>
<!-- relevant for Code Climate output only -->
@@ -168,8 +213,9 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
+
<!-- TESTS -->
- <rule ref="rulesets/apex/apexunit.xml/ApexUnitTestClassShouldHaveAsserts" message="Apex unit test classes should have at least one System.assert() or assertEquals() or AssertNotEquals() call">
+ <rule ref="category/apex/bestpractices.xml/ApexUnitTestClassShouldHaveAsserts" message="Apex unit test classes should have at least one System.assert() or assertEquals() or AssertNotEquals() call">
<priority>3</priority>
<properties>
<!-- relevant for Code Climate output only -->
@@ -178,7 +224,7 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
- <rule ref="rulesets/apex/apexunit.xml/ApexUnitTestShouldNotUseSeeAllDataTrue" message="@isTest(seeAllData=true) should not be used in Apex unit tests because it opens up the existing database data for unexpected modification by tests">
+ <rule ref="category/apex/bestpractices.xml/ApexUnitTestShouldNotUseSeeAllDataTrue" message="@isTest(seeAllData=true) should not be used in Apex unit tests because it opens up the existing database data for unexpected modification by tests">
<priority>3</priority>
<properties>
<!-- relevant for Code Climate output only -->
@@ -187,8 +233,9 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
+
<!-- SECURITY -->
- <rule ref="rulesets/apex/security.xml/ApexSharingViolations" message="Apex classes should declare a sharing model if DML or SOQL is used">
+ <rule ref="category/apex/security.xml/ApexSharingViolations" message="Apex classes should declare a sharing model if DML or SOQL is used">
<priority>3</priority>
<properties>
<!-- relevant for Code Climate output only -->
@@ -197,7 +244,7 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
- <rule ref="rulesets/apex/security.xml/ApexInsecureEndpoint" message="Apex callouts should use encrypted communication channels">
+ <rule ref="category/apex/security.xml/ApexInsecureEndpoint" message="Apex callouts should use encrypted communication channels">
<priority>3</priority>
<properties>
<!-- relevant for Code Climate output only -->
@@ -206,7 +253,7 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
- <rule ref="rulesets/apex/security.xml/ApexCSRF" message="Avoid making DML operations in Apex class constructor/init method">
+ <rule ref="category/apex/security.xml/ApexCSRF" message="Avoid making DML operations in Apex class constructor/init method">
<priority>3</priority>
<properties>
<!-- relevant for Code Climate output only -->
@@ -215,7 +262,7 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
- <rule ref="rulesets/apex/security.xml/ApexOpenRedirect" message="Apex classes should safely redirect to a known location">
+ <rule ref="category/apex/security.xml/ApexOpenRedirect" message="Apex classes should safely redirect to a known location">
<priority>3</priority>
<properties>
<!-- relevant for Code Climate output only -->
@@ -224,7 +271,7 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
- <rule ref="rulesets/apex/security.xml/ApexSOQLInjection" message="Apex classes should escape variables merged in DML query">
+ <rule ref="category/apex/security.xml/ApexSOQLInjection" message="Apex classes should escape variables merged in DML query">
<priority>3</priority>
<properties>
<!-- relevant for Code Climate output only -->
@@ -233,7 +280,7 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
- <rule ref="rulesets/apex/security.xml/ApexXSSFromURLParam" message="Apex classes should escape Strings obtained from URL parameters">
+ <rule ref="category/apex/security.xml/ApexXSSFromURLParam" message="Apex classes should escape Strings obtained from URL parameters">
<priority>3</priority>
<properties>
<!-- relevant for Code Climate output only -->
@@ -242,7 +289,7 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
- <rule ref="rulesets/apex/security.xml/ApexXSSFromEscapeFalse" message="Apex classes should escape addError strings">
+ <rule ref="category/apex/security.xml/ApexXSSFromEscapeFalse" message="Apex classes should escape addError strings">
<priority>3</priority>
<properties>
<!-- relevant for Code Climate output only -->
@@ -251,7 +298,7 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
- <rule ref="rulesets/apex/security.xml/ApexBadCrypto" message="Apex Crypto should use random IV/key">
+ <rule ref="category/apex/security.xml/ApexBadCrypto" message="Apex Crypto should use random IV/key">
<priority>3</priority>
<properties>
<!-- relevant for Code Climate output only -->
@@ -260,7 +307,7 @@
<property name="cc_block_highlighting" value="false" />
</properties>
</rule>
- <rule ref="rulesets/apex/security.xml/ApexCRUDViolation" message="Validate CRUD permission before SOQL/DML operation">
+ <rule ref="category/apex/security.xml/ApexCRUDViolation" message="Validate CRUD permission before SOQL/DML operation">
<priority>3</priority>
<properties>
<!-- relevant for Code Climate output only -->
@@ -269,7 +316,7 @@
<property name="cc_block_highlighting" value="false"/>
</properties>
</rule>
- <rule ref="rulesets/apex/security.xml/ApexDangerousMethods" message="Calling potentially dangerous method">
+ <rule ref="category/apex/security.xml/ApexDangerousMethods" message="Calling potentially dangerous method">
<priority>3</priority>
<properties>
<!-- relevant for Code Climate output only -->
@@ -277,8 +324,8 @@
<property name="cc_remediation_points_multiplier" value="50"/>
<property name="cc_block_highlighting" value="false"/>
</properties>
- </rule>
- <rule ref="rulesets/apex/security.xml/ApexSuggestUsingNamedCred" message="Consider using named credentials for authenticated callouts">
+ </rule>
+ <rule ref="category/apex/security.xml/ApexSuggestUsingNamedCred" message="Consider using named credentials for authenticated callouts">
<priority>3</priority>
<properties>
<!-- relevant for Code Climate output only -->
@@ -287,41 +334,111 @@
<property name="cc_block_highlighting" value="false"/>
</properties>
</rule>
+
<!-- BRACES -->
- <rule ref="rulesets/apex/braces.xml/IfStmtsMustUseBraces" message="Avoid using if statements without curly braces">
- <priority>3</priority>
- <properties>
- <!-- relevant for Code Climate output only -->
- <property name="cc_categories" value="Style" />
- <property name="cc_remediation_points_multiplier" value="5" />
- <property name="cc_block_highlighting" value="false" />
- </properties>
- </rule>
- <rule ref="rulesets/apex/braces.xml/WhileLoopsMustUseBraces" message="Avoid using 'while' statements without curly braces">
- <priority>3</priority>
- <properties>
- <!-- relevant for Code Climate output only -->
- <property name="cc_categories" value="Style" />
- <property name="cc_remediation_points_multiplier" value="5" />
- <property name="cc_block_highlighting" value="false" />
- </properties>
- </rule>
- <rule ref="rulesets/apex/braces.xml/IfElseStmtsMustUseBraces" message="Avoid using 'if...else' statements without curly braces">
- <priority>3</priority>
- <properties>
- <!-- relevant for Code Climate output only -->
- <property name="cc_categories" value="Style" />
- <property name="cc_remediation_points_multiplier" value="5" />
- <property name="cc_block_highlighting" value="false" />
- </properties>
- </rule>
- <rule ref="rulesets/apex/braces.xml/ForLoopsMustUseBraces" message="Avoid using 'for' statements without curly braces">
- <priority>3</priority>
- <properties>
- <!-- relevant for Code Climate output only -->
- <property name="cc_categories" value="Style" />
- <property name="cc_remediation_points_multiplier" value="5" />
- <property name="cc_block_highlighting" value="false" />
- </properties>
- </rule>
-</ruleset>
\ No newline at end of file
+ <rule ref="category/apex/codestyle.xml/IfStmtsMustUseBraces" message="Avoid using if statements without curly braces">
+ <priority>3</priority>
+ <properties>
+ <!-- relevant for Code Climate output only -->
+ <property name="cc_categories" value="Style" />
+ <property name="cc_remediation_points_multiplier" value="5" />
+ <property name="cc_block_highlighting" value="false" />
+ </properties>
+ </rule>
+ <rule ref="category/apex/codestyle.xml/WhileLoopsMustUseBraces" message="Avoid using 'while' statements without curly braces">
+ <priority>3</priority>
+ <properties>
+ <!-- relevant for Code Climate output only -->
+ <property name="cc_categories" value="Style" />
+ <property name="cc_remediation_points_multiplier" value="5" />
+ <property name="cc_block_highlighting" value="false" />
+ </properties>
+ </rule>
+ <rule ref="category/apex/codestyle.xml/IfElseStmtsMustUseBraces" message="Avoid using 'if...else' statements without curly braces">
+ <priority>3</priority>
+ <properties>
+ <!-- relevant for Code Climate output only -->
+ <property name="cc_categories" value="Style" />
+ <property name="cc_remediation_points_multiplier" value="5" />
+ <property name="cc_block_highlighting" value="false" />
+ </properties>
+ </rule>
+ <rule ref="category/apex/codestyle.xml/ForLoopsMustUseBraces" message="Avoid using 'for' statements without curly braces">
+ <priority>3</priority>
+ <properties>
+ <!-- relevant for Code Climate output only -->
+ <property name="cc_categories" value="Style" />
+ <property name="cc_remediation_points_multiplier" value="5" />
+ <property name="cc_block_highlighting" value="false" />
+ </properties>
+ </rule>
+
+ <!-- EMPTY -->
+ <rule ref="category/apex/errorprone.xml/EmptyCatchBlock" message="Avoid empty catch blocks">
+ <priority>3</priority>
+ <properties>
+ <!-- relevant for Code Climate output only -->
+ <property name="cc_categories" value="Style" />
+ <property name="cc_remediation_points_multiplier" value="5" />
+ <property name="cc_block_highlighting" value="false" />
+ </properties>
+ </rule>
+ <rule ref="category/apex/errorprone.xml/EmptyIfStmt" message="Avoid empty 'if' statements">
+ <priority>3</priority>
+ <properties>
+ <!-- relevant for Code Climate output only -->
+ <property name="cc_categories" value="Style" />
+ <property name="cc_remediation_points_multiplier" value="5" />
+ <property name="cc_block_highlighting" value="false" />
+ </properties>
+ </rule>
+ <rule ref="category/apex/errorprone.xml/EmptyWhileStmt" message="Avoid empty 'while' statements">
+ <priority>3</priority>
+ <properties>
+ <!-- relevant for Code Climate output only -->
+ <property name="cc_categories" value="Style" />
+ <property name="cc_remediation_points_multiplier" value="5" />
+ <property name="cc_block_highlighting" value="false" />
+ </properties>
+ </rule>
+ <rule ref="category/apex/errorprone.xml/EmptyTryOrFinallyBlock" message="Avoid empty try or finally blocks">
+ <priority>3</priority>
+ <properties>
+ <!-- relevant for Code Climate output only -->
+ <property name="cc_categories" value="Style" />
+ <property name="cc_remediation_points_multiplier" value="5" />
+ <property name="cc_block_highlighting" value="false" />
+ </properties>
+ </rule>
+ <rule ref="category/apex/errorprone.xml/EmptyStatementBlock" message="Avoid empty block statements.">
+ <priority>3</priority>
+ <properties>
+ <!-- relevant for Code Climate output only -->
+ <property name="cc_categories" value="Style" />
+ <property name="cc_remediation_points_multiplier" value="5" />
+ <property name="cc_block_highlighting" value="false" />
+ </properties>
+ </rule>
+
+ <!-- STYLE -->
+ <rule ref="category/apex/codestyle.xml/OneDeclarationPerLine">
+ <priority>3</priority>
+ <properties>
+ <!-- relevant for Code Climate output only -->
+ <property name="cc_categories" value="Style" />
+ <property name="cc_remediation_points_multiplier" value="5" />
+ <property name="cc_block_highlighting" value="false" />
+ </properties>
+ </rule>
+
+ <!-- DOCUMENTATION -->
+ <rule ref="category/apex/documentation.xml/ApexDoc" message="Document classes, methods, and properties that are public or global.">
+ <priority>3</priority>
+ <properties>
+ <!-- relevant for Code Climate output only -->
+ <property name="cc_categories" value="Style" />
+ <property name="cc_remediation_points_multiplier" value="50" />
+ <property name="cc_block_highlighting" value="false" />
+ </properties>
+ </rule>
+</ruleset>
diff --git a/pmd-apex/src/main/resources/rulesets/apex/rulesets.properties b/pmd-apex/src/main/resources/rulesets/apex/rulesets.properties
index 879f524f1dd..dab0624aee6 100644
--- a/pmd-apex/src/main/resources/rulesets/apex/rulesets.properties
+++ b/pmd-apex/src/main/resources/rulesets/apex/rulesets.properties
@@ -3,9 +3,15 @@
#
rulesets.filenames=\
- rulesets/apex/apexunit.xml,\
- rulesets/apex/braces.xml,\
- rulesets/apex/complexity.xml,\
- rulesets/apex/performance.xml,\
- rulesets/apex/security.xml,\
- rulesets/apex/style.xml
+ category/apex/bestpractices.xml,\
+ category/apex/codestyle.xml,\
+ category/apex/design.xml,\
+ category/apex/documentation.xml,\
+ category/apex/errorprone.xml,\
+ category/apex/performance.xml,\
+ category/apex/security.xml
+
+#
+# categories with no rules yet
+#
+#category/apex/multithreading.xml
diff --git a/pmd-apex/src/main/resources/rulesets/apex/security.xml b/pmd-apex/src/main/resources/rulesets/apex/security.xml
index 8f111016aca..998dc4e034f 100644
--- a/pmd-apex/src/main/resources/rulesets/apex/security.xml
+++ b/pmd-apex/src/main/resources/rulesets/apex/security.xml
@@ -2,274 +2,22 @@
<ruleset name="Security" xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
<description>
These rules deal with different security problems that can occur within Apex.
</description>
- <rule name="ApexSharingViolations"
- since="5.5.3"
- message="Apex classes should declare a sharing model if DML or SOQL/SOSL is used"
- class="net.sourceforge.pmd.lang.apex.rule.security.ApexSharingViolationsRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_security.html#apexsharingviolations">
- <description>
-Detect classes declared without explicit sharing mode if DML methods are used. This
-forces the developer to take access restrictions into account before modifying objects.
- </description>
- <priority>3</priority>
- <example>
-<![CDATA[
-public without sharing class Foo {
- // DML operation here
-}
-]]>
- </example>
- </rule>
-
- <rule name="ApexOpenRedirect"
- since="5.5.3"
- message="Apex classes should safely redirect to a known location"
- class="net.sourceforge.pmd.lang.apex.rule.security.ApexOpenRedirectRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_security.html#apexopenredirect">
- <description>
-Checks against redirects to user-controlled locations. This prevents attackers from
-redirecting users to phishing sites.
- </description>
- <priority>3</priority>
- <example>
-<![CDATA[
-public without sharing class Foo {
- String unsafeLocation = ApexPage.getCurrentPage().getParameters.get('url_param');
- PageReference page() {
- return new PageReference(unsafeLocation);
- }
-}
-]]>
- </example>
- </rule>
-
- <rule name="ApexInsecureEndpoint"
- since="5.5.3"
- message="Apex callouts should use encrypted communication channels"
- class="net.sourceforge.pmd.lang.apex.rule.security.ApexInsecureEndpointRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_security.html#apexinsecureendpoint">
- <description>
-Checks against accessing endpoints under plain **http**. You should always use
-**https** for security.
- </description>
- <priority>3</priority>
- <example>
-<![CDATA[
-public without sharing class Foo {
- void foo() {
- HttpRequest req = new HttpRequest();
- req.setEndpoint('http://localhost:com');
- }
-}
-]]>
- </example>
- </rule>
-
- <rule name="ApexXSSFromURLParam"
- since="5.5.3"
- message="Apex classes should escape/sanitize Strings obtained from URL parameters"
- class="net.sourceforge.pmd.lang.apex.rule.security.ApexXSSFromURLParamRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_security.html#apexxssfromurlparam">
- <description>
-Makes sure that all values obtained from URL parameters are properly escaped / sanitized
-to avoid XSS attacks.
- </description>
- <priority>3</priority>
- <example>
-<![CDATA[
-public without sharing class Foo {
- String unescapedstring = ApexPage.getCurrentPage().getParameters.get('url_param');
- String usedLater = unescapedstring;
-}
-]]>
- </example>
- </rule>
-
- <rule name="ApexXSSFromEscapeFalse"
- since="5.5.3"
- message="Apex classes should escape Strings in error messages"
- class="net.sourceforge.pmd.lang.apex.rule.security.ApexXSSFromEscapeFalseRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_security.html#apexxssfromescapefalse">
- <description>
-Reports on calls to `addError` with disabled escaping. The message passed to `addError`
-will be displayed directly to the user in the UI, making it prime ground for XSS
-attacks if unescaped.
- </description>
- <priority>3</priority>
- <example>
-<![CDATA[
-public without sharing class Foo {
- Trigger.new[0].addError(vulnerableHTMLGoesHere, false);
-}
-]]>
- </example>
- </rule>
-
- <rule name="ApexBadCrypto"
- since="5.5.3"
- message="Apex classes should use random IV/key"
- class="net.sourceforge.pmd.lang.apex.rule.security.ApexBadCryptoRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_security.html#apexbadcrypto">
- <description>
-The rule makes sure you are using randomly generated IVs and keys for `Crypto` calls.
-Hard-wiring these values greatly compromises the security of encrypted data.
- </description>
- <priority>3</priority>
- <example>
-<![CDATA[
-public without sharing class Foo {
- Blob hardCodedIV = Blob.valueOf('Hardcoded IV 123');
- Blob hardCodedKey = Blob.valueOf('0000000000000000');
- Blob data = Blob.valueOf('Data to be encrypted');
- Blob encrypted = Crypto.encrypt('AES128', hardCodedKey, hardCodedIV, data);
-}
-]]>
- </example>
- </rule>
-
- <rule name="ApexCSRF"
- since="5.5.3"
- message="Avoid making DML operations in Apex class constructor/init method"
- class="net.sourceforge.pmd.lang.apex.rule.security.ApexCSRFRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_security.html#apexcsrf">
- <description>
-Check to avoid making DML operations in Apex class constructor/init method. This prevents
-modification of the database just by accessing a page.
- </description>
- <priority>3</priority>
- <example>
-<![CDATA[
-public class Foo {
- public init() {
- insert data;
- }
-
- public Foo() {
- insert data;
- }
-}
-]]>
- </example>
- </rule>
-
- <rule name="ApexSOQLInjection"
- since="5.5.3"
- message="Avoid untrusted/unescaped variables in DML query"
- class="net.sourceforge.pmd.lang.apex.rule.security.ApexSOQLInjectionRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_security.html#apexsoqlinjection">
- <description>
-Detects the usage of untrusted / unescaped variables in DML queries.
- </description>
- <priority>3</priority>
- <example>
-<![CDATA[
-public class Foo {
- public void test1(String t1) {
- Database.query('SELECT Id FROM Account' + t1);
- }
-}
-]]>
- </example>
- </rule>
-
- <rule name="ApexCRUDViolation"
- since="5.5.3"
- message="Validate CRUD permission before SOQL/DML operation"
- class="net.sourceforge.pmd.lang.apex.rule.security.ApexCRUDViolationRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_security.html#apexcrudviolation">
- <description>
-The rule validates you are checking for access permissions before a SOQL/SOSL/DML operation.
-Since Apex runs in system mode not having proper permissions checks results in escalation of
-privilege and may produce runtime errors. This check forces you to handle such scenarios.
- </description>
- <priority>3</priority>
- <example>
-<![CDATA[
-public class Foo {
- public Contact foo(String status, String ID) {
- Contact c = [SELECT Status__c FROM Contact WHERE Id=:ID];
-
- // Make sure we can update the database before even trying
- if (!Schema.sObjectType.Contact.fields.Name.isUpdateable()) {
- return null;
- }
-
- c.Status__c = status;
- update c;
- return c;
- }
-}
-]]>
- </example>
- </rule>
-
- <rule name="ApexDangerousMethods"
- since="5.5.3"
- message="Calling potentially dangerous method"
- class="net.sourceforge.pmd.lang.apex.rule.security.ApexDangerousMethodsRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_security.html#apexdangerousmethods">
- <description><![CDATA[
-Checks against calling dangerous methods.
-
-For the time being, it reports:
-
-* Against `FinancialForce`'s `Configuration.disableTriggerCRUDSecurity()`. Disabling CRUD security
-opens the door to several attacks and requires manual validation, which is unreliable.
-* Calling `System.debug` passing sensitive data as parameter, which could lead to exposure
-of private data.
-]]>
- </description>
- <priority>3</priority>
- <example>
-<![CDATA[
-public class Foo {
- public Foo() {
- Configuration.disableTriggerCRUDSecurity();
- }
-}
-]]>
- </example>
- </rule>
-
- <rule name="ApexSuggestUsingNamedCred"
- since="5.5.3"
- message="Suggest named credentials for authentication"
- class="net.sourceforge.pmd.lang.apex.rule.security.ApexSuggestUsingNamedCredRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_security.html#apexsuggestusingnamedcred">
- <description><
-]]>
- </description>
- <priority>3</priority>
- <example>
-<![CDATA[
-public class Foo {
- public void foo(String username, String password) {
- Blob headerValue = Blob.valueOf(username + ':' + password);
- String authorizationHeader = 'BASIC ' + EncodingUtil.base64Encode(headerValue);
- req.setHeader('Authorization', authorizationHeader);
- }
-}
- ]]>
- </example>
- </rule>
+ <rule ref="category/apex/security.xml/ApexBadCrypto" deprecated="true" />
+ <rule ref="category/apex/security.xml/ApexCRUDViolation" deprecated="true" />
+ <rule ref="category/apex/security.xml/ApexCSRF" deprecated="true" />
+ <rule ref="category/apex/security.xml/ApexDangerousMethods" deprecated="true" />
+ <rule ref="category/apex/security.xml/ApexInsecureEndpoint" deprecated="true" />
+ <rule ref="category/apex/security.xml/ApexOpenRedirect" deprecated="true" />
+ <rule ref="category/apex/security.xml/ApexSharingViolations" deprecated="true" />
+ <rule ref="category/apex/security.xml/ApexSOQLInjection" deprecated="true" />
+ <rule ref="category/apex/security.xml/ApexSuggestUsingNamedCred" deprecated="true" />
+ <rule ref="category/apex/security.xml/ApexXSSFromEscapeFalse" deprecated="true" />
+ <rule ref="category/apex/security.xml/ApexXSSFromURLParam" deprecated="true" />
</ruleset>
diff --git a/pmd-apex/src/main/resources/rulesets/apex/style.xml b/pmd-apex/src/main/resources/rulesets/apex/style.xml
index 7c86b03a410..00f1c198a28 100644
--- a/pmd-apex/src/main/resources/rulesets/apex/style.xml
+++ b/pmd-apex/src/main/resources/rulesets/apex/style.xml
@@ -3,139 +3,20 @@
<ruleset name="Style"
xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
<description>
The Style Ruleset contains rules regarding preferred usage of names and identifiers.
</description>
- <rule name="VariableNamingConventions"
- since="5.5.0"
- message="{0} variable {1} should begin with {2}"
- class="net.sourceforge.pmd.lang.apex.rule.style.VariableNamingConventionsRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_style.html#variablenamingconventions">
- <description>
-A variable naming conventions rule - customize this to your liking. Currently, it
-checks for final variables that should be fully capitalized and non-final variables
-that should not include underscores.
- </description>
- <priority>1</priority>
- <example>
-<![CDATA[
-public class Foo {
- public static final Integer MY_NUM = 0;
- public String myTest = '';
- DataModule dmTest = new DataModule();
-}
-]]>
- </example>
- </rule>
+ <rule ref="category/apex/codestyle.xml/ClassNamingConventions" deprecated="true" />
+ <rule ref="category/apex/codestyle.xml/MethodNamingConventions" deprecated="true" />
+ <rule ref="category/apex/codestyle.xml/VariableNamingConventions" deprecated="true" />
- <rule name="MethodNamingConventions"
- since="5.5.0"
- message="Method name does not begin with a lower case character."
- class="net.sourceforge.pmd.lang.apex.rule.style.MethodNamingConventionsRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_style.html#methodnamingconventions">
- <description>
-Method names should always begin with a lower case character, and should not contain underscores.
- </description>
- <priority>1</priority>
- <example>
-<![CDATA[
-public class Foo {
- public void fooStuff() {
- }
-}
-]]>
- </example>
- </rule>
+ <rule ref="category/apex/errorprone.xml/AvoidDirectAccessTriggerMap" deprecated="true" />
+ <rule ref="category/apex/errorprone.xml/AvoidHardcodingId" deprecated="true" />
+ <rule ref="category/apex/errorprone.xml/MethodWithSameNameAsEnclosingClass" deprecated="true" />
- <rule name="ClassNamingConventions"
- since="5.5.0"
- message="Class names should begin with an uppercase character"
- class="net.sourceforge.pmd.lang.apex.rule.style.ClassNamingConventionsRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_style.html#classnamingconventions">
- <description>
-Class names should always begin with an upper case character.
- </description>
- <priority>1</priority>
- <example>
-<![CDATA[
-public class Foo {}
-]]>
- </example>
- </rule>
-
- <rule name="MethodWithSameNameAsEnclosingClass"
- since="5.5.0"
- message="Classes should not have non-constructor methods with the same name as the class"
- class="net.sourceforge.pmd.lang.apex.rule.style.MethodWithSameNameAsEnclosingClassRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_style.html#methodwithsamenameasenclosingclass">
- <description>
-Non-constructor methods should not have the same name as the enclosing class.
- </description>
- <priority>3</priority>
- <example>
-<![CDATA[
-public class MyClass {
- // this is OK because it is a constructor
- public MyClass() {}
- // this is bad because it is a method
- public void MyClass() {}
-}
-]]>
- </example>
- </rule>
-
- <rule name="AvoidLogicInTrigger"
- since="5.5.0"
- message="Avoid logic in triggers"
- class="net.sourceforge.pmd.lang.apex.rule.style.AvoidLogicInTriggerRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_style.html#avoidlogicintrigger">
- <description>
-As triggers do not allow methods like regular classes they are less flexible and suited to apply good encapsulation style.
-Therefore delegate the triggers work to a regular class (often called Trigger handler class).
-
-See more here: https://developer.salesforce.com/page/Trigger_Frameworks_and_Apex_Trigger_Best_Practices
- </description>
- <priority>3</priority>
- <example>
-<![CDATA[
-trigger Accounts on Account (before insert, before update, before delete, after insert, after update, after delete, after undelete) {
- for(Account acc : Trigger.new) {
- if(Trigger.isInsert) {
- // ...
- }
-
- // ...
-
- if(Trigger.isDelete) {
- // ...
- }
- }
-}
-]]>
- </example>
- </rule>
-
- <rule name="AvoidGlobalModifier"
- since="5.5.0"
- message="Avoid using global modifier"
- class="net.sourceforge.pmd.lang.apex.rule.style.AvoidGlobalModifierRule"
- externalInfoUrl="${pmd.website.baseurl}/pmd_rules_apex_style.html#avoidglobalmodifier">
- <description>
-Global classes should be avoided (especially in managed packages) as they can never be deleted or changed in signature. Always check twice if something needs to be global.
-Many interfaces (e.g. Batch) required global modifiers in the past but don't require this anymore. Don't lock yourself in.
- </description>
- <priority>3</priority>
- <example>
-<![CDATA[
-global class Unchangeable {
- global UndeletableType unchangable(UndeletableType param) {
- // ...
- }
-}
-]]>
- </example>
- </rule>
+ <rule ref="category/apex/bestpractices.xml/AvoidGlobalModifier" deprecated="true" />
+ <rule ref="category/apex/bestpractices.xml/AvoidLogicInTrigger" deprecated="true" />
</ruleset>
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/FooRule.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/FooRule.java
new file mode 100644
index 00000000000..19332eb45c6
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/FooRule.java
@@ -0,0 +1,58 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex;
+
+import net.sourceforge.pmd.lang.apex.ast.ASTField;
+import net.sourceforge.pmd.lang.apex.ast.ASTParameter;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
+import net.sourceforge.pmd.lang.apex.ast.ASTVariableDeclaration;
+import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
+
+/**
+ * Sample rule that detect any node with an image of "Foo". Used for testing.
+ */
+public class FooRule extends AbstractApexRule {
+
+ public FooRule() {
+ setMessage("No Foo allowed");
+ }
+
+ @Override
+ public Object visit(ASTUserClass c, Object ctx) {
+ if (c.getImage().equalsIgnoreCase("Foo")) {
+ addViolation(ctx, c);
+ }
+ return super.visit(c, ctx);
+ }
+
+ @Override
+ public Object visit(ASTVariableDeclaration c, Object ctx) {
+ if (c.getImage().equalsIgnoreCase("Foo")) {
+ addViolation(ctx, c);
+ }
+ return super.visit(c, ctx);
+ }
+
+ @Override
+ public Object visit(ASTField c, Object ctx) {
+ if (c.getImage().equalsIgnoreCase("Foo")) {
+ addViolation(ctx, c);
+ }
+ return super.visit(c, ctx);
+ }
+
+ @Override
+ public Object visit(ASTParameter c, Object ctx) {
+ if (c.getImage().equalsIgnoreCase("Foo")) {
+ addViolation(ctx, c);
+ }
+ return super.visit(c, ctx);
+ }
+
+ @Override
+ public String getName() {
+ return "NoFoo";
+ }
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/SuppressWarningsTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/SuppressWarningsTest.java
new file mode 100644
index 00000000000..a61670f4d19
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/SuppressWarningsTest.java
@@ -0,0 +1,184 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex;
+
+import static org.junit.Assert.assertEquals;
+
+import org.junit.Test;
+
+import net.sourceforge.pmd.PMD;
+import net.sourceforge.pmd.Report;
+import net.sourceforge.pmd.lang.LanguageRegistry;
+import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
+import net.sourceforge.pmd.lang.apex.rule.AbstractApexRule;
+import net.sourceforge.pmd.testframework.RuleTst;
+
+public class SuppressWarningsTest extends RuleTst {
+
+ private static class BarRule extends AbstractApexRule {
+ @Override
+ public Object visit(ASTUserClass clazz, Object ctx) {
+ if (clazz.getImage().equalsIgnoreCase("bar")) {
+ addViolation(ctx, clazz);
+ }
+ return super.visit(clazz, ctx);
+ }
+
+ @Override
+ public String getName() {
+ return "NoBar";
+ }
+ }
+
+ @Test
+ public void testClassLevelSuppression() {
+ Report rpt = new Report();
+ runTestFromString(TEST1, new FooRule(), rpt,
+ LanguageRegistry.getLanguage(ApexLanguageModule.NAME).getVersion("35"));
+ assertEquals(0, rpt.size());
+ runTestFromString(TEST2, new FooRule(), rpt,
+ LanguageRegistry.getLanguage(ApexLanguageModule.NAME).getVersion("35"));
+ assertEquals(0, rpt.size());
+ }
+
+ @Test
+ public void testInheritedSuppression() {
+ Report rpt = new Report();
+ runTestFromString(TEST3, new FooRule(), rpt,
+ LanguageRegistry.getLanguage(ApexLanguageModule.NAME).getVersion("35"));
+ assertEquals(0, rpt.size());
+ }
+
+ @Test
+ public void testMethodLevelSuppression() {
+ Report rpt = new Report();
+ runTestFromString(TEST4, new FooRule(), rpt,
+ LanguageRegistry.getLanguage(ApexLanguageModule.NAME).getVersion("35"));
+ assertEquals(1, rpt.size());
+ }
+
+ @Test
+ public void testConstructorLevelSuppression() {
+ Report rpt = new Report();
+ runTestFromString(TEST5, new FooRule(), rpt,
+ LanguageRegistry.getLanguage(ApexLanguageModule.NAME).getVersion("35"));
+ assertEquals(0, rpt.size());
+ }
+
+ @Test
+ public void testFieldLevelSuppression() {
+ Report rpt = new Report();
+ runTestFromString(TEST6, new FooRule(), rpt,
+ LanguageRegistry.getLanguage(ApexLanguageModule.NAME).getVersion("35"));
+ assertEquals(1, rpt.size());
+ }
+
+ @Test
+ public void testParameterLevelSuppression() {
+ Report rpt = new Report();
+ runTestFromString(TEST7, new FooRule(), rpt,
+ LanguageRegistry.getLanguage(ApexLanguageModule.NAME).getVersion("35"));
+ assertEquals(1, rpt.size());
+ }
+
+ @Test
+ public void testLocalVariableLevelSuppression() {
+ Report rpt = new Report();
+ runTestFromString(TEST8, new FooRule(), rpt,
+ LanguageRegistry.getLanguage(ApexLanguageModule.NAME).getVersion("35"));
+ assertEquals(1, rpt.size());
+ }
+
+ @Test
+ public void testSpecificSuppression() {
+ Report rpt = new Report();
+ runTestFromString(TEST9, new FooRule(), rpt,
+ LanguageRegistry.getLanguage(ApexLanguageModule.NAME).getVersion("35"));
+ assertEquals(1, rpt.size());
+ }
+
+ @Test
+ public void testSpecificSuppressionMulitpleValues() {
+ Report rpt = new Report();
+ runTestFromString(TEST9_MULTIPLE_VALUES, new FooRule(), rpt,
+ LanguageRegistry.getLanguage(ApexLanguageModule.NAME).getVersion("35"));
+ assertEquals(0, rpt.size());
+ }
+
+ @Test
+ public void testNoSuppressionBlank() {
+ Report rpt = new Report();
+ runTestFromString(TEST10, new FooRule(), rpt,
+ LanguageRegistry.getLanguage(ApexLanguageModule.NAME).getVersion("35"));
+ assertEquals(2, rpt.size());
+ }
+
+ @Test
+ public void testNoSuppressionSomethingElseS() {
+ Report rpt = new Report();
+ runTestFromString(TEST11, new FooRule(), rpt,
+ LanguageRegistry.getLanguage(ApexLanguageModule.NAME).getVersion("35"));
+ assertEquals(2, rpt.size());
+ }
+
+ @Test
+ public void testSuppressAll() {
+ Report rpt = new Report();
+ runTestFromString(TEST12, new FooRule(), rpt,
+ LanguageRegistry.getLanguage(ApexLanguageModule.NAME).getVersion("35"));
+ assertEquals(0, rpt.size());
+ }
+
+ @Test
+ public void testSpecificSuppressionAtTopLevel() {
+ Report rpt = new Report();
+ runTestFromString(TEST13, new BarRule(), rpt,
+ LanguageRegistry.getLanguage(ApexLanguageModule.NAME).getVersion("35"));
+ assertEquals(0, rpt.size());
+ }
+
+ private static final String TEST1 = "@SuppressWarnings('PMD')" + PMD.EOL + "public class Foo {}";
+
+ private static final String TEST2 = "@SuppressWarnings('PMD')" + PMD.EOL + "public class Foo {" + PMD.EOL
+ + " void bar() {" + PMD.EOL + " Integer foo;" + PMD.EOL + " }" + PMD.EOL + "}";
+
+ private static final String TEST3 = "public class Baz {" + PMD.EOL + " @SuppressWarnings('PMD')" + PMD.EOL
+ + " public class Bar {" + PMD.EOL + " void bar() {" + PMD.EOL + " Integer foo;" + PMD.EOL + " }" + PMD.EOL
+ + " }" + PMD.EOL + "}";
+
+ private static final String TEST4 = "public class Foo {" + PMD.EOL + " @SuppressWarnings('PMD')" + PMD.EOL
+ + " void bar() {" + PMD.EOL + " Integer foo;" + PMD.EOL + " }" + PMD.EOL + "}";
+
+ private static final String TEST5 = "public class Bar {" + PMD.EOL + " @SuppressWarnings('PMD')" + PMD.EOL
+ + " public Bar() {" + PMD.EOL + " Integer foo;" + PMD.EOL + " }" + PMD.EOL + "}";
+
+ private static final String TEST6 = "public class Bar {" + PMD.EOL + " @SuppressWarnings('PMD')" + PMD.EOL
+ + " Integer foo;" + PMD.EOL + " void bar() {" + PMD.EOL + " Integer foo;" + PMD.EOL + " }" + PMD.EOL + "}";
+
+ private static final String TEST7 = "public class Bar {" + PMD.EOL + " Integer foo;" + PMD.EOL
+ + " void bar(@SuppressWarnings('PMD') Integer foo) {}" + PMD.EOL + "}";
+
+ private static final String TEST8 = "public class Bar {" + PMD.EOL + " Integer foo;" + PMD.EOL + " void bar() {"
+ + PMD.EOL + " @SuppressWarnings('PMD') Integer foo;" + PMD.EOL + " }" + PMD.EOL + "}";
+
+ private static final String TEST9 = "public class Bar {" + PMD.EOL + " Integer foo;" + PMD.EOL + " void bar() {"
+ + PMD.EOL + " @SuppressWarnings('PMD.NoFoo') Integer foo;" + PMD.EOL + " }" + PMD.EOL + "}";
+
+ private static final String TEST9_MULTIPLE_VALUES = "@SuppressWarnings('PMD.NoFoo, PMD.NoBar')"
+ + PMD.EOL + "public class Bar {" + PMD.EOL + " Integer foo;" + PMD.EOL + " void bar() {" + PMD.EOL
+ + " Integer foo;" + PMD.EOL + " }" + PMD.EOL + "}";
+
+ private static final String TEST10 = "public class Bar {" + PMD.EOL + " Integer foo;" + PMD.EOL + " void bar() {"
+ + PMD.EOL + " @SuppressWarnings('') Integer foo;" + PMD.EOL + " }" + PMD.EOL + "}";
+
+ private static final String TEST11 = "public class Bar {" + PMD.EOL + " Integer foo;" + PMD.EOL + " void bar() {"
+ + PMD.EOL + " @SuppressWarnings('SomethingElse') Integer foo;" + PMD.EOL + " }" + PMD.EOL + "}";
+
+ private static final String TEST12 = "public class Bar {" + PMD.EOL + " @SuppressWarnings('all') Integer foo;"
+ + PMD.EOL + "}";
+
+ private static final String TEST13 = "@SuppressWarnings('PMD.NoBar')" + PMD.EOL + "public class Bar {" + PMD.EOL
+ + "}";
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/ast/ApexParserTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/ast/ApexParserTest.java
index 1e4498b82f2..c1fdd406df9 100644
--- a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/ast/ApexParserTest.java
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/ast/ApexParserTest.java
@@ -6,8 +6,10 @@
import static net.sourceforge.pmd.lang.apex.ast.ApexParserTestHelpers.parse;
import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
import java.io.File;
+import java.nio.charset.StandardCharsets;
import java.util.List;
import org.apache.commons.io.FileUtils;
@@ -76,6 +78,7 @@ private void assertLineNumbersForTestCode(ApexNode<Compilation> rootNode) {
// BlockStatement - the whole method body
Node blockStatement = method1.jjtGetChild(1);
+ assertTrue(((ASTBlockStatement) blockStatement).hasCurlyBrace());
assertPosition(blockStatement, 2, 27, 5, 5);
// the expression ("System.out...")
@@ -111,7 +114,7 @@ public void parsesRealWorldClasses() throws Exception {
for (File file : fList) {
if (file.isFile() && file.getName().endsWith(".cls")) {
- String sourceCode = FileUtils.readFileToString(file);
+ String sourceCode = FileUtils.readFileToString(file, StandardCharsets.UTF_8);
ApexNode<Compilation> rootNode = parse(sourceCode);
Assert.assertNotNull(rootNode);
}
@@ -125,12 +128,13 @@ public void parsesRealWorldClasses() throws Exception {
*/
@Test
public void stackOverflowDuringClassParsing() throws Exception {
- String source = IOUtils.toString(ApexParserTest.class.getResourceAsStream("StackOverflowClass.cls"));
+ String source = IOUtils.toString(ApexParserTest.class.getResourceAsStream("StackOverflowClass.cls"),
+ StandardCharsets.UTF_8);
ApexNode<Compilation> rootNode = parse(source);
Assert.assertNotNull(rootNode);
int count = visitPosition(rootNode, 0);
- Assert.assertEquals(489, count);
+ Assert.assertEquals(427, count);
}
private int visitPosition(Node node, int count) {
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/ast/ApexQualifiedNameTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/ast/ApexQualifiedNameTest.java
index a85430f8fdf..4bb620c6549 100644
--- a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/ast/ApexQualifiedNameTest.java
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/ast/ApexQualifiedNameTest.java
@@ -15,6 +15,7 @@
import apex.jorje.semantic.ast.compilation.Compilation;
+
/**
* @author Clément Fournier
*/
@@ -69,9 +70,9 @@ public void testMethodWithArguments() {
@Test
public void testOverLoads() {
ApexNode<Compilation> root = ApexParserTestHelpers.parse("public class Foo { "
- + "String foo(String h) {} "
- + "String foo(int c) {}"
- + "String foo(Foo c) {}}");
+ + "String foo(String h) {} "
+ + "String foo(int c) {}"
+ + "String foo(Foo c) {}}");
List<ASTMethod> methods = root.findDescendantsOfType(ASTMethod.class);
@@ -83,4 +84,17 @@ public void testOverLoads() {
}
}
}
+
+
+ @Test
+ public void testTrigger() {
+ ApexNode<Compilation> root = ApexParserTestHelpers.parse("trigger myAccountTrigger on Account (before insert, before update) {}");
+
+
+ List<ASTMethod> methods = root.findDescendantsOfType(ASTMethod.class);
+
+ for (ASTMethod m : methods) {
+ assertEquals("c__trigger.Account#myAccountTrigger", m.getQualifiedName().toString());
+ }
+ }
}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/metrics/ApexMetricsVisitorTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/metrics/ApexMetricsVisitorTest.java
deleted file mode 100644
index b16f610ddb8..00000000000
--- a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/metrics/ApexMetricsVisitorTest.java
+++ /dev/null
@@ -1,69 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.metrics;
-
-import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.assertTrue;
-
-import java.io.IOException;
-
-import org.apache.commons.io.IOUtils;
-import org.junit.Test;
-
-import net.sourceforge.pmd.lang.LanguageRegistry;
-import net.sourceforge.pmd.lang.LanguageVersionHandler;
-import net.sourceforge.pmd.lang.apex.ApexLanguageModule;
-import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
-import net.sourceforge.pmd.lang.apex.ast.ApexNode;
-import net.sourceforge.pmd.lang.apex.ast.ApexParserTest;
-import net.sourceforge.pmd.lang.apex.ast.ApexParserTestHelpers;
-import net.sourceforge.pmd.lang.apex.ast.ApexParserVisitorAdapter;
-import net.sourceforge.pmd.lang.apex.metrics.signature.ApexOperationSigMask;
-
-import apex.jorje.semantic.ast.compilation.Compilation;
-
-/**
- * @author Clément Fournier
- */
-public class ApexMetricsVisitorTest extends ApexParserTest {
-
- @Test
- public void testProjectMirrorNotNull() {
- assertNotNull(ApexMetrics.getFacade().getProjectMirror());
- }
-
-
- @Test
- public void testOperationsAreThere() throws IOException {
- ApexNode<Compilation> acu = parseAndVisitForString(
- IOUtils.toString(ApexMetricsVisitorTest.class.getResourceAsStream("MetadataDeployController.cls")));
-
- final ApexSignatureMatcher toplevel = ApexMetrics.getFacade().getProjectMirror();
-
- final ApexOperationSigMask opMask = new ApexOperationSigMask();
-
- // We could parse qnames from string but probably simpler to do that
- acu.jjtAccept(new ApexParserVisitorAdapter() {
- @Override
- public Object visit(ASTMethod node, Object data) {
- if (!node.getImage().matches("(<clinit>|<init>|clone)")) {
- assertTrue(toplevel.hasMatchingSig(node.getQualifiedName(), opMask));
- }
-
- return data;
- }
- }, null);
- }
-
-
- static ApexNode<Compilation> parseAndVisitForString(String source) {
- LanguageVersionHandler languageVersionHandler = LanguageRegistry.getLanguage(ApexLanguageModule.NAME)
- .getDefaultVersion().getLanguageVersionHandler();
- ApexNode<Compilation> acu = ApexParserTestHelpers.parse(source);
- languageVersionHandler.getSymbolFacade().start(acu);
- languageVersionHandler.getMetricsVisitorFacade().start(acu);
- return acu;
- }
-}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/metrics/ApexProjectMirrorTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/metrics/ApexProjectMirrorTest.java
index 8534858d5db..9c78229005a 100644
--- a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/metrics/ApexProjectMirrorTest.java
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/metrics/ApexProjectMirrorTest.java
@@ -4,11 +4,11 @@
package net.sourceforge.pmd.lang.apex.metrics;
-import static net.sourceforge.pmd.lang.apex.metrics.ApexMetricsVisitorTest.parseAndVisitForString;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotEquals;
import java.io.IOException;
+import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.List;
import java.util.Random;
@@ -16,13 +16,18 @@
import org.apache.commons.io.IOUtils;
import org.junit.Test;
+import net.sourceforge.pmd.lang.LanguageRegistry;
+import net.sourceforge.pmd.lang.LanguageVersionHandler;
+import net.sourceforge.pmd.lang.apex.ApexLanguageModule;
import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
import net.sourceforge.pmd.lang.apex.ast.ASTUserClass;
import net.sourceforge.pmd.lang.apex.ast.ASTUserClassOrInterface;
import net.sourceforge.pmd.lang.apex.ast.ApexNode;
+import net.sourceforge.pmd.lang.apex.ast.ApexParserTestHelpers;
import net.sourceforge.pmd.lang.apex.ast.ApexParserVisitorAdapter;
import net.sourceforge.pmd.lang.apex.metrics.impl.AbstractApexClassMetric;
import net.sourceforge.pmd.lang.apex.metrics.impl.AbstractApexOperationMetric;
+import net.sourceforge.pmd.lang.apex.multifile.ApexMultifileVisitorTest;
import net.sourceforge.pmd.lang.metrics.MetricKey;
import net.sourceforge.pmd.lang.metrics.MetricKeyUtil;
import net.sourceforge.pmd.lang.metrics.MetricMemoizer;
@@ -43,7 +48,8 @@ public class ApexProjectMirrorTest {
static {
try {
acu = parseAndVisitForString(
- IOUtils.toString(ApexMetricsVisitorTest.class.getResourceAsStream("MetadataDeployController.cls")));
+ IOUtils.toString(ApexMultifileVisitorTest.class.getResourceAsStream("MetadataDeployController.cls"),
+ StandardCharsets.UTF_8));
} catch (IOException ioe) {
// Should definitely not happen
}
@@ -104,6 +110,14 @@ public Object visit(ASTUserClass node, Object data) {
}
+ static ApexNode<Compilation> parseAndVisitForString(String source) {
+ LanguageVersionHandler languageVersionHandler = LanguageRegistry.getLanguage(ApexLanguageModule.NAME)
+ .getDefaultVersion().getLanguageVersionHandler();
+ ApexNode<Compilation> acu = ApexParserTestHelpers.parse(source);
+ languageVersionHandler.getSymbolFacade().start(acu);
+ return acu;
+ }
+
private class RandomOperationMetric extends AbstractApexOperationMetric {
private Random random = new Random();
@@ -126,4 +140,5 @@ public double computeFor(ASTUserClassOrInterface<?> node, MetricOptions options)
}
}
+
}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/multifile/ApexMultifileVisitorTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/multifile/ApexMultifileVisitorTest.java
new file mode 100644
index 00000000000..2add9a6c3be
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/multifile/ApexMultifileVisitorTest.java
@@ -0,0 +1,72 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.multifile;
+
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
+
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+
+import org.apache.commons.io.IOUtils;
+import org.junit.Test;
+
+import net.sourceforge.pmd.lang.LanguageRegistry;
+import net.sourceforge.pmd.lang.LanguageVersionHandler;
+import net.sourceforge.pmd.lang.apex.ApexLanguageModule;
+import net.sourceforge.pmd.lang.apex.ast.ASTMethod;
+import net.sourceforge.pmd.lang.apex.ast.ApexNode;
+import net.sourceforge.pmd.lang.apex.ast.ApexParserTest;
+import net.sourceforge.pmd.lang.apex.ast.ApexParserTestHelpers;
+import net.sourceforge.pmd.lang.apex.ast.ApexParserVisitorAdapter;
+import net.sourceforge.pmd.lang.apex.metrics.ApexSignatureMatcher;
+import net.sourceforge.pmd.lang.apex.metrics.signature.ApexOperationSigMask;
+
+import apex.jorje.semantic.ast.compilation.Compilation;
+
+/**
+ * @author Clément Fournier
+ */
+public class ApexMultifileVisitorTest extends ApexParserTest {
+
+ @Test
+ public void testProjectMirrorNotNull() {
+ assertNotNull(ApexProjectMirror.INSTANCE);
+ }
+
+
+ @Test
+ public void testOperationsAreThere() throws IOException {
+ ApexNode<Compilation> acu = parseAndVisitForString(
+ IOUtils.toString(ApexMultifileVisitorTest.class.getResourceAsStream("MetadataDeployController.cls"),
+ StandardCharsets.UTF_8));
+
+ final ApexSignatureMatcher toplevel = ApexProjectMirror.INSTANCE;
+
+ final ApexOperationSigMask opMask = new ApexOperationSigMask();
+
+ // We could parse qnames from string but probably simpler to do that
+ acu.jjtAccept(new ApexParserVisitorAdapter() {
+ @Override
+ public Object visit(ASTMethod node, Object data) {
+ if (!node.getImage().matches("(<clinit>|<init>|clone)")) {
+ assertTrue(toplevel.hasMatchingSig(node.getQualifiedName(), opMask));
+ }
+
+ return data;
+ }
+ }, null);
+ }
+
+
+ static ApexNode<Compilation> parseAndVisitForString(String source) {
+ LanguageVersionHandler languageVersionHandler = LanguageRegistry.getLanguage(ApexLanguageModule.NAME)
+ .getDefaultVersion().getLanguageVersionHandler();
+ ApexNode<Compilation> acu = ApexParserTestHelpers.parse(source);
+ languageVersionHandler.getSymbolFacade().start(acu);
+ languageVersionHandler.getMultifileFacade().start(acu);
+ return acu;
+ }
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/apexunit/ApexUnitRulesTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/apexunit/ApexUnitRulesTest.java
deleted file mode 100644
index 8b2222df8ec..00000000000
--- a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/apexunit/ApexUnitRulesTest.java
+++ /dev/null
@@ -1,21 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.rule.apexunit;
-
-import net.sourceforge.pmd.testframework.SimpleAggregatorTst;
-
-/**
- * @author a.subramanian
- */
-public class ApexUnitRulesTest extends SimpleAggregatorTst {
-
- private static final String RULESET = "apex-apexunit";
-
- @Override
- public void setUp() {
- addRule(RULESET, "ApexUnitTestClassShouldHaveAsserts");
- addRule(RULESET, "ApexUnitTestShouldNotUseSeeAllDataTrue");
- }
-}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/bestpractices/ApexUnitTestClassShouldHaveAssertsTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/bestpractices/ApexUnitTestClassShouldHaveAssertsTest.java
new file mode 100644
index 00000000000..5c3d68226e0
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/bestpractices/ApexUnitTestClassShouldHaveAssertsTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.bestpractices;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class ApexUnitTestClassShouldHaveAssertsTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/bestpractices/ApexUnitTestShouldNotUseSeeAllDataTrueTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/bestpractices/ApexUnitTestShouldNotUseSeeAllDataTrueTest.java
new file mode 100644
index 00000000000..00084bc52e6
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/bestpractices/ApexUnitTestShouldNotUseSeeAllDataTrueTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.bestpractices;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class ApexUnitTestShouldNotUseSeeAllDataTrueTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/bestpractices/AvoidGlobalModifierTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/bestpractices/AvoidGlobalModifierTest.java
new file mode 100644
index 00000000000..6a1780bfc9d
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/bestpractices/AvoidGlobalModifierTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.bestpractices;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class AvoidGlobalModifierTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/bestpractices/AvoidLogicInTriggerTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/bestpractices/AvoidLogicInTriggerTest.java
new file mode 100644
index 00000000000..08cfa53ada6
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/bestpractices/AvoidLogicInTriggerTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.bestpractices;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class AvoidLogicInTriggerTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/braces/BracesRulesTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/braces/BracesRulesTest.java
deleted file mode 100644
index 09cbb1cc89d..00000000000
--- a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/braces/BracesRulesTest.java
+++ /dev/null
@@ -1,20 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.rule.braces;
-
-import net.sourceforge.pmd.testframework.SimpleAggregatorTst;
-
-public class BracesRulesTest extends SimpleAggregatorTst {
-
- private static final String RULESET = "apex-braces";
-
- @Override
- public void setUp() {
- addRule(RULESET, "ForLoopsMustUseBraces");
- addRule(RULESET, "IfElseStmtsMustUseBraces");
- addRule(RULESET, "IfStmtsMustUseBraces");
- addRule(RULESET, "WhileLoopsMustUseBraces");
- }
-}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/codestyle/ClassNamingConventionsTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/codestyle/ClassNamingConventionsTest.java
new file mode 100644
index 00000000000..6e44c82f667
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/codestyle/ClassNamingConventionsTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.codestyle;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class ClassNamingConventionsTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/codestyle/ForLoopsMustUseBracesTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/codestyle/ForLoopsMustUseBracesTest.java
new file mode 100644
index 00000000000..32e64fa7c83
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/codestyle/ForLoopsMustUseBracesTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.codestyle;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class ForLoopsMustUseBracesTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/codestyle/IfElseStmtsMustUseBracesTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/codestyle/IfElseStmtsMustUseBracesTest.java
new file mode 100644
index 00000000000..8c118c38d7b
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/codestyle/IfElseStmtsMustUseBracesTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.codestyle;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class IfElseStmtsMustUseBracesTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/codestyle/IfStmtsMustUseBracesTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/codestyle/IfStmtsMustUseBracesTest.java
new file mode 100644
index 00000000000..049d251fbd7
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/codestyle/IfStmtsMustUseBracesTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.codestyle;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class IfStmtsMustUseBracesTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/codestyle/MethodNamingConventionsTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/codestyle/MethodNamingConventionsTest.java
new file mode 100644
index 00000000000..2be02e5acbf
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/codestyle/MethodNamingConventionsTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.codestyle;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class MethodNamingConventionsTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/codestyle/OneDeclarationPerLineTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/codestyle/OneDeclarationPerLineTest.java
new file mode 100644
index 00000000000..fa97125829b
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/codestyle/OneDeclarationPerLineTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.codestyle;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class OneDeclarationPerLineTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/codestyle/VariableNamingConventionsTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/codestyle/VariableNamingConventionsTest.java
new file mode 100644
index 00000000000..dbca24d0313
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/codestyle/VariableNamingConventionsTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.codestyle;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class VariableNamingConventionsTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/codestyle/WhileLoopsMustUseBracesTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/codestyle/WhileLoopsMustUseBracesTest.java
new file mode 100644
index 00000000000..e5a005e7262
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/codestyle/WhileLoopsMustUseBracesTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.codestyle;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class WhileLoopsMustUseBracesTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/complexity/ComplexityRulesTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/complexity/ComplexityRulesTest.java
deleted file mode 100644
index 21f66d18802..00000000000
--- a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/complexity/ComplexityRulesTest.java
+++ /dev/null
@@ -1,25 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.rule.complexity;
-
-import net.sourceforge.pmd.testframework.SimpleAggregatorTst;
-
-public class ComplexityRulesTest extends SimpleAggregatorTst {
-
- private static final String RULESET = "apex-complexity";
-
- @Override
- public void setUp() {
- addRule(RULESET, "AvoidDeeplyNestedIfStmts");
- addRule(RULESET, "ExcessiveClassLength");
- addRule(RULESET, "ExcessiveParameterList");
- addRule(RULESET, "ExcessivePublicCount");
- addRule(RULESET, "NcssConstructorCount");
- addRule(RULESET, "NcssMethodCount");
- addRule(RULESET, "NcssTypeCount");
- addRule(RULESET, "StdCyclomaticComplexity");
- addRule(RULESET, "TooManyFields");
- }
-}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/complexity/StdCyclomaticComplexityRuleTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/complexity/StdCyclomaticComplexityRuleTest.java
deleted file mode 100644
index 7aadd87c141..00000000000
--- a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/complexity/StdCyclomaticComplexityRuleTest.java
+++ /dev/null
@@ -1,43 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.rule.complexity;
-
-import java.io.StringReader;
-import java.util.Arrays;
-
-import org.junit.Assert;
-import org.junit.Test;
-
-import net.sourceforge.pmd.RuleContext;
-import net.sourceforge.pmd.lang.LanguageRegistry;
-import net.sourceforge.pmd.lang.LanguageVersion;
-import net.sourceforge.pmd.lang.Parser;
-import net.sourceforge.pmd.lang.ParserOptions;
-import net.sourceforge.pmd.lang.apex.ApexLanguageModule;
-import net.sourceforge.pmd.lang.ast.Node;
-
-public class StdCyclomaticComplexityRuleTest {
- /**
- * Make sure the entry stack is empty, if show classes complexity is
- * disabled.
- *
- * @see <a href="https://sourceforge.net/p/pmd/bugs/1501/">bug #1501</a>
- */
- @Test
- public void entryStackMustBeEmpty() {
- StdCyclomaticComplexityRule rule = new StdCyclomaticComplexityRule();
- rule.setProperty(StdCyclomaticComplexityRule.SHOW_CLASSES_COMPLEXITY_DESCRIPTOR, Boolean.FALSE);
-
- RuleContext ctx = new RuleContext();
- LanguageVersion javaLanguageVersion = LanguageRegistry.getLanguage(ApexLanguageModule.NAME).getDefaultVersion();
- ParserOptions parserOptions = javaLanguageVersion.getLanguageVersionHandler().getDefaultParserOptions();
- Parser parser = javaLanguageVersion.getLanguageVersionHandler().getParser(parserOptions);
- Node node = parser.parse("test", new StringReader("public class SampleClass {}"));
-
- rule.apply(Arrays.asList(node), ctx);
-
- Assert.assertTrue(rule.entryStack.isEmpty());
- }
-}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/AvoidDeeplyNestedIfStmtsTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/AvoidDeeplyNestedIfStmtsTest.java
new file mode 100644
index 00000000000..abf3e78e0cb
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/AvoidDeeplyNestedIfStmtsTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.design;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class AvoidDeeplyNestedIfStmtsTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/CyclomaticComplexityTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/CyclomaticComplexityTest.java
new file mode 100644
index 00000000000..d6673508874
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/CyclomaticComplexityTest.java
@@ -0,0 +1,17 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.design;
+
+import net.sourceforge.pmd.Rule;
+import net.sourceforge.pmd.lang.apex.metrics.ApexMetricsHook;
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class CyclomaticComplexityTest extends PmdRuleTst {
+ @Override
+ protected Rule reinitializeRule(Rule rule) {
+ ApexMetricsHook.reset();
+ return super.reinitializeRule(rule);
+ }
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/ExcessiveClassLengthTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/ExcessiveClassLengthTest.java
new file mode 100644
index 00000000000..5cde5c180c3
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/ExcessiveClassLengthTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.design;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class ExcessiveClassLengthTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/ExcessiveParameterListTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/ExcessiveParameterListTest.java
new file mode 100644
index 00000000000..d2263e88b6e
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/ExcessiveParameterListTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.design;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class ExcessiveParameterListTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/ExcessivePublicCountTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/ExcessivePublicCountTest.java
new file mode 100644
index 00000000000..20a52344b15
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/ExcessivePublicCountTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.design;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class ExcessivePublicCountTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/NcssConstructorCountTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/NcssConstructorCountTest.java
new file mode 100644
index 00000000000..ec837f8518a
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/NcssConstructorCountTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.design;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class NcssConstructorCountTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/NcssMethodCountTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/NcssMethodCountTest.java
new file mode 100644
index 00000000000..8f9b35c018a
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/NcssMethodCountTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.design;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class NcssMethodCountTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/NcssTypeCountTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/NcssTypeCountTest.java
new file mode 100644
index 00000000000..3416a142c96
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/NcssTypeCountTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.design;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class NcssTypeCountTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/StdCyclomaticComplexityTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/StdCyclomaticComplexityTest.java
new file mode 100644
index 00000000000..421d5c45e56
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/StdCyclomaticComplexityTest.java
@@ -0,0 +1,44 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.design;
+
+import java.io.StringReader;
+import java.util.Arrays;
+
+import org.junit.Assert;
+import org.junit.Test;
+
+import net.sourceforge.pmd.RuleContext;
+import net.sourceforge.pmd.lang.LanguageRegistry;
+import net.sourceforge.pmd.lang.LanguageVersion;
+import net.sourceforge.pmd.lang.Parser;
+import net.sourceforge.pmd.lang.ParserOptions;
+import net.sourceforge.pmd.lang.apex.ApexLanguageModule;
+import net.sourceforge.pmd.lang.ast.Node;
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class StdCyclomaticComplexityTest extends PmdRuleTst {
+ /**
+ * Make sure the entry stack is empty, if show classes complexity is
+ * disabled.
+ *
+ * @see <a href="https://sourceforge.net/p/pmd/bugs/1501/">bug #1501</a>
+ */
+ @Test
+ public void entryStackMustBeEmpty() {
+ StdCyclomaticComplexityRule rule = new StdCyclomaticComplexityRule();
+ rule.setProperty(StdCyclomaticComplexityRule.SHOW_CLASSES_COMPLEXITY_DESCRIPTOR, Boolean.FALSE);
+
+ RuleContext ctx = new RuleContext();
+ LanguageVersion javaLanguageVersion = LanguageRegistry.getLanguage(ApexLanguageModule.NAME).getDefaultVersion();
+ ParserOptions parserOptions = javaLanguageVersion.getLanguageVersionHandler().getDefaultParserOptions();
+ Parser parser = javaLanguageVersion.getLanguageVersionHandler().getParser(parserOptions);
+ Node node = parser.parse("test", new StringReader("public class SampleClass {}"));
+
+ rule.apply(Arrays.asList(node), ctx);
+
+ Assert.assertTrue(rule.entryStack.isEmpty());
+ }
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/TooManyFieldsTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/TooManyFieldsTest.java
new file mode 100644
index 00000000000..71becae7c6d
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/design/TooManyFieldsTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.design;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class TooManyFieldsTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/documentation/ApexDocTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/documentation/ApexDocTest.java
new file mode 100644
index 00000000000..93273a11ad9
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/documentation/ApexDocTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.documentation;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class ApexDocTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/AvoidDirectAccessTriggerMapTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/AvoidDirectAccessTriggerMapTest.java
new file mode 100644
index 00000000000..fbe6cd530e1
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/AvoidDirectAccessTriggerMapTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.errorprone;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class AvoidDirectAccessTriggerMapTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/AvoidHardcodingIdTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/AvoidHardcodingIdTest.java
new file mode 100644
index 00000000000..51f261aec03
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/AvoidHardcodingIdTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.errorprone;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class AvoidHardcodingIdTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/AvoidNonExistentAnnotationsTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/AvoidNonExistentAnnotationsTest.java
new file mode 100644
index 00000000000..45139b9d0ab
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/AvoidNonExistentAnnotationsTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.errorprone;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class AvoidNonExistentAnnotationsTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/EmptyCatchBlockTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/EmptyCatchBlockTest.java
new file mode 100644
index 00000000000..a6c0dc0cead
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/EmptyCatchBlockTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.errorprone;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class EmptyCatchBlockTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/EmptyIfStmtTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/EmptyIfStmtTest.java
new file mode 100644
index 00000000000..cc8f0a982e0
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/EmptyIfStmtTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.errorprone;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class EmptyIfStmtTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/EmptyStatementBlockTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/EmptyStatementBlockTest.java
new file mode 100644
index 00000000000..7a39e1aba51
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/EmptyStatementBlockTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.errorprone;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class EmptyStatementBlockTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/EmptyTryOrFinallyBlockTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/EmptyTryOrFinallyBlockTest.java
new file mode 100644
index 00000000000..d2d24d91afd
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/EmptyTryOrFinallyBlockTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.errorprone;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class EmptyTryOrFinallyBlockTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/EmptyWhileStmtTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/EmptyWhileStmtTest.java
new file mode 100644
index 00000000000..3a98d7a9cda
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/EmptyWhileStmtTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.errorprone;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class EmptyWhileStmtTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/MethodWithSameNameAsEnclosingClassTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/MethodWithSameNameAsEnclosingClassTest.java
new file mode 100644
index 00000000000..87e1ce64319
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/errorprone/MethodWithSameNameAsEnclosingClassTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.errorprone;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class MethodWithSameNameAsEnclosingClassTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/metrics/MetricsRulesTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/metrics/MetricsRulesTest.java
deleted file mode 100644
index ec2fae8091d..00000000000
--- a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/metrics/MetricsRulesTest.java
+++ /dev/null
@@ -1,31 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.rule.metrics;
-
-import net.sourceforge.pmd.Rule;
-import net.sourceforge.pmd.lang.apex.metrics.ApexMetricsHook;
-import net.sourceforge.pmd.testframework.SimpleAggregatorTst;
-
-/**
- * @author Clément Fournier
- */
-public class MetricsRulesTest extends SimpleAggregatorTst {
-
-
- private static final String RULESET = "apex-metrics";
-
-
- @Override
- protected Rule reinitializeRule(Rule rule) {
- ApexMetricsHook.reset();
- return super.reinitializeRule(rule);
- }
-
-
- @Override
- public void setUp() {
- addRule(RULESET, "CyclomaticComplexity");
- }
-}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/performance/AvoidDmlStatementsInLoopsTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/performance/AvoidDmlStatementsInLoopsTest.java
new file mode 100644
index 00000000000..e63930e585a
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/performance/AvoidDmlStatementsInLoopsTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.performance;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class AvoidDmlStatementsInLoopsTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/performance/AvoidSoqlInLoopsTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/performance/AvoidSoqlInLoopsTest.java
new file mode 100644
index 00000000000..cec9d93bf47
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/performance/AvoidSoqlInLoopsTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.performance;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class AvoidSoqlInLoopsTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/performance/AvoidSoslInLoopsTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/performance/AvoidSoslInLoopsTest.java
new file mode 100644
index 00000000000..ce3a33a7c89
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/performance/AvoidSoslInLoopsTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.performance;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class AvoidSoslInLoopsTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/performance/PerformanceRulesTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/performance/PerformanceRulesTest.java
deleted file mode 100644
index c89531d0916..00000000000
--- a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/performance/PerformanceRulesTest.java
+++ /dev/null
@@ -1,18 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.rule.performance;
-
-import net.sourceforge.pmd.testframework.SimpleAggregatorTst;
-
-public class PerformanceRulesTest extends SimpleAggregatorTst {
-
- private static final String RULESET = "apex-performance";
-
- @Override
- public void setUp() {
- addRule(RULESET, "AvoidSoqlInLoops");
- addRule(RULESET, "AvoidDmlStatementsInLoops");
- }
-}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexBadCryptoTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexBadCryptoTest.java
new file mode 100644
index 00000000000..05134ff78c5
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexBadCryptoTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.security;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class ApexBadCryptoTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexCRUDViolationTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexCRUDViolationTest.java
new file mode 100644
index 00000000000..f041ac9bb06
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexCRUDViolationTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.security;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class ApexCRUDViolationTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexCSRFTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexCSRFTest.java
new file mode 100644
index 00000000000..e81fb45180c
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexCSRFTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.security;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class ApexCSRFTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexDangerousMethodsTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexDangerousMethodsTest.java
new file mode 100644
index 00000000000..74fe589b3d7
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexDangerousMethodsTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.security;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class ApexDangerousMethodsTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexInsecureEndpointTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexInsecureEndpointTest.java
new file mode 100644
index 00000000000..c118cbb916e
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexInsecureEndpointTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.security;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class ApexInsecureEndpointTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexOpenRedirectTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexOpenRedirectTest.java
new file mode 100644
index 00000000000..5cf72744fa4
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexOpenRedirectTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.security;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class ApexOpenRedirectTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexSOQLInjectionTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexSOQLInjectionTest.java
new file mode 100644
index 00000000000..a9a619d3567
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexSOQLInjectionTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.security;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class ApexSOQLInjectionTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexSharingViolationsTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexSharingViolationsTest.java
new file mode 100644
index 00000000000..e083382550d
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexSharingViolationsTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.security;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class ApexSharingViolationsTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexSuggestUsingNamedCredTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexSuggestUsingNamedCredTest.java
new file mode 100644
index 00000000000..231f15313e3
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexSuggestUsingNamedCredTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.security;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class ApexSuggestUsingNamedCredTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexXSSFromEscapeFalseTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexXSSFromEscapeFalseTest.java
new file mode 100644
index 00000000000..9acbd35642f
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexXSSFromEscapeFalseTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.security;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class ApexXSSFromEscapeFalseTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexXSSFromURLParamTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexXSSFromURLParamTest.java
new file mode 100644
index 00000000000..a0f8bdc72d3
--- /dev/null
+++ b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/ApexXSSFromURLParamTest.java
@@ -0,0 +1,11 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.apex.rule.security;
+
+import net.sourceforge.pmd.testframework.PmdRuleTst;
+
+public class ApexXSSFromURLParamTest extends PmdRuleTst {
+ // no additional unit tests
+}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/SecurityRulesTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/SecurityRulesTest.java
deleted file mode 100644
index 703f112d862..00000000000
--- a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/security/SecurityRulesTest.java
+++ /dev/null
@@ -1,27 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.rule.security;
-
-import net.sourceforge.pmd.testframework.SimpleAggregatorTst;
-
-public class SecurityRulesTest extends SimpleAggregatorTst {
-
- private static final String RULESET = "apex-security";
-
- @Override
- public void setUp() {
- addRule(RULESET, "ApexBadCrypto");
- addRule(RULESET, "ApexXSSFromEscapeFalse");
- addRule(RULESET, "ApexXSSFromURLParam");
- addRule(RULESET, "ApexCSRF");
- addRule(RULESET, "ApexOpenRedirect");
- addRule(RULESET, "ApexSOQLInjection");
- addRule(RULESET, "ApexSharingViolations");
- addRule(RULESET, "ApexInsecureEndpoint");
- addRule(RULESET, "ApexCRUDViolation");
- addRule(RULESET, "ApexDangerousMethods");
- addRule(RULESET, "ApexSuggestUsingNamedCred");
- }
-}
diff --git a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/style/StyleRulesTest.java b/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/style/StyleRulesTest.java
deleted file mode 100644
index f16234d462a..00000000000
--- a/pmd-apex/src/test/java/net/sourceforge/pmd/lang/apex/rule/style/StyleRulesTest.java
+++ /dev/null
@@ -1,23 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.lang.apex.rule.style;
-
-import net.sourceforge.pmd.testframework.SimpleAggregatorTst;
-
-public class StyleRulesTest extends SimpleAggregatorTst {
-
- private static final String RULESET = "apex-style";
-
- @Override
- public void setUp() {
- addRule(RULESET, "AvoidGlobalModifier");
- addRule(RULESET, "AvoidLogicInTrigger");
- addRule(RULESET, "ClassNamingConventions");
- addRule(RULESET, "MethodNamingConventions");
- addRule(RULESET, "VariableNamingConventions");
- addRule(RULESET, "MethodWithSameNameAsEnclosingClass");
-
- }
-}
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/metrics/MetadataDeployController.cls b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/multifile/MetadataDeployController.cls
similarity index 100%
rename from pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/metrics/MetadataDeployController.cls
rename to pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/multifile/MetadataDeployController.cls
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/apexunit/xml/ApexUnitTestClassShouldHaveAsserts.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/bestpractices/xml/ApexUnitTestClassShouldHaveAsserts.xml
similarity index 100%
rename from pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/apexunit/xml/ApexUnitTestClassShouldHaveAsserts.xml
rename to pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/bestpractices/xml/ApexUnitTestClassShouldHaveAsserts.xml
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/apexunit/xml/ApexUnitTestShouldNotUseSeeAllDataTrue.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/bestpractices/xml/ApexUnitTestShouldNotUseSeeAllDataTrue.xml
similarity index 100%
rename from pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/apexunit/xml/ApexUnitTestShouldNotUseSeeAllDataTrue.xml
rename to pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/bestpractices/xml/ApexUnitTestShouldNotUseSeeAllDataTrue.xml
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/bestpractices/xml/AvoidGlobalModifier.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/bestpractices/xml/AvoidGlobalModifier.xml
new file mode 100644
index 00000000000..28f5acf78cc
--- /dev/null
+++ b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/bestpractices/xml/AvoidGlobalModifier.xml
@@ -0,0 +1,91 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<test-data
+ xmlns="http://pmd.sourceforge.net/rule-tests"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/rule-tests http://pmd.sourceforge.net/rule-tests_1_0_0.xsd">
+
+ <test-code>
+ <description>Global class</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+global class Foo {
+
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>Global interface</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+global interface Foo {
+
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>Global method</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+global class Foo {
+ global Integer bar() {
+
+ }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>Global inner interface</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+global class Foo {
+ global interface Bar { {
+
+ }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>#1348 [apex] AvoidGlobalModifierRule gives warning even when its a REST webservice - false positive</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+@RestResource(urlMapping = '/partners/submit/*')
+global class Generic_LoanCreation {
+ @HttpPost
+ global static void createLoanApplication() {
+ }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>#1348 [apex] AvoidGlobalModifierRule gives warning even when its a SOAP webservice - false positive</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+global class Generic_LoanCreation {
+ webservice static void createLoanApplication() {
+ }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>Simple public and non-global class</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+public class myOuterClass {
+ // Additional myOuterClass code here
+ class myInnerClass {
+ // myInnerClass code here
+ }
+
+ void myMethod() {
+ }
+}
+ ]]></code>
+ </test-code>
+</test-data>
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/style/xml/AvoidLogicInTrigger.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/bestpractices/xml/AvoidLogicInTrigger.xml
similarity index 100%
rename from pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/style/xml/AvoidLogicInTrigger.xml
rename to pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/bestpractices/xml/AvoidLogicInTrigger.xml
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/style/xml/ClassNamingConventions.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/codestyle/xml/ClassNamingConventions.xml
similarity index 100%
rename from pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/style/xml/ClassNamingConventions.xml
rename to pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/codestyle/xml/ClassNamingConventions.xml
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/braces/xml/ForLoopsMustUseBraces.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/codestyle/xml/ForLoopsMustUseBraces.xml
similarity index 100%
rename from pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/braces/xml/ForLoopsMustUseBraces.xml
rename to pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/codestyle/xml/ForLoopsMustUseBraces.xml
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/braces/xml/IfElseStmtsMustUseBraces.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/codestyle/xml/IfElseStmtsMustUseBraces.xml
similarity index 100%
rename from pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/braces/xml/IfElseStmtsMustUseBraces.xml
rename to pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/codestyle/xml/IfElseStmtsMustUseBraces.xml
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/braces/xml/IfStmtsMustUseBraces.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/codestyle/xml/IfStmtsMustUseBraces.xml
similarity index 100%
rename from pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/braces/xml/IfStmtsMustUseBraces.xml
rename to pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/codestyle/xml/IfStmtsMustUseBraces.xml
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/style/xml/MethodNamingConventions.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/codestyle/xml/MethodNamingConventions.xml
similarity index 100%
rename from pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/style/xml/MethodNamingConventions.xml
rename to pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/codestyle/xml/MethodNamingConventions.xml
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/codestyle/xml/OneDeclarationPerLine.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/codestyle/xml/OneDeclarationPerLine.xml
new file mode 100644
index 00000000000..7a1a36a987f
--- /dev/null
+++ b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/codestyle/xml/OneDeclarationPerLine.xml
@@ -0,0 +1,95 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<test-data
+ xmlns="http://pmd.sourceforge.net/rule-tests"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/rule-tests http://pmd.sourceforge.net/rule-tests_1_0_0.xsd">
+
+ <test-code>
+ <description>one field declaration per statement</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ Integer a, b;
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>one variable declaration per statement</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ void bar() {
+ Integer a, b;
+ }
+}
+ ]]></code>
+ </test-code>
+
+
+ <test-code>
+ <description>all is well</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ Integer a;
+ Integer b;
+ void bar() {
+ Integer c;
+ Integer d;
+ }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>one variable declaration per line, ok by default</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ void bar() {
+ Integer a,
+ b;
+ }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>one field declaration per line, ok by default</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ Integer a,
+ b;
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>one variable declaration per line, not ok when strictMode</description>
+ <rule-property name="strictMode">true</rule-property>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ void bar() {
+ Integer a,
+ b;
+ }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>one field declaration per line, not ok when strictMode</description>
+ <rule-property name="strictMode">true</rule-property>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ Integer a,
+ b;
+}
+ ]]></code>
+ </test-code>
+</test-data>
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/style/xml/VariableNamingConventions.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/codestyle/xml/VariableNamingConventions.xml
similarity index 100%
rename from pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/style/xml/VariableNamingConventions.xml
rename to pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/codestyle/xml/VariableNamingConventions.xml
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/braces/xml/WhileLoopsMustUseBraces.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/codestyle/xml/WhileLoopsMustUseBraces.xml
similarity index 100%
rename from pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/braces/xml/WhileLoopsMustUseBraces.xml
rename to pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/codestyle/xml/WhileLoopsMustUseBraces.xml
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/complexity/xml/ExcessiveClassLength.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/complexity/xml/ExcessiveClassLength.xml
deleted file mode 100644
index 1b4dd59884d..00000000000
--- a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/complexity/xml/ExcessiveClassLength.xml
+++ /dev/null
@@ -1,74 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<test-data
- xmlns="http://pmd.sourceforge.net/rule-tests"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://pmd.sourceforge.net/rule-tests http://pmd.sourceforge.net/rule-tests_1_0_0.xsd">
-
- <test-code>
- <description>short</description>
- <rule-property name="minimum">10</rule-property>
- <expected-problems>0</expected-problems>
- <code><![CDATA[
-public class Foo {
- public void foo() {
- Integer x;
- }
-}
- ]]></code>
- </test-code>
-
- <code-fragment id="long"><![CDATA[
-public class Foo {
- public void bar() {
- bar();
- bar();
- bar();
- bar();
- bar();
- bar();
- bar();
- bar();
- bar();
- bar();
- }
-}
- ]]></code-fragment>
-
- <test-code>
- <description>long</description>
- <rule-property name="minimum">10</rule-property>
- <expected-problems>1</expected-problems>
- <code-ref id="long"/>
- </test-code>
-
- <test-code>
- <description>long class - changed minimum</description>
- <rule-property name="minimum">2000</rule-property>
- <expected-problems>0</expected-problems>
- <code-ref id="long"/>
- </test-code>
-
- <test-code>
- <description>ignore test classes</description>
- <expected-problems>0</expected-problems>
- <code><![CDATA[
-@isTest
-public class Foo {
- public void bar() {
- bar();
- bar();
- bar();
- bar();
- bar();
- bar();
- bar();
- bar();
- bar();
- bar();
- }
-}
- ]]></code>
- </test-code>
-
-</test-data>
\ No newline at end of file
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/complexity/xml/ExcessiveParameterList.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/complexity/xml/ExcessiveParameterList.xml
deleted file mode 100644
index 7620be0f625..00000000000
--- a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/complexity/xml/ExcessiveParameterList.xml
+++ /dev/null
@@ -1,31 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<test-data
- xmlns="http://pmd.sourceforge.net/rule-tests"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://pmd.sourceforge.net/rule-tests http://pmd.sourceforge.net/rule-tests_1_0_0.xsd">
-
- <test-code>
- <description>short</description>
- <rule-property name="minimum">9</rule-property>
- <expected-problems>0</expected-problems>
- <code><![CDATA[
-public class Foo {
- public void foo() {}
-}
- ]]></code>
- </test-code>
-
- <test-code>
- <description>long</description>
- <rule-property name="minimum">9</rule-property>
- <expected-problems>1</expected-problems>
- <code><![CDATA[
-public class Foo {
- public void foo(Integer p01, Integer p02, Integer p03, Integer p04, Integer p05, Integer p06, Integer p07, Integer p08, Integer p09, Integer p10 ) { }
- public void bar(Integer p01, Integer p02, Integer p03, Integer p04, Integer p05 ) { }
-}
- ]]></code>
- </test-code>
-
-</test-data>
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/complexity/xml/AvoidDeeplyNestedIfStmts.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/AvoidDeeplyNestedIfStmts.xml
similarity index 100%
rename from pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/complexity/xml/AvoidDeeplyNestedIfStmts.xml
rename to pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/AvoidDeeplyNestedIfStmts.xml
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/CyclomaticComplexity.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/CyclomaticComplexity.xml
new file mode 100644
index 00000000000..c1c8ec239de
--- /dev/null
+++ b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/CyclomaticComplexity.xml
@@ -0,0 +1,302 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<test-data
+ xmlns="http://pmd.sourceforge.net/rule-tests"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/rule-tests http://pmd.sourceforge.net/rule-tests_1_0_0.xsd">
+
+ <code-fragment id="full-example">
+ <![CDATA[
+ public class Complicated {
+ public void example() {
+ int x = 0, y = 1, z = 2, t = 2;
+ boolean a = false, b = true, c = false, d = true;
+ if (a && b || b && d) {
+ if (y == z) {
+ x = 2;
+ } else if (y == t && !d) {
+ x = 2;
+ } else {
+ x = 2;
+ }
+ } else if (c && d) {
+ while (z < y) {
+ x = 2;
+ }
+ } else if (a && !b) {
+ for (int n = 0; n < t; n++) {
+ x = 2;
+ }
+ } else {
+ x = 2;
+ }
+ }
+ }
+ ]]>
+ </code-fragment>
+
+ <test-code>
+ <description>Simple method</description>
+ <rule-property name="classReportLevel">1</rule-property>
+ <rule-property name="methodReportLevel">1</rule-property>
+ <expected-problems>2</expected-problems>
+ <expected-messages>
+ <message>The class 'Foo' has a total cyclomatic complexity of 1 (highest 1).</message>
+ <message>The method 'foo()' has a cyclomatic complexity of 1.</message>
+ </expected-messages>
+ <code>
+ <![CDATA[
+ public class Foo {
+ public void foo() {}
+ }
+ ]]>
+ </code>
+ </test-code>
+
+ <test-code>
+ <description>testLessComplicatedThanReportLevel</description>
+ <expected-problems>0</expected-problems>
+ <code>
+ <![CDATA[
+ public class Foo {
+ public void foo() {}
+ }
+ ]]>
+ </code>
+ </test-code>
+
+ <test-code>
+ <description>Complicated method</description>
+ <expected-problems>1</expected-problems>
+ <expected-messages>
+ <message>The method 'example()' has a cyclomatic complexity of 14.</message>
+ </expected-messages>
+ <code-ref id="full-example"/>
+ </test-code>
+
+ <test-code>
+ <description>Constructor</description>
+ <rule-property name="methodReportLevel">1</rule-property>
+ <expected-problems>1</expected-problems>
+ <expected-messages>
+ <message>The constructor 'Foo()' has a cyclomatic complexity of 1.</message>
+ </expected-messages>
+ <code>
+ <![CDATA[
+ public class Foo {
+ public Foo() {}
+ }
+ ]]>
+ </code>
+ </test-code>
+
+ <test-code>
+ <description>Test class report level</description>
+ <rule-property name="classReportLevel">14</rule-property>
+ <rule-property name="methodReportLevel">999</rule-property>
+ <expected-problems>1</expected-problems>
+ <code-ref id="full-example"/>
+ </test-code>
+
+ <test-code>
+ <description>Test method report level</description>
+ <rule-property name="classReportLevel">999</rule-property>
+ <rule-property name="methodReportLevel">14</rule-property>
+ <expected-problems>1</expected-problems>
+ <code-ref id="full-example"/>
+ </test-code>
+
+ <code-fragment id="constructor-violation">
+ <![CDATA[
+ public class Test {
+ public Test() {
+ if (a == 1) {
+ if (b == 2) {
+ System.out.println("b");
+ } else if (b == 1) {
+ }
+ } else {
+ }
+ }
+ }
+ ]]>
+ </code-fragment>
+
+ <test-code>
+ <description>#984 Cyclomatic complexity should treat constructors like methods: 1 - reportMethods=true</description>
+ <rule-property name="methodReportLevel">1</rule-property>
+ <expected-problems>1</expected-problems>
+ <code-ref id="constructor-violation"/>
+ </test-code>
+
+ <test-code>
+ <description>#984 Cyclomatic complexity should treat constructors like methods: 2 -reportMethods=false</description>
+ <rule-property name="methodReportLevel">999</rule-property>
+ <expected-problems>0</expected-problems>
+ <code-ref id="constructor-violation"/>
+ </test-code>
+
+ <code-fragment id="manyBooleanOps">
+ <![CDATA[
+ class Foo {
+ void foo(){
+ int x=0, y=1;
+ boolean a, b;
+ if (x > 2 || y < 4) {
+ while (x++ < 10 && !(y-- < 0));
+ } else if (a && b || x < 4) {
+ return;
+ }
+ }
+ }
+ ]]>
+ </code-fragment>
+
+ <test-code>
+ <description>Standard Cyclo should count boolean paths</description>
+ <rule-property name="methodReportLevel">2</rule-property>
+ <expected-problems>1</expected-problems>
+ <expected-messages>
+ <message>The method 'foo()' has a cyclomatic complexity of 8.</message>
+ </expected-messages>
+ <code-ref id="manyBooleanOps"/>
+ </test-code>
+
+ <code-fragment id="many-small-methods">
+ <![CDATA[
+ public class Complicated {
+ int x = 0, y = 1, z = 2, t = 2;
+ boolean a = false, b = true, c = false, d = true;
+ public void example1() {
+ if (a && b || b && d) {
+ if (y == z) {
+ x = 2;
+ } else if (y == t && !d) {
+ x = 2;
+ } else {
+ x = 2;
+ }
+ }
+ }
+ public void example2() {
+ if (c && d) {
+ while (z < y) {
+ x = 2;
+ }
+ }
+ }
+ public void example12() {
+ if (a && b || b && d) {
+ if (y == z) {
+ x = 2;
+ } else if (y == t && !d) {
+ x = 2;
+ } else {
+ x = 2;
+ }
+ }
+ }
+ public void example22() {
+ if (c && d) {
+ while (z < y) {
+ x = 2;
+ }
+ }
+ }
+ public void example3() {
+ if (a && !b) {
+ for (int n = 0; n < t; n++) {
+ x = 2;
+ }
+ }
+ }
+ public void example32() {
+ if (a && !b) {
+ for (int n = 0; n < t; n++) {
+ x = 2;
+ }
+ }
+ }
+ public void exception() {
+ try {
+ int k = 0;
+ k++;
+ } catch (IOException ioe) {
+ ioe.printStackTrace();
+ throw new Exception("surprise", ioe);
+ } catch (Exception e) {
+ // do nothing
+ }
+ }
+ public void exception2() {
+ try {
+ int k = 0;
+ k++;
+ } catch (IOException ioe) {
+ ioe.printStackTrace();
+ throw new Exception("surprise", ioe);
+ } catch (Exception e) {
+ // do nothing
+ }
+ }
+ }
+ ]]>
+ </code-fragment>
+
+ <test-code>
+ <!-- The class should get reported even though none of its methods get reported. -->
+ <description>Test many unreported methods</description>
+ <expected-problems>1</expected-problems>
+ <expected-messages>
+ <message>The class 'Complicated' has a total cyclomatic complexity of 40 (highest 8).</message>
+ </expected-messages>
+ <code-ref id="many-small-methods"/>
+ </test-code>
+
+
+ <code-fragment id="trigger">
+ <![CDATA[
+ trigger CaseAssignLevel on CaseAssignLevel__c (after delete, after insert, after undelete, after update, before delete, before insert, before update) {
+
+ if(Trigger.isBefore) {
+ if(Trigger.isInsert || Trigger.isUpdate) {
+ CaseAssignLevel_tr.doIsNotTrigger(Trigger.new);
+ }
+ }
+
+
+
+ if(Trigger.isBefore && !CaseAssignLevel_tr.isNotTrigger) {
+ if(Trigger.isInsert || Trigger.isUpdate) {
+ CaseAssignLevel_tr.doCreateKeyValue(Trigger.new, Trigger.oldMap);
+ }
+ }
+
+
+ else if(Trigger.isAfter && !CaseAssignLevel_tr.isNotTrigger) {
+ if(Trigger.isInsert || Trigger.isUpdate) {
+
+ }
+ }
+
+ }
+ ]]>
+ </code-fragment>
+
+ <test-code>
+ <description>#768 NPE caused by exception in ApexQualifiedName.ofMethod because of trigger</description>
+ <expected-problems>1</expected-problems>
+ <expected-messages>
+ <message>The trigger 'CaseAssignLevel' has a cyclomatic complexity of 12.</message>
+ </expected-messages>
+ <code-ref id="trigger"/>
+ </test-code>
+
+ <test-code>
+ <description>#768 NPE caused by exception in ApexQualifiedName.ofMethod because of trigger</description>
+ <rule-property name="methodReportLevel">13</rule-property>
+ <expected-problems>0</expected-problems>
+ <code-ref id="trigger"/>
+ </test-code>
+
+
+</test-data>
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/ExcessiveClassLength.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/ExcessiveClassLength.xml
new file mode 100644
index 00000000000..ffb61e51f54
--- /dev/null
+++ b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/ExcessiveClassLength.xml
@@ -0,0 +1,95 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<test-data
+ xmlns="http://pmd.sourceforge.net/rule-tests"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/rule-tests http://pmd.sourceforge.net/rule-tests_1_0_0.xsd">
+
+ <test-code>
+ <description>short</description>
+ <rule-property name="minimum">10</rule-property>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ public void foo() {
+ Integer x;
+ }
+}
+ ]]></code>
+ </test-code>
+
+ <code-fragment id="long"><![CDATA[
+public class Foo {
+ public void bar() {
+ bar();
+ bar();
+ bar();
+ bar();
+ bar();
+ bar();
+ bar();
+ bar();
+ bar();
+ bar();
+ }
+}
+ ]]></code-fragment>
+
+ <test-code>
+ <description>long</description>
+ <rule-property name="minimum">10</rule-property>
+ <expected-problems>1</expected-problems>
+ <code-ref id="long"/>
+ </test-code>
+
+ <test-code>
+ <description>long class - changed minimum</description>
+ <rule-property name="minimum">2000</rule-property>
+ <expected-problems>0</expected-problems>
+ <code-ref id="long"/>
+ </test-code>
+
+ <test-code>
+ <description>ignore test classes</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+@isTest
+public class Foo {
+ public void bar() {
+ bar();
+ bar();
+ bar();
+ bar();
+ bar();
+ bar();
+ bar();
+ bar();
+ bar();
+ bar();
+ }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>#1396 Public method with javadoc</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+/**
+ * Class comment
+ */
+public class SomeClass {
+
+ /**
+ * Comment
+ */
+ public void doSomething() {
+ System.debug("hello world");
+ }
+
+ /** Field comment */
+ private String field;
+}
+ ]]></code>
+ </test-code>
+</test-data>
\ No newline at end of file
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/ExcessiveParameterList.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/ExcessiveParameterList.xml
new file mode 100644
index 00000000000..7b3b14d2528
--- /dev/null
+++ b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/ExcessiveParameterList.xml
@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<test-data
+ xmlns="http://pmd.sourceforge.net/rule-tests"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/rule-tests http://pmd.sourceforge.net/rule-tests_1_0_0.xsd">
+
+ <test-code>
+ <description>short</description>
+ <rule-property name="minimum">9</rule-property>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ public void foo() {}
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>long</description>
+ <rule-property name="minimum">9</rule-property>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ public void foo(Integer p01, Integer p02, Integer p03, Integer p04, Integer p05, Integer p06, Integer p07, Integer p08, Integer p09, Integer p10 ) { }
+ public void bar(Integer p01, Integer p02, Integer p03, Integer p04, Integer p05 ) { }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>#1396 Public method with javadoc</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+/**
+ * Class comment
+ */
+public class SomeClass {
+
+ /**
+ * Comment
+ */
+ public void doSomething() {
+ System.debug("hello world");
+ }
+
+ /** Field comment */
+ private String field;
+}
+ ]]></code>
+ </test-code>
+
+</test-data>
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/complexity/xml/ExcessivePublicCount.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/ExcessivePublicCount.xml
similarity index 86%
rename from pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/complexity/xml/ExcessivePublicCount.xml
rename to pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/ExcessivePublicCount.xml
index 7df32abc0d8..91c1856bcac 100644
--- a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/complexity/xml/ExcessivePublicCount.xml
+++ b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/ExcessivePublicCount.xml
@@ -92,5 +92,26 @@ public class Foo {
}
]]></code>
</test-code>
-
+
+ <test-code>
+ <description>#1396 Class with javadoc</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+/**
+ * Class comment
+ */
+public class SomeClass {
+
+ /**
+ * Comment
+ */
+ public void doSomething() {
+ System.debug("hello world");
+ }
+
+ /** Field comment */
+ private String field;
+}
+ ]]></code>
+ </test-code>
</test-data>
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/complexity/xml/NcssConstructorCount.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/NcssConstructorCount.xml
similarity index 84%
rename from pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/complexity/xml/NcssConstructorCount.xml
rename to pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/NcssConstructorCount.xml
index 200bc11340b..e0a43206477 100644
--- a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/complexity/xml/NcssConstructorCount.xml
+++ b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/NcssConstructorCount.xml
@@ -109,5 +109,32 @@ public class Foo {
}
]]></code>
</test-code>
-
+
+ <test-code>
+ <description>#1396 Constructor with comment</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+/**
+ * Class comment
+ */
+public class SomeClass {
+
+ /**
+ * Constructor comment
+ */
+ public SomeClass() {
+ }
+
+ /**
+ * Comment
+ */
+ public void doSomething() {
+ System.debug("hello world");
+ }
+
+ /** Field comment */
+ private String field;
+}
+ ]]></code>
+ </test-code>
</test-data>
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/complexity/xml/NcssMethodCount.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/NcssMethodCount.xml
similarity index 89%
rename from pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/complexity/xml/NcssMethodCount.xml
rename to pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/NcssMethodCount.xml
index 6b92b0f3e57..58e523add47 100644
--- a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/complexity/xml/NcssMethodCount.xml
+++ b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/NcssMethodCount.xml
@@ -130,4 +130,25 @@ private class AcceptanceTests_Test {
}
</code>
</test-code>
+
+ <test-code>
+ <description>#1396 Method with comment</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+/**
+ * Class comment
+ */
+public class SomeClass {
+ /**
+ * Comment
+ */
+ public void doSomething() {
+ System.debug("hello world");
+ }
+
+ /** Field comment */
+ private String field;
+}
+ ]]></code>
+ </test-code>
</test-data>
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/complexity/xml/NcssTypeCount.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/NcssTypeCount.xml
similarity index 87%
rename from pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/complexity/xml/NcssTypeCount.xml
rename to pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/NcssTypeCount.xml
index 347644b2336..55692690aaa 100644
--- a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/complexity/xml/NcssTypeCount.xml
+++ b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/NcssTypeCount.xml
@@ -105,5 +105,26 @@ private class AcceptanceTests_Test {
}
}
]]></code>
- </test-code>
+ </test-code>
+
+ <test-code>
+ <description>#1396 Method with comment</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+/**
+ * Class comment
+ */
+public class SomeClass {
+ /**
+ * Comment
+ */
+ public void doSomething() {
+ System.debug("hello world");
+ }
+
+ /** Field comment */
+ private String field;
+}
+ ]]></code>
+ </test-code>
</test-data>
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/complexity/xml/StdCyclomaticComplexity.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/StdCyclomaticComplexity.xml
similarity index 100%
rename from pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/complexity/xml/StdCyclomaticComplexity.xml
rename to pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/StdCyclomaticComplexity.xml
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/complexity/xml/TooManyFields.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/TooManyFields.xml
similarity index 100%
rename from pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/complexity/xml/TooManyFields.xml
rename to pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/design/xml/TooManyFields.xml
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/documentation/xml/ApexDoc.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/documentation/xml/ApexDoc.xml
new file mode 100644
index 00000000000..0e890cd2741
--- /dev/null
+++ b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/documentation/xml/ApexDoc.xml
@@ -0,0 +1,401 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<test-data
+ xmlns="http://pmd.sourceforge.net/rule-tests"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/rule-tests http://pmd.sourceforge.net/rule-tests_1_0_0.xsd">
+
+ <test-code>
+ <description>comment should start with two asterisks</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+/*
+ * @description Foo
+ */
+public class Foo { }
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>public test class does not need comment</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+@isTest
+public class Foo { }
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>public class should have comment</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+public class Foo { }
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>global class should have comment</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+global class Foo { }
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>private class does not need comment</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+private class Foo { }
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>class comment should have description</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+/**
+ */
+public class Foo { }
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>correct class comment</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+/**
+ * @description Foo
+ */
+public class Foo { }
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>correct class comment with annotation</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+/**
+ * @description Foo
+ */
+@Deprecated
+public class Foo { }
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>public interface should have comment</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+public interface Foo { }
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>global interface should have comment</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+global interface Foo { }
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>private interface does not need comment</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+private interface Foo { }
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>interface comment should have description</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+/**
+ */
+public interface Foo { }
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>correct interface comment</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+/**
+ * @description Foo
+ */
+public interface Foo { }
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>correct interface comment with annotation</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+/**
+ * @description Foo
+ */
+@Deprecated
+public interface Foo { }
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>public method should have comment</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+/**
+ * @description Foo
+ */
+public class Foo {
+ public void bar() { }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>global method should have comment</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+/**
+ * @description Foo
+ */
+public class Foo {
+ global void bar() { }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>public override method does not need comment</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+/**
+ * @description Foo
+ */
+public class Foo {
+ public override void bar() { }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>method comment should have description</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+/**
+ * @description Foo
+ */
+public class Foo {
+ /**
+ */
+ public void bar() { }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>non-void method comment should have return</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+/**
+ * @description Foo
+ */
+public class Foo {
+ /**
+ * @description Bar
+ */
+ public Object bar() { return null; }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>constructor comment does not need return</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+/**
+ * @description Foo
+ */
+public class Foo {
+ /**
+ * @description Foo
+ */
+ public Foo() { }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>method with param comment should have param</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+/**
+ * @description Foo
+ */
+public class Foo {
+ /**
+ * @description Bar
+ */
+ public void bar(String foo) { }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>params should match method</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+/**
+ * @description Foo
+ */
+public class Foo {
+ /**
+ * @description Bar
+ * @param foo1 Foo
+ */
+ public void bar(String foo) { }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>correct void method comment</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+/**
+ * @description Foo
+ */
+public class Foo {
+ /**
+ * @description Bar
+ */
+ public void bar() { }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>correct non-void method comment</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+/**
+ * @description Foo
+ */
+public class Foo {
+ /**
+ * @description Bar
+ * @return Bar
+ */
+ public Object bar() { return null; }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>correct method with params comment</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+/**
+ * @description Foo
+ */
+public class Foo {
+ /**
+ * @description Bar
+ * @param foo1 Foo1
+ * @param foo2 Foo2
+ */
+ public void bar(String foo1, String foo2) { return null; }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>correct method comment with annotation</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+/**
+ * @description Foo
+ */
+public class Foo {
+ /**
+ * @description Bar
+ */
+ @Deprecated
+ public void bar() { }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>public property should have comment</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+/**
+ * @description Foo
+ */
+public class Foo {
+ public Object Bar { get; set; }
+}
+ ]]></code>
+</test-code>
+
+ <test-code>
+ <description>global property should have comment</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+/**
+ * @description Foo
+ */
+public class Foo {
+ global Object Bar { get; set; }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>property comment should have description</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+/**
+ * @description Foo
+ */
+public class Foo {
+ public Object Bar { get; set; }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>correct property comment</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+/**
+ * @description Foo
+ */
+public class Foo {
+ /**
+ * @description Bar
+ */
+ public Object Bar { get; set; }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>correct property comment with annotation</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+/**
+ * @description Foo
+ */
+public class Foo {
+ /**
+ * @description Bar
+ */
+ @Deprecated
+ public Object Bar { get; set; }
+}
+ ]]></code>
+ </test-code>
+
+</test-data>
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/AvoidDirectAccessTriggerMap.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/AvoidDirectAccessTriggerMap.xml
new file mode 100644
index 00000000000..49d7898859a
--- /dev/null
+++ b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/AvoidDirectAccessTriggerMap.xml
@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<test-data
+ xmlns="http://pmd.sourceforge.net/rule-tests"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/rule-tests http://pmd.sourceforge.net/rule-tests_1_0_0.xsd">
+
+ <test-code>
+ <description>Directly accessing the Trigger.old map.</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+trigger AccountTrigger on Account (before insert, before update) {
+ Account a = Trigger.new[0]; //Bad: Accessing the trigger array directly is not recommended.
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>Looping through map, best practice</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+trigger AccountTrigger on Account (before insert, before update) {
+ foreach ( Account a : Trigger.new ){
+ //Good: Iterate through the trigger.new array instead.
+ system.debug(a);
+ }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>Regression issue #792</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+class NotATrigger {
+ void foo(){
+ Account[] accounts = opportunity.Accounts[0];
+ }
+}
+
+ ]]></code>
+ </test-code>
+
+</test-data>
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/AvoidHardcodingId.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/AvoidHardcodingId.xml
new file mode 100644
index 00000000000..d69a71476f5
--- /dev/null
+++ b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/AvoidHardcodingId.xml
@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<test-data
+ xmlns="http://pmd.sourceforge.net/rule-tests"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/rule-tests http://pmd.sourceforge.net/rule-tests_1_0_0.xsd">
+
+ <test-code>
+ <description>Non compliant scenario: Hardcoded Id</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ public void method (ID newRecordID) {
+ for (Account current : listOfcounts){
+ if (current.getId == 'a002400000RG1nyAAD') {
+ }
+ }
+ method('3266sd35435sd6a');
+ }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>Compliant scenario, getting ID dynamically</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ public void method (ID newRecordID) {
+ for (Account current : listOfcounts){
+ if (current.getId == newRecordID) {
+
+ }
+ }
+
+ otherMethod(newRecordID);
+ }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>Test for random string combinations</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ void foo() {
+ return 'jatuatzbtazi124';
+ }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>Test for random string combinations - more than 15, less than 18 digits</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ void foo() {
+ return 'jatua0tzbtazi1243';
+ }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>Test for random string combinations - checksum doesn't match</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ void foo() {
+ return '001A0000006Vm9uIAE';
+ }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>[apex] AvoidHardcodingId false positives #776</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ void foo() {
+ // this is a false positive, we can't say, whether it's a salesforce id or not
+ @SuppressWarnings('PMD.AvoidHardcodingId')
+ String IMEI__c = '359040082913024';
+
+ // now the 6th character is non-0, definitive not a salesforce id
+ String IMEI2__c = '359041082913024';
+ }
+}
+ ]]></code>
+ </test-code>
+</test-data>
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/AvoidNonExistentAnnotations.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/AvoidNonExistentAnnotations.xml
new file mode 100644
index 00000000000..b07f4e9a581
--- /dev/null
+++ b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/AvoidNonExistentAnnotations.xml
@@ -0,0 +1,72 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<test-data
+ xmlns="http://pmd.sourceforge.net/rule-tests"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/rule-tests http://pmd.sourceforge.net/rule-tests_1_0_0.xsd">
+
+ <test-code>
+ <description>Class with nonexistent annotation</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+@NonExistentStupidity public class Foo {
+
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>Interface with nonexistent annotation</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+@NonExistentStupidity public interface Foo {
+
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>Method with non existent annotation</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ @NonExistentStupidity public Integer bar() {
+ }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>Property with non existent annotation</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ @NonExistentStupidity public Integer myProp {get; set;}
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>Field with non existent annotation</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ @NonExistentStupidity public Integer myField;
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>Valid annotations are not flagged</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+@IsTest
+public class Foo {
+ @Future
+ @Deprecated
+ public Integer bar() {
+ }
+}
+ ]]></code>
+ </test-code>
+</test-data>
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/EmptyCatchBlock.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/EmptyCatchBlock.xml
new file mode 100644
index 00000000000..2a827911476
--- /dev/null
+++ b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/EmptyCatchBlock.xml
@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<test-data
+ xmlns="http://pmd.sourceforge.net/rule-tests"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/rule-tests http://pmd.sourceforge.net/rule-tests_1_0_0.xsd">
+ <test-code>
+ <description><![CDATA[
+Failure case: Empty Catch Block
+ ]]></description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ public void bar() {
+ try {
+ system.debug(1);
+ }
+ catch(Exception e) {
+ }
+ }
+}
+ ]]></code>
+ </test-code>
+ <test-code>
+ <description><![CDATA[
+Success case: Empty Catch Block
+ ]]></description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ public void foo() {
+ try {
+ system.debug(1);
+ } catch(Exception e) {
+ system.debug(e);
+ }
+ }
+}
+ ]]></code>
+ </test-code>
+</test-data>
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/EmptyIfStmt.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/EmptyIfStmt.xml
new file mode 100644
index 00000000000..00b5ba05600
--- /dev/null
+++ b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/EmptyIfStmt.xml
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<test-data
+ xmlns="http://pmd.sourceforge.net/rule-tests"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/rule-tests http://pmd.sourceforge.net/rule-tests_1_0_0.xsd">
+ <test-code>
+ <description><![CDATA[
+Failure Case: Empty If Statement
+ ]]></description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ public void foo() {
+ if(true) {
+ }
+ }
+}
+ ]]></code>
+ </test-code>
+ <test-code>
+ <description><![CDATA[
+Success Case: Empty If statement
+ ]]></description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ public void foo() {
+ if(true) {
+ system.debug(true);
+ }
+ }
+}
+ ]]></code>
+ </test-code>
+</test-data>
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/EmptyStatementBlock.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/EmptyStatementBlock.xml
new file mode 100644
index 00000000000..c80d2bf9cc4
--- /dev/null
+++ b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/EmptyStatementBlock.xml
@@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<test-data
+ xmlns="http://pmd.sourceforge.net/rule-tests"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/rule-tests http://pmd.sourceforge.net/rule-tests_1_0_0.xsd">
+ <test-code>
+ <description><![CDATA[
+Failure case: Empty Statement Block
+ ]]></description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ public void foo() {
+ }
+
+ public abstract void bar() {}
+}
+ ]]></code>
+ </test-code>
+ <test-code>
+ <description><![CDATA[
+Success case: Empty Statement Block
+ ]]></description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ public void foo() {
+ system.debug(1);
+ }
+ public abstract void bar() {}
+}
+ ]]></code>
+ </test-code>
+ <test-code>
+ <description><![CDATA[
+#760 - false positive on non existing else block
+ ]]></description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ public void foo() {
+ if (something) {
+ system.debug(1);
+ }
+ }
+}
+ ]]></code>
+ </test-code>
+ <test-code>
+ <description><![CDATA[
+#760 - is reported on existing else block
+ ]]></description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ public void foo() {
+ if (something) {
+ system.debug(1);
+ } else {
+ }
+ }
+}
+ ]]></code>
+ </test-code>
+</test-data>
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/EmptyTryOrFinallyBlock.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/EmptyTryOrFinallyBlock.xml
new file mode 100644
index 00000000000..74700f4dd10
--- /dev/null
+++ b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/EmptyTryOrFinallyBlock.xml
@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<test-data
+ xmlns="http://pmd.sourceforge.net/rule-tests"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/rule-tests http://pmd.sourceforge.net/rule-tests_1_0_0.xsd">
+ <test-code>
+ <description><![CDATA[
+Failure Case: Empty Try Block
+ ]]></description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ void foo() {
+ try {
+ }
+ catch(Exception e) {
+ system.debug(e);
+ }
+ }
+}
+ ]]></code>
+ </test-code>
+ <test-code>
+ <description><![CDATA[
+Success Case: Empty Try Block
+ ]]></description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ void foo() {
+ try {
+ insert account;
+ } catch(Exception e) {
+ system.debug(e);
+ }
+ }
+}
+ ]]></code>
+ </test-code>
+ <test-code>
+ <description><![CDATA[
+Failure Case: Empty Finally Block
+ ]]></description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ void foo() {
+ try {
+ insert account;
+ } catch(Exception e) {
+ // Generic exception handling code
+ system.debug(e);
+ } finally {
+ }
+ }
+}
+ ]]></code>
+ </test-code>
+ <test-code>
+ <description><![CDATA[
+Success Case: Empty Finally Block
+ ]]></description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ void foo() {
+ try {
+ insert account;
+ } catch(Exception e) {
+ system.debug(e);
+ } finally {
+ someAction();
+ }
+ }
+}
+ ]]></code>
+ </test-code>
+</test-data>
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/EmptyWhileStmt.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/EmptyWhileStmt.xml
new file mode 100644
index 00000000000..85c98fee7bc
--- /dev/null
+++ b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/EmptyWhileStmt.xml
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<test-data
+ xmlns="http://pmd.sourceforge.net/rule-tests"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/rule-tests http://pmd.sourceforge.net/rule-tests_1_0_0.xsd">
+ <test-code>
+ <description><![CDATA[
+Failure Case: Empty While Statement
+ ]]></description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ void foo() {
+ Integer count = 1;
+ while (count < 11) {
+ }
+ }
+}
+ ]]></code>
+ </test-code>
+ <test-code>
+ <description><![CDATA[
+Success Case: Empty While Statement
+ ]]></description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ void foo() {
+ Integer count = 1;
+
+ while (count < 11) {
+ System.debug(count);
+ count++;
+ }
+ }
+}
+ ]]></code>
+ </test-code>
+</test-data>
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/style/xml/MethodWithSameNameAsEnclosingClass.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/MethodWithSameNameAsEnclosingClass.xml
similarity index 100%
rename from pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/style/xml/MethodWithSameNameAsEnclosingClass.xml
rename to pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/errorprone/xml/MethodWithSameNameAsEnclosingClass.xml
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/metrics/xml/CyclomaticComplexity.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/metrics/xml/CyclomaticComplexity.xml
deleted file mode 100644
index 8fa77671376..00000000000
--- a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/metrics/xml/CyclomaticComplexity.xml
+++ /dev/null
@@ -1,255 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<test-data
- xmlns="http://pmd.sourceforge.net/rule-tests"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://pmd.sourceforge.net/rule-tests http://pmd.sourceforge.net/rule-tests_1_0_0.xsd">
-
- <code-fragment id="full-example">
- <![CDATA[
- public class Complicated {
- public void example() {
- int x = 0, y = 1, z = 2, t = 2;
- boolean a = false, b = true, c = false, d = true;
- if (a && b || b && d) {
- if (y == z) {
- x = 2;
- } else if (y == t && !d) {
- x = 2;
- } else {
- x = 2;
- }
- } else if (c && d) {
- while (z < y) {
- x = 2;
- }
- } else if (a && !b) {
- for (int n = 0; n < t; n++) {
- x = 2;
- }
- } else {
- x = 2;
- }
- }
- }
- ]]>
- </code-fragment>
-
- <test-code>
- <description>Simple method</description>
- <rule-property name="classReportLevel">1</rule-property>
- <rule-property name="methodReportLevel">1</rule-property>
- <expected-problems>2</expected-problems>
- <expected-messages>
- <message>The class 'Foo' has a total cyclomatic complexity of 1 (highest 1).</message>
- <message>The method 'foo()' has a cyclomatic complexity of 1.</message>
- </expected-messages>
- <code>
- <![CDATA[
- public class Foo {
- public void foo() {}
- }
- ]]>
- </code>
- </test-code>
-
- <test-code>
- <description>testLessComplicatedThanReportLevel</description>
- <expected-problems>0</expected-problems>
- <code>
- <![CDATA[
- public class Foo {
- public void foo() {}
- }
- ]]>
- </code>
- </test-code>
-
- <test-code>
- <description>Complicated method</description>
- <expected-problems>1</expected-problems>
- <expected-messages>
- <message>The method 'example()' has a cyclomatic complexity of 14.</message>
- </expected-messages>
- <code-ref id="full-example"/>
- </test-code>
-
- <test-code>
- <description>Constructor</description>
- <rule-property name="methodReportLevel">1</rule-property>
- <expected-problems>1</expected-problems>
- <expected-messages>
- <message>The constructor 'Foo()' has a cyclomatic complexity of 1.</message>
- </expected-messages>
- <code>
- <![CDATA[
- public class Foo {
- public Foo() {}
- }
- ]]>
- </code>
- </test-code>
-
- <test-code>
- <description>Test class report level</description>
- <rule-property name="classReportLevel">14</rule-property>
- <rule-property name="methodReportLevel">999</rule-property>
- <expected-problems>1</expected-problems>
- <code-ref id="full-example"/>
- </test-code>
-
- <test-code>
- <description>Test method report level</description>
- <rule-property name="classReportLevel">999</rule-property>
- <rule-property name="methodReportLevel">14</rule-property>
- <expected-problems>1</expected-problems>
- <code-ref id="full-example"/>
- </test-code>
-
- <code-fragment id="constructor-violation">
- <![CDATA[
- public class Test {
- public Test() {
- if (a == 1) {
- if (b == 2) {
- System.out.println("b");
- } else if (b == 1) {
- }
- } else {
- }
- }
- }
- ]]>
- </code-fragment>
-
- <test-code>
- <description>#984 Cyclomatic complexity should treat constructors like methods: 1 - reportMethods=true</description>
- <rule-property name="methodReportLevel">1</rule-property>
- <expected-problems>1</expected-problems>
- <code-ref id="constructor-violation"/>
- </test-code>
-
- <test-code>
- <description>#984 Cyclomatic complexity should treat constructors like methods: 2 -reportMethods=false</description>
- <rule-property name="methodReportLevel">999</rule-property>
- <expected-problems>0</expected-problems>
- <code-ref id="constructor-violation"/>
- </test-code>
-
- <code-fragment id="manyBooleanOps">
- <![CDATA[
- class Foo {
- void foo(){
- int x=0, y=1;
- boolean a, b;
- if (x > 2 || y < 4) {
- while (x++ < 10 && !(y-- < 0));
- } else if (a && b || x < 4) {
- return;
- }
- }
- }
- ]]>
- </code-fragment>
-
- <test-code>
- <description>Standard Cyclo should count boolean paths</description>
- <rule-property name="methodReportLevel">2</rule-property>
- <expected-problems>1</expected-problems>
- <expected-messages>
- <message>The method 'foo()' has a cyclomatic complexity of 8.</message>
- </expected-messages>
- <code-ref id="manyBooleanOps"/>
- </test-code>
-
- <code-fragment id="many-small-methods">
- <![CDATA[
- public class Complicated {
- int x = 0, y = 1, z = 2, t = 2;
- boolean a = false, b = true, c = false, d = true;
- public void example1() {
- if (a && b || b && d) {
- if (y == z) {
- x = 2;
- } else if (y == t && !d) {
- x = 2;
- } else {
- x = 2;
- }
- }
- }
- public void example2() {
- if (c && d) {
- while (z < y) {
- x = 2;
- }
- }
- }
- public void example12() {
- if (a && b || b && d) {
- if (y == z) {
- x = 2;
- } else if (y == t && !d) {
- x = 2;
- } else {
- x = 2;
- }
- }
- }
- public void example22() {
- if (c && d) {
- while (z < y) {
- x = 2;
- }
- }
- }
- public void example3() {
- if (a && !b) {
- for (int n = 0; n < t; n++) {
- x = 2;
- }
- }
- }
- public void example32() {
- if (a && !b) {
- for (int n = 0; n < t; n++) {
- x = 2;
- }
- }
- }
- public void exception() {
- try {
- int k = 0;
- k++;
- } catch (IOException ioe) {
- ioe.printStackTrace();
- throw new Exception("surprise", ioe);
- } catch (Exception e) {
- // do nothing
- }
- }
- public void exception2() {
- try {
- int k = 0;
- k++;
- } catch (IOException ioe) {
- ioe.printStackTrace();
- throw new Exception("surprise", ioe);
- } catch (Exception e) {
- // do nothing
- }
- }
- }
- ]]>
- </code-fragment>
-
- <test-code>
- <!-- The class should get reported even though none of its methods get reported. -->
- <description>Test many unreported methods</description>
- <expected-problems>1</expected-problems>
- <expected-messages>
- <message>The class 'Complicated' has a total cyclomatic complexity of 40 (highest 8).</message>
- </expected-messages>
- <code-ref id="many-small-methods"/>
- </test-code>
-
-</test-data>
\ No newline at end of file
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/performance/xml/AvoidSoslInLoops.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/performance/xml/AvoidSoslInLoops.xml
new file mode 100644
index 00000000000..19aa716baa9
--- /dev/null
+++ b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/performance/xml/AvoidSoslInLoops.xml
@@ -0,0 +1,107 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<test-data
+ xmlns="http://pmd.sourceforge.net/rule-tests"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://pmd.sourceforge.net/rule-tests http://pmd.sourceforge.net/rule-tests_1_0_0.xsd">
+
+ <test-code>
+ <description>Problematic Sosl in for each</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ public void test1() {
+ for(Integer i : new List<Integer>{1,2}) {
+ List<List<SObject>> searchList = [FIND 'map*' IN ALL FIELDS RETURNING Account (Id, Name), Contact, Opportunity, Lead];
+ }
+ }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>Problematic Sosl in for loop</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ public void test1() {
+ for(;;) {
+ List<List<SObject>> searchList = [FIND 'map*' IN ALL FIELDS RETURNING Account (Id, Name), Contact, Opportunity, Lead];
+ }
+ }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>Problematic Sosl in While loop</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ public void test1() {
+ while(true) {
+ List<List<SObject>> searchList = [FIND 'map*' IN ALL FIELDS RETURNING Account (Id, Name), Contact, Opportunity, Lead];
+ }
+ }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>Problematic Sosl in do loop</description>
+ <expected-problems>1</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ public void test1() {
+ do{
+ List<List<SObject>> searchList = [FIND 'map*' IN ALL FIELDS RETURNING Account (Id, Name), Contact, Opportunity, Lead];
+ }while(true) ;
+ }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>Multiple problematic Sosl expressions</description>
+ <expected-problems>2</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ public void test1() {
+ do{
+ List<List<SObject>> searchList = [FIND 'map*' IN ALL FIELDS RETURNING Account (Id, Name), Contact, Opportunity, Lead];
+ List<List<SObject>> searchList = [FIND 'map*' IN ALL FIELDS RETURNING Account (Id, Name)];
+ }while(true) ;
+ }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>Return Sosl is even ok in loop</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ public List<Account> test1() {
+ for(;;) {
+ return [FIND 'map*' IN ALL FIELDS RETURNING Account (Id, Name), Contact, Opportunity, Lead];
+ }
+ }
+}
+ ]]></code>
+ </test-code>
+
+ <test-code>
+ <description>#29 SOSL For Loops should not throw an Avoid Sosl queries inside loops issue</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ public void test1() {
+ for(List<sObject> a : [FIND 'map*' IN ALL FIELDS RETURNING Account (Id, Name), Contact, Opportunity]) {
+
+ }
+ }
+}
+ ]]></code>
+ </test-code>
+
+</test-data>
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/security/xml/ApexCRUDViolation.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/security/xml/ApexCRUDViolation.xml
index ce3933613c7..2c7a4768b6a 100644
--- a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/security/xml/ApexCRUDViolation.xml
+++ b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/security/xml/ApexCRUDViolation.xml
@@ -812,6 +812,18 @@ public class Foo {
public list<A.B[]> bar;
public map<Id,A.B[]> baz;
}
+]]></code>
+ </test-code>
+
+ <test-code>
+ <description>Regression issue #799 detection</description>
+ <expected-problems>0</expected-problems>
+ <code><![CDATA[
+public class Foo {
+ void chainedMethods() {
+ firstMethod().lastMethod();
+ }
+}
]]></code>
</test-code>
</test-data>
diff --git a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/style/xml/AvoidGlobalModifier.xml b/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/style/xml/AvoidGlobalModifier.xml
deleted file mode 100644
index ead264bc979..00000000000
--- a/pmd-apex/src/test/resources/net/sourceforge/pmd/lang/apex/rule/style/xml/AvoidGlobalModifier.xml
+++ /dev/null
@@ -1,52 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<test-data
- xmlns="http://pmd.sourceforge.net/rule-tests"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://pmd.sourceforge.net/rule-tests http://pmd.sourceforge.net/rule-tests_1_0_0.xsd">
-
- <test-code>
- <description>Global class</description>
- <expected-problems>1</expected-problems>
- <code><![CDATA[
-global class Foo {
-
-}
- ]]></code>
- </test-code>
-
- <test-code>
- <description>Global interface</description>
- <expected-problems>1</expected-problems>
- <code><![CDATA[
-global interface Foo {
-
-}
- ]]></code>
- </test-code>
-
- <test-code>
- <description>Global method</description>
- <expected-problems>1</expected-problems>
- <code><![CDATA[
-global class Foo {
- global Integer bar() {
-
- }
-}
- ]]></code>
- </test-code>
-
- <test-code>
- <description>Global inner interface</description>
- <expected-problems>1</expected-problems>
- <code><![CDATA[
-global class Foo {
- global interface Bar { {
-
- }
-}
- ]]></code>
- </test-code>
-
-</test-data>
diff --git a/pmd-apex/src/test/resources/rulesets/apex/metrics_test.xml b/pmd-apex/src/test/resources/rulesets/apex/metrics_test.xml
index 9864f7e3f65..b9980f75716 100644
--- a/pmd-apex/src/test/resources/rulesets/apex/metrics_test.xml
+++ b/pmd-apex/src/test/resources/rulesets/apex/metrics_test.xml
@@ -1,9 +1,9 @@
<?xml version="1.0"?>
<ruleset name="Metrics testing ruleset"
- xmlns="http://pmd.sourceforge.net/ruleset/3.0.0"
+ xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/3.0.0 http://pmd.sourceforge.net/ruleset_3_0_0.xsd">
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
<description>
Metrics testing ruleset. Each metric is tested through a dummy rule.
@@ -11,14 +11,12 @@
<rule name="CycloTest"
message = "''{0}'' has value {1}."
- class="net.sourceforge.pmd.lang.apex.metrics.impl.CycloTestRule"
- metrics="true">
+ class="net.sourceforge.pmd.lang.apex.metrics.impl.CycloTestRule">
</rule>
<rule name="WmcTest"
message = "''{0}'' has value {1}."
- class="net.sourceforge.pmd.lang.apex.metrics.impl.WmcTestRule"
- metrics="true">
+ class="net.sourceforge.pmd.lang.apex.metrics.impl.WmcTestRule">
</rule>
</ruleset>
diff --git a/pmd-core/etc/xslt/corley-pmd-report.xslt b/pmd-core/etc/xslt/corley-pmd-report.xslt
index 5c42a7d2093..181ac61108a 100644
--- a/pmd-core/etc/xslt/corley-pmd-report.xslt
+++ b/pmd-core/etc/xslt/corley-pmd-report.xslt
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Header$ -->
-<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xpath-default-namespace="http://pmd.sourceforge.net/report/2.0.0" version="2.0">
<xsl:output method="html" encoding="UTF-8" doctype-public="-//W3C//DTD HTML 4.01 Transitional//EN"
doctype-system="http://www.w3.org/TR/html4/loose.dtd" indent="yes"/>
diff --git a/pmd-core/etc/xslt/cpdhtml.xslt b/pmd-core/etc/xslt/cpdhtml.xslt
index 90126772310..e894a8e12bb 100644
--- a/pmd-core/etc/xslt/cpdhtml.xslt
+++ b/pmd-core/etc/xslt/cpdhtml.xslt
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Stylesheet to turn the XML output of CPD into a nice-looking HTML page -->
<!-- $Id$ -->
-<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xpath-default-namespace="http://pmd.sourceforge.net/report/2.0.0" version="2.0">
<xsl:output method="html" encoding="UTF-8" doctype-public="-//W3C//DTD HTML 4.01 Transitional//EN"
doctype-system="http://www.w3.org/TR/html4/loose.dtd" indent="yes"/>
diff --git a/pmd-core/etc/xslt/junit-txt-output.xsl b/pmd-core/etc/xslt/junit-txt-output.xsl
index 54cd2ad794f..757d0d1da87 100644
--- a/pmd-core/etc/xslt/junit-txt-output.xsl
+++ b/pmd-core/etc/xslt/junit-txt-output.xsl
@@ -1,4 +1,4 @@
-<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xpath-default-namespace="http://pmd.sourceforge.net/report/2.0.0" version="2.0">
<xsl:output method="text"/>
<xsl:template match="testsuites">
diff --git a/pmd-core/etc/xslt/only-prio1.xslt b/pmd-core/etc/xslt/only-prio1.xslt
index 92b335a8b97..1aa26eb5b9e 100644
--- a/pmd-core/etc/xslt/only-prio1.xslt
+++ b/pmd-core/etc/xslt/only-prio1.xslt
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Header$ -->
-<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xpath-default-namespace="http://pmd.sourceforge.net/report/2.0.0" version="2.0">
<xsl:output method="html" encoding="UTF-8" doctype-public="-//W3C//DTD HTML 4.01 Transitional//EN"
doctype-system="http://www.w3.org/TR/html4/loose.dtd" indent="yes"/>
diff --git a/pmd-core/etc/xslt/only-prio2.xslt b/pmd-core/etc/xslt/only-prio2.xslt
index bb6dd03b4a8..bf71ecf4caa 100644
--- a/pmd-core/etc/xslt/only-prio2.xslt
+++ b/pmd-core/etc/xslt/only-prio2.xslt
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Header$ -->
-<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xpath-default-namespace="http://pmd.sourceforge.net/report/2.0.0" version="2.0">
<xsl:output method="html" encoding="UTF-8" doctype-public="-//W3C//DTD HTML 4.01 Transitional//EN"
doctype-system="http://www.w3.org/TR/html4/loose.dtd" indent="yes"/>
diff --git a/pmd-core/etc/xslt/only-prio3.xslt b/pmd-core/etc/xslt/only-prio3.xslt
index 445c4ac868b..6548a9c54bc 100644
--- a/pmd-core/etc/xslt/only-prio3.xslt
+++ b/pmd-core/etc/xslt/only-prio3.xslt
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Header$ -->
-<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xpath-default-namespace="http://pmd.sourceforge.net/report/2.0.0" version="2.0">
<xsl:output method="html" encoding="UTF-8" doctype-public="-//W3C//DTD HTML 4.01 Transitional//EN"
doctype-system="http://www.w3.org/TR/html4/loose.dtd" indent="yes"/>
diff --git a/pmd-core/etc/xslt/only-prio4.xslt b/pmd-core/etc/xslt/only-prio4.xslt
index 9a60c27642e..e26c2650b99 100644
--- a/pmd-core/etc/xslt/only-prio4.xslt
+++ b/pmd-core/etc/xslt/only-prio4.xslt
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Header$ -->
-<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xpath-default-namespace="http://pmd.sourceforge.net/report/2.0.0" version="2.0">
<xsl:output method="html" encoding="UTF-8" doctype-public="-//W3C//DTD HTML 4.01 Transitional//EN"
doctype-system="http://www.w3.org/TR/html4/loose.dtd" indent="yes"/>
diff --git a/pmd-core/etc/xslt/only-prio5.xslt b/pmd-core/etc/xslt/only-prio5.xslt
index 80452064247..5e9937cc86d 100644
--- a/pmd-core/etc/xslt/only-prio5.xslt
+++ b/pmd-core/etc/xslt/only-prio5.xslt
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Header$ -->
-<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xpath-default-namespace="http://pmd.sourceforge.net/report/2.0.0" version="2.0">
<xsl:output method="html" encoding="UTF-8" doctype-public="-//W3C//DTD HTML 4.01 Transitional//EN"
doctype-system="http://www.w3.org/TR/html4/loose.dtd" indent="yes"/>
diff --git a/pmd-core/etc/xslt/pmd-report-per-class.xslt b/pmd-core/etc/xslt/pmd-report-per-class.xslt
index 741c631a32a..68218eea33e 100644
--- a/pmd-core/etc/xslt/pmd-report-per-class.xslt
+++ b/pmd-core/etc/xslt/pmd-report-per-class.xslt
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Header$ -->
-<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xpath-default-namespace="http://pmd.sourceforge.net/report/2.0.0" version="2.0">
<xsl:output method="html" encoding="UTF-8" doctype-public="-//W3C//DTD HTML 4.01 Transitional//EN"
doctype-system="http://www.w3.org/TR/html4/loose.dtd" indent="yes"/>
diff --git a/pmd-core/etc/xslt/pmd-report.xslt b/pmd-core/etc/xslt/pmd-report.xslt
index d3096a918a7..8a37c85d3bf 100644
--- a/pmd-core/etc/xslt/pmd-report.xslt
+++ b/pmd-core/etc/xslt/pmd-report.xslt
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
-<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xpath-default-namespace="http://pmd.sourceforge.net/report/2.0.0" version="2.0">
<xsl:variable name="cvsweb">http://doc.ece.uci.edu/cvs/viewcvs.cgi/Zen/packages/src/</xsl:variable>
@@ -13,13 +13,13 @@
table.details tr th { font-weight: bold; text-align:left; background:#a6caf0; }
table.details tr td { background:#eeeee0; }
table.summary tr th { font-weight: bold; text-align:left; background:#a6caf0; }
- table.summary tr td { background:#eeeee0; text-align:center;}
+ table.summary tr td { background:#eeeee0; text-align:center;}
.p1 { background:#FF9999; }
.p2 { background:#FFCC66; }
.p3 { background:#FFFF99; }
.p4 { background:#99FF99; }
- .p5 { background:#9999FF; }
-
+ .p5 { background:#9999FF; }
+
</style>
</head>
<body>
@@ -34,7 +34,7 @@
<th>Priority 2</th>
<th>Priority 3</th>
<th>Priority 4</th>
- <th>Priority 5</th>
+ <th>Priority 5</th>
</tr>
<tr>
<td><xsl:value-of select="count(//file)"/></td>
@@ -43,7 +43,7 @@
<td><div class="p2"><xsl:value-of select="count(//violation[@priority = 2])"/></div></td>
<td><div class="p3"><xsl:value-of select="count(//violation[@priority = 3])"/></div></td>
<td><div class="p4"><xsl:value-of select="count(//violation[@priority = 4])"/></div></td>
- <td><div class="p5"><xsl:value-of select="count(//violation[@priority = 5])"/></div></td>
+ <td><div class="p5"><xsl:value-of select="count(//violation[@priority = 5])"/></div></td>
</tr>
</table>
<hr/>
@@ -56,14 +56,14 @@
<th>Begin Line</th>
<th align="left">Description</th>
</tr>
-
+
<xsl:for-each select="violation">
<tr>
<td style="padding: 3px" align="right"><a><xsl:attribute name="href"><xsl:value-of select="$cvsweb"/><xsl:value-of select="$filename"/>?annotate=HEAD#<xsl:value-of disable-output-escaping="yes" select="@beginline"/></xsl:attribute><xsl:value-of disable-output-escaping="yes" select="@beginline"/></a></td>
<td style="padding: 3px" align="left" width="100%"><xsl:value-of disable-output-escaping="yes" select="."/></td>
</tr>
</xsl:for-each>
-
+
</table>
<br/>
</xsl:for-each>
diff --git a/pmd-core/etc/xslt/pmd-xmlfilter-prio1.xsl b/pmd-core/etc/xslt/pmd-xmlfilter-prio1.xsl
index d758c7b372e..92c057bf75a 100644
--- a/pmd-core/etc/xslt/pmd-xmlfilter-prio1.xsl
+++ b/pmd-core/etc/xslt/pmd-xmlfilter-prio1.xsl
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" >
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xpath-default-namespace="http://pmd.sourceforge.net/report/2.0.0" version="2.0">
<xsl:output method="xml"/>
<xsl:template match="node() | @*">
<xsl:copy>
diff --git a/pmd-core/etc/xslt/pmd-xmlfilter-prio2.xsl b/pmd-core/etc/xslt/pmd-xmlfilter-prio2.xsl
index 64151365157..8887278f3eb 100644
--- a/pmd-core/etc/xslt/pmd-xmlfilter-prio2.xsl
+++ b/pmd-core/etc/xslt/pmd-xmlfilter-prio2.xsl
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" >
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xpath-default-namespace="http://pmd.sourceforge.net/report/2.0.0" version="2.0">
<xsl:output method="xml"/>
<xsl:template match="node() | @*">
<xsl:copy>
diff --git a/pmd-core/etc/xslt/pmd-xmlfilter-prio3.xsl b/pmd-core/etc/xslt/pmd-xmlfilter-prio3.xsl
index b37e001375d..fb3441da835 100644
--- a/pmd-core/etc/xslt/pmd-xmlfilter-prio3.xsl
+++ b/pmd-core/etc/xslt/pmd-xmlfilter-prio3.xsl
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" >
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xpath-default-namespace="http://pmd.sourceforge.net/report/2.0.0" version="2.0">
<xsl:output method="xml"/>
<xsl:template match="node() | @*">
<xsl:copy>
diff --git a/pmd-core/etc/xslt/pmd-xmlfilter-prio4.xsl b/pmd-core/etc/xslt/pmd-xmlfilter-prio4.xsl
index 91c0e825ea1..76de4311150 100644
--- a/pmd-core/etc/xslt/pmd-xmlfilter-prio4.xsl
+++ b/pmd-core/etc/xslt/pmd-xmlfilter-prio4.xsl
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" >
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xpath-default-namespace="http://pmd.sourceforge.net/report/2.0.0" version="2.0">
<xsl:output method="xml"/>
<xsl:template match="node() | @*">
<xsl:copy>
diff --git a/pmd-core/etc/xslt/pmd-xmlfilter-prio5.xsl b/pmd-core/etc/xslt/pmd-xmlfilter-prio5.xsl
index e8ca43b453c..09df4562c44 100644
--- a/pmd-core/etc/xslt/pmd-xmlfilter-prio5.xsl
+++ b/pmd-core/etc/xslt/pmd-xmlfilter-prio5.xsl
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" >
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xpath-default-namespace="http://pmd.sourceforge.net/report/2.0.0" version="2.0">
<xsl:output method="xml"/>
<xsl:template match="node() | @*">
<xsl:copy>
diff --git a/pmd-core/etc/xslt/pmd-xmlfilter-upto-prio2.xsl b/pmd-core/etc/xslt/pmd-xmlfilter-upto-prio2.xsl
index 11ea0d8c992..aaad9197844 100644
--- a/pmd-core/etc/xslt/pmd-xmlfilter-upto-prio2.xsl
+++ b/pmd-core/etc/xslt/pmd-xmlfilter-upto-prio2.xsl
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" >
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xpath-default-namespace="http://pmd.sourceforge.net/report/2.0.0" version="2.0">
<xsl:output method="xml"/>
<xsl:template match="node() | @*">
<xsl:copy>
diff --git a/pmd-core/etc/xslt/pmd-xmlfilter-upto-prio3.xsl b/pmd-core/etc/xslt/pmd-xmlfilter-upto-prio3.xsl
index a64fac7db99..28db995f0ea 100644
--- a/pmd-core/etc/xslt/pmd-xmlfilter-upto-prio3.xsl
+++ b/pmd-core/etc/xslt/pmd-xmlfilter-upto-prio3.xsl
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" >
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xpath-default-namespace="http://pmd.sourceforge.net/report/2.0.0" version="2.0">
<xsl:output method="xml"/>
<xsl:template match="node() | @*">
<xsl:copy>
diff --git a/pmd-core/etc/xslt/pmd-xmlfilter-upto-prio4.xsl b/pmd-core/etc/xslt/pmd-xmlfilter-upto-prio4.xsl
index 9d256d3bd41..f497c45e021 100644
--- a/pmd-core/etc/xslt/pmd-xmlfilter-upto-prio4.xsl
+++ b/pmd-core/etc/xslt/pmd-xmlfilter-upto-prio4.xsl
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" >
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xpath-default-namespace="http://pmd.sourceforge.net/report/2.0.0" version="2.0">
<xsl:output method="xml"/>
<xsl:template match="node() | @*">
<xsl:copy>
diff --git a/pmd-core/etc/xslt/wz-pmd-report.xslt b/pmd-core/etc/xslt/wz-pmd-report.xslt
index 8511ac37ce3..6abe9af9cfe 100644
--- a/pmd-core/etc/xslt/wz-pmd-report.xslt
+++ b/pmd-core/etc/xslt/wz-pmd-report.xslt
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Header$ -->
-<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xpath-default-namespace="http://pmd.sourceforge.net/report/2.0.0" version="2.0">
<xsl:output method="html" encoding="UTF-8" doctype-public="-//W3C//DTD HTML 4.01 Transitional//EN"
doctype-system="http://www.w3.org/TR/html4/loose.dtd" indent="yes"/>
diff --git a/pmd-core/pom.xml b/pmd-core/pom.xml
index 9262c561106..60d278817ab 100644
--- a/pmd-core/pom.xml
+++ b/pmd-core/pom.xml
@@ -7,13 +7,9 @@
<parent>
<groupId>net.sourceforge.pmd</groupId>
<artifactId>pmd</artifactId>
- <version>6.0.0-SNAPSHOT</version>
+ <version>6.10.0-SNAPSHOT</version>
</parent>
- <properties>
- <config.basedir>${basedir}</config.basedir>
- </properties>
-
<build>
<plugins>
<plugin>
@@ -64,6 +60,34 @@
<suppressionsLocation>pmd-core-checkstyle-suppressions.xml</suppressionsLocation>
</configuration>
</plugin>
+
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-shade-plugin</artifactId>
+ <configuration>
+ <artifactSet>
+ <includes>jaxen:jaxen</includes>
+ </artifactSet>
+ <filters>
+ <filter>
+ <artifact>jaxen:jaxen</artifact>
+ <includes>
+ <include>org/jaxen/**</include>
+ </includes>
+ <excludes>
+ <exclude>org/w3c/dom/**</exclude>
+ </excludes>
+ </filter>
+ </filters>
+ </configuration>
+ <executions>
+ <execution>
+ <goals>
+ <goal>shade</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
</plugins>
</build>
<dependencies>
@@ -72,7 +96,10 @@
<artifactId>ant</artifactId>
<scope>provided</scope>
</dependency>
-
+ <dependency>
+ <groupId>org.antlr</groupId>
+ <artifactId>antlr4-runtime</artifactId>
+ </dependency>
<dependency>
<groupId>com.beust</groupId>
<artifactId>jcommander</artifactId>
@@ -84,6 +111,15 @@
<dependency>
<groupId>jaxen</groupId>
<artifactId>jaxen</artifactId>
+ <!--
+ Jaxen is optionally, so that it doesn't get inherited by default.
+ Jaxen is shaded into pmd-core (without org.w3c.dom.UserDataHandler).
+ Adding Jaxen again as a dependency would reintroduce the duplicated
+ org.w3c.dom.UserDataHandler interface.
+ See https://github.com/pmd/pmd/issues/1074
+ and https://github.com/pmd/pmd/pull/1201
+ -->
+ <optional>true</optional>
</dependency>
<dependency>
<groupId>net.java.dev.javacc</groupId>
@@ -125,6 +161,16 @@
<artifactId>junit</artifactId>
<scope>test</scope>
</dependency>
+ <dependency>
+ <groupId>org.hamcrest</groupId>
+ <artifactId>hamcrest-library</artifactId>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>pl.pragmatists</groupId>
+ <artifactId>JUnitParams</artifactId>
+ <scope>test</scope>
+ </dependency>
<dependency>
<groupId>org.apache.ant</groupId>
<artifactId>ant-testutil</artifactId>
@@ -141,4 +187,45 @@
<scope>test</scope>
</dependency>
</dependencies>
+
+ <profiles>
+ <profile>
+ <id>m2e</id>
+ <!-- This profile is only activated when building in Eclipse with m2e -->
+ <activation>
+ <property>
+ <name>m2e.version</name>
+ </property>
+ </activation>
+ <dependencies>
+ <!--
+ the maven-shade-plugin runs during package phase,
+ but inside eclipse, this phase is not executed during development.
+ Therefore this profile adds back the jaxen dependency in eclipse.
+ -->
+ <dependency>
+ <groupId>jaxen</groupId>
+ <artifactId>jaxen</artifactId>
+ <optional>false</optional>
+ </dependency>
+ </dependencies>
+ </profile>
+ <profile>
+ <id>idea</id>
+ <!-- This profile is only activated when building in IntelliJ -->
+ <!-- It serves the same purpose as the above for eclipse-->
+ <activation>
+ <property>
+ <name>idea.maven.embedder.version</name>
+ </property>
+ </activation>
+ <dependencies>
+ <dependency>
+ <groupId>jaxen</groupId>
+ <artifactId>jaxen</artifactId>
+ <optional>false</optional>
+ </dependency>
+ </dependencies>
+ </profile>
+ </profiles>
</project>
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/AbstractConfiguration.java b/pmd-core/src/main/java/net/sourceforge/pmd/AbstractConfiguration.java
index bededb0f956..671cf74da13 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/AbstractConfiguration.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/AbstractConfiguration.java
@@ -4,6 +4,8 @@
package net.sourceforge.pmd;
+import java.nio.charset.Charset;
+
/**
* Base configuration class for both PMD and CPD.
*
@@ -11,7 +13,7 @@
*/
public abstract class AbstractConfiguration {
- private String sourceEncoding = System.getProperty("file.encoding");
+ private Charset sourceEncoding = Charset.forName(System.getProperty("file.encoding"));
private boolean debug;
/**
@@ -26,7 +28,7 @@ protected AbstractConfiguration() {
*
* @return The character encoding.
*/
- public String getSourceEncoding() {
+ public Charset getSourceEncoding() {
return sourceEncoding;
}
@@ -37,7 +39,7 @@ public String getSourceEncoding() {
* The character encoding.
*/
public void setSourceEncoding(String sourceEncoding) {
- this.sourceEncoding = sourceEncoding;
+ this.sourceEncoding = Charset.forName(sourceEncoding);
}
/**
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/PMD.java b/pmd-core/src/main/java/net/sourceforge/pmd/PMD.java
index b6ba7ec6b74..7372f159060 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/PMD.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/PMD.java
@@ -6,7 +6,8 @@
import java.io.File;
import java.io.IOException;
-import java.io.InputStream;
+import java.io.OutputStreamWriter;
+import java.io.Writer;
import java.net.URISyntaxException;
import java.sql.SQLException;
import java.util.ArrayList;
@@ -14,18 +15,19 @@
import java.util.Comparator;
import java.util.HashSet;
import java.util.List;
-import java.util.Properties;
import java.util.Set;
import java.util.concurrent.atomic.AtomicInteger;
-import java.util.logging.Handler;
+import java.util.logging.ConsoleHandler;
import java.util.logging.Level;
import java.util.logging.Logger;
-import org.apache.commons.io.IOUtils;
-
-import net.sourceforge.pmd.benchmark.Benchmark;
-import net.sourceforge.pmd.benchmark.Benchmarker;
-import net.sourceforge.pmd.benchmark.TextReport;
+import net.sourceforge.pmd.benchmark.TextTimingReportRenderer;
+import net.sourceforge.pmd.benchmark.TimeTracker;
+import net.sourceforge.pmd.benchmark.TimedOperation;
+import net.sourceforge.pmd.benchmark.TimedOperationCategory;
+import net.sourceforge.pmd.benchmark.TimingReport;
+import net.sourceforge.pmd.benchmark.TimingReportRenderer;
+import net.sourceforge.pmd.cache.NoopAnalysisCache;
import net.sourceforge.pmd.cli.PMDCommandLineInterface;
import net.sourceforge.pmd.cli.PMDParameters;
import net.sourceforge.pmd.lang.Language;
@@ -42,12 +44,12 @@
import net.sourceforge.pmd.util.ClasspathClassLoader;
import net.sourceforge.pmd.util.FileUtil;
import net.sourceforge.pmd.util.IOUtil;
+import net.sourceforge.pmd.util.ResourceLoader;
import net.sourceforge.pmd.util.database.DBMSMetadata;
import net.sourceforge.pmd.util.database.DBURI;
import net.sourceforge.pmd.util.database.SourceObject;
import net.sourceforge.pmd.util.datasource.DataSource;
import net.sourceforge.pmd.util.datasource.ReaderDataSource;
-import net.sourceforge.pmd.util.log.ConsoleLogHandler;
import net.sourceforge.pmd.util.log.ScopedLogHandlersManager;
/**
@@ -78,8 +80,10 @@ public class PMD {
/**
* Constant that contains always the current version of PMD.
+ * @deprecated Use {@link PMDVersion#VERSION} instead.
*/
- public static final String VERSION;
+ @Deprecated // to be removed with PMD 7.0.0.
+ public static final String VERSION = PMDVersion.VERSION;
/**
* Create a PMD instance using a default Configuration. Changes to the
@@ -168,54 +172,6 @@ public static Parser parserFor(LanguageVersion languageVersion, PMDConfiguration
return languageVersionHandler.getParser(options);
}
- /**
- * Create a report, filter out any defective rules, and keep a record of
- * them.
- *
- * @param rs
- * the rules
- * @param ctx
- * the rule context
- * @param fileName
- * the filename of the source file, which should appear in the
- * report
- * @return the Report
- */
- public static Report setupReport(RuleSets rs, RuleContext ctx, String fileName) {
-
- Set<Rule> brokenRules = removeBrokenRules(rs);
- Report report = Report.createReport(ctx, fileName);
-
- for (Rule rule : brokenRules) {
- report.addConfigError(new Report.ConfigurationError(rule, rule.dysfunctionReason()));
- }
-
- return report;
- }
-
- /**
- * Remove and return the misconfigured rules from the rulesets and log them
- * for good measure.
- *
- * @param ruleSets
- * RuleSets
- * @return Set<Rule>
- */
- private static Set<Rule> removeBrokenRules(RuleSets ruleSets) {
-
- Set<Rule> brokenRules = new HashSet<>();
- ruleSets.removeDysfunctionalRules(brokenRules);
-
- for (Rule rule : brokenRules) {
- if (LOG.isLoggable(Level.WARNING)) {
- LOG.log(Level.WARNING,
- "Removed misconfigured rule: " + rule.getName() + " cause: " + rule.dysfunctionReason());
- }
- }
-
- return brokenRules;
- }
-
/**
* Get the runtime configuration. The configuration can be modified to
* affect how PMD behaves.
@@ -246,7 +202,7 @@ public SourceCodeProcessor getSourceCodeProcessor() {
public static int doPMD(PMDConfiguration configuration) {
// Load the RuleSets
- RuleSetFactory ruleSetFactory = RulesetsFactoryUtils.getRulesetFactory(configuration);
+ RuleSetFactory ruleSetFactory = RulesetsFactoryUtils.getRulesetFactory(configuration, new ResourceLoader());
RuleSets ruleSets = RulesetsFactoryUtils.getRuleSetsWithBenchmark(configuration.getRuleSets(), ruleSetFactory);
if (ruleSets == null) {
return 0;
@@ -255,35 +211,40 @@ public static int doPMD(PMDConfiguration configuration) {
Set<Language> languages = getApplicableLanguages(configuration, ruleSets);
List<DataSource> files = getApplicableFiles(configuration, languages);
- long reportStart = System.nanoTime();
try {
- Renderer renderer = configuration.createRenderer();
- List<Renderer> renderers = Collections.singletonList(renderer);
-
- renderer.setWriter(IOUtil.createWriter(configuration.getReportFile()));
- renderer.start();
-
- Benchmarker.mark(Benchmark.Reporting, System.nanoTime() - reportStart, 0);
+ Renderer renderer;
+ List<Renderer> renderers;
+ try (TimedOperation to = TimeTracker.startOperation(TimedOperationCategory.REPORTING)) {
+ renderer = configuration.createRenderer();
+ renderers = Collections.singletonList(renderer);
+
+ renderer.setWriter(IOUtil.createWriter(configuration.getReportFile()));
+ renderer.start();
+ }
RuleContext ctx = new RuleContext();
final AtomicInteger violations = new AtomicInteger(0);
ctx.getReport().addListener(new ThreadSafeReportListener() {
@Override
public void ruleViolationAdded(RuleViolation ruleViolation) {
- violations.incrementAndGet();
+ violations.getAndIncrement();
}
@Override
public void metricAdded(Metric metric) {
+ // ignored - not needed for counting violations
}
});
- processFiles(configuration, ruleSetFactory, files, ctx, renderers);
+ try (TimedOperation to = TimeTracker.startOperation(TimedOperationCategory.FILE_PROCESSING)) {
+ processFiles(configuration, ruleSetFactory, files, ctx, renderers);
+ }
- reportStart = System.nanoTime();
- renderer.end();
- renderer.flush();
- return violations.get();
+ try (TimedOperation rto = TimeTracker.startOperation(TimedOperationCategory.REPORTING)) {
+ renderer.end();
+ renderer.flush();
+ return violations.get();
+ }
} catch (Exception e) {
String message = e.getMessage();
if (message != null) {
@@ -295,8 +256,6 @@ public void metricAdded(Metric metric) {
LOG.info(PMDCommandLineInterface.buildUsageText());
return 0;
} finally {
- Benchmarker.mark(Benchmark.Reporting, System.nanoTime() - reportStart, 0);
-
/*
* Make sure it's our own classloader before attempting to close it....
* Maven + Jacoco provide us with a cloaseable classloader that if closed
@@ -344,6 +303,14 @@ public static RuleContext newRuleContext(String sourceCodeFilename, File sourceC
public static void processFiles(final PMDConfiguration configuration, final RuleSetFactory ruleSetFactory,
final List<DataSource> files, final RuleContext ctx, final List<Renderer> renderers) {
+ if (!configuration.isIgnoreIncrementalAnalysis()
+ && configuration.getAnalysisCache() instanceof NoopAnalysisCache
+ && LOG.isLoggable(Level.WARNING)) {
+ final String version = PMDVersion.isUnknown() || PMDVersion.isSnapshot() ? "latest" : "pmd-" + PMDVersion.VERSION;
+ LOG.warning("This analysis could be faster, please consider using Incremental Analysis: "
+ + "https://pmd.github.io/" + version + "/pmd_userdocs_incremental_analysis.html");
+ }
+
sortFiles(configuration, files);
// Make sure the cache is listening for analysis results
@@ -395,11 +362,9 @@ public int compare(DataSource left, DataSource right) {
* @return List of {@link DataSource} of files
*/
public static List<DataSource> getApplicableFiles(PMDConfiguration configuration, Set<Language> languages) {
- long startFiles = System.nanoTime();
- List<DataSource> files = internalGetApplicableFiles(configuration, languages);
- long endFiles = System.nanoTime();
- Benchmarker.mark(Benchmark.CollectFiles, endFiles - startFiles, 0);
- return files;
+ try (TimedOperation to = TimeTracker.startOperation(TimedOperationCategory.COLLECT_FILES)) {
+ return internalGetApplicableFiles(configuration, languages);
+ }
}
private static List<DataSource> internalGetApplicableFiles(PMDConfiguration configuration,
@@ -440,6 +405,23 @@ private static List<DataSource> internalGetApplicableFiles(PMDConfiguration conf
}
}
+
+ if (null != configuration.getIgnoreFilePath()) {
+ String ignoreFilePath = configuration.getIgnoreFilePath();
+ File file = new File(ignoreFilePath);
+ try {
+ if (!file.exists()) {
+ LOG.log(Level.SEVERE, "Problem with Ignore File Path", ignoreFilePath);
+ throw new RuntimeException("Problem with Ignore File Path: " + ignoreFilePath);
+ } else {
+ String filePaths = FileUtil.readFilelist(new File(ignoreFilePath));
+ files.removeAll(FileUtil.collectFiles(filePaths, fileSelector));
+ }
+ } catch (IOException ex) {
+ LOG.log(Level.SEVERE, "Problem with Ignore File", ex);
+ throw new RuntimeException("Problem with Ignore File Path: " + ignoreFilePath, ex);
+ }
+ }
return files;
}
@@ -483,14 +465,17 @@ public static void main(String[] args) {
* violations found.
*/
public static int run(String[] args) {
- int status = 0;
- long start = System.nanoTime();
final PMDParameters params = PMDCommandLineInterface.extractParameters(new PMDParameters(), args, "pmd");
- final PMDConfiguration configuration = PMDParameters.transformParametersIntoConfiguration(params);
+
+ if (params.isBenchmark()) {
+ TimeTracker.startGlobalTracking();
+ }
+
+ int status = 0;
+ final PMDConfiguration configuration = params.toConfiguration();
final Level logLevel = params.isDebug() ? Level.FINER : Level.INFO;
- final Handler logHandler = new ConsoleLogHandler();
- final ScopedLogHandlersManager logHandlerManager = new ScopedLogHandlersManager(logLevel, logHandler);
+ final ScopedLogHandlersManager logHandlerManager = new ScopedLogHandlersManager(logLevel, new ConsoleHandler());
final Level oldLogLevel = LOG.getLevel();
// Need to do this, since the static logger has already been initialized
// at this point
@@ -511,40 +496,21 @@ public static int run(String[] args) {
} finally {
logHandlerManager.close();
LOG.setLevel(oldLogLevel);
+
if (params.isBenchmark()) {
- long end = System.nanoTime();
- Benchmarker.mark(Benchmark.TotalPMD, end - start, 0);
+ final TimingReport timingReport = TimeTracker.stopGlobalTracking();
// TODO get specified report format from config
- TextReport report = new TextReport();
-
- report.generate(Benchmarker.values(), System.err);
+ final TimingReportRenderer renderer = new TextTimingReportRenderer();
+ try {
+ // Don't close this writer, we don't want to close stderr
+ final Writer writer = new OutputStreamWriter(System.err);
+ renderer.render(timingReport, writer);
+ } catch (final IOException e) {
+ System.err.println(e.getMessage());
+ }
}
}
return status;
}
-
- /**
- * Determines the version from maven's generated pom.properties file.
- */
- static {
- String pmdVersion = null;
- InputStream stream = PMD.class
- .getResourceAsStream("/META-INF/maven/net.sourceforge.pmd/pmd-core/pom.properties");
- if (stream != null) {
- try {
- Properties properties = new Properties();
- properties.load(stream);
- pmdVersion = properties.getProperty("version");
- } catch (IOException e) {
- LOG.log(Level.FINE, "Couldn't determine version of PMD", e);
- } finally {
- IOUtils.closeQuietly(stream);
- }
- }
- if (pmdVersion == null) {
- pmdVersion = "unknown";
- }
- VERSION = pmdVersion;
- }
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/PMDConfiguration.java b/pmd-core/src/main/java/net/sourceforge/pmd/PMDConfiguration.java
index c59ed57c779..dd179c05bcf 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/PMDConfiguration.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/PMDConfiguration.java
@@ -80,7 +80,6 @@
* </ul>
*/
public class PMDConfiguration extends AbstractConfiguration {
-
// General behavior options
private String suppressMarker = PMD.SUPPRESS_MARKER;
private int threads = Runtime.getRuntime().availableProcessors();
@@ -93,6 +92,7 @@ public class PMDConfiguration extends AbstractConfiguration {
private String inputPaths;
private String inputUri;
private String inputFilePath;
+ private String ignoreFilePath;
private boolean ruleSetFactoryCompatibilityEnabled = true;
// Reporting options
@@ -106,6 +106,7 @@ public class PMDConfiguration extends AbstractConfiguration {
private boolean stressTest;
private boolean benchmark;
private AnalysisCache analysisCache = new NoopAnalysisCache();
+ private boolean ignoreIncrementalAnalysis;
/**
* Get the suppress marker. This is the source level marker used to indicate
@@ -315,6 +316,10 @@ public String getInputFilePath() {
return inputFilePath;
}
+ public String getIgnoreFilePath() {
+ return ignoreFilePath;
+ }
+
/**
* The input file path points to a single file, which contains a
* comma-separated list of source file names to process.
@@ -326,6 +331,17 @@ public void setInputFilePath(String inputFilePath) {
this.inputFilePath = inputFilePath;
}
+ /**
+ * The input file path points to a single file, which contains a
+ * comma-separated list of source file names to ignore.
+ *
+ * @param ignoreFilePath
+ * path to the file
+ */
+ public void setIgnoreFilePath(String ignoreFilePath) {
+ this.ignoreFilePath = ignoreFilePath;
+ }
+
/**
* Get the input URI to process for source code objects.
*
@@ -552,8 +568,7 @@ public boolean isRuleSetFactoryCompatibilityEnabled() {
/**
* Sets the rule set factory compatibility feature enabled/disabled.
*
- * @param ruleSetFactoryCompatibilityEnabled
- * <code>true</code> if the feature should be enabled
+ * @param ruleSetFactoryCompatibilityEnabled {@code true} if the feature should be enabled
*
* @see RuleSetFactoryCompatibility
*/
@@ -567,21 +582,27 @@ public void setRuleSetFactoryCompatibilityEnabled(boolean ruleSetFactoryCompatib
* @return The currently used analysis cache. Never null.
*/
public AnalysisCache getAnalysisCache() {
+ // Make sure we are not null
+ if (analysisCache == null || isIgnoreIncrementalAnalysis() && !(analysisCache instanceof NoopAnalysisCache)) {
+ // sets a noop cache
+ setAnalysisCache(new NoopAnalysisCache());
+ }
+
return analysisCache;
}
/**
* Sets the analysis cache to be used. Setting a
- * value of <code>null</code> will cause a Noop AnalysisCache to be used.
- *
+ * value of {@code null} will cause a Noop AnalysisCache to be used.
+ * If incremental analysis was explicitly disabled ({@link #isIgnoreIncrementalAnalysis()}),
+ * then this method is a noop.
+ *
* @param cache The analysis cache to be used.
*/
public void setAnalysisCache(final AnalysisCache cache) {
- if (cache == null) {
- analysisCache = new NoopAnalysisCache();
- } else {
- analysisCache = cache;
- }
+ // the doc says it's a noop if incremental analysis was disabled,
+ // but it's actually the getter that enforces that
+ this.analysisCache = cache == null ? new NoopAnalysisCache() : cache;
}
/**
@@ -591,10 +612,32 @@ public void setAnalysisCache(final AnalysisCache cache) {
* @param cacheLocation The location of the analysis cache to be used.
*/
public void setAnalysisCacheLocation(final String cacheLocation) {
- if (cacheLocation == null) {
- setAnalysisCache(new NoopAnalysisCache());
- } else {
- setAnalysisCache(new FileAnalysisCache(new File(cacheLocation)));
- }
+ setAnalysisCache(cacheLocation == null
+ ? new NoopAnalysisCache()
+ : new FileAnalysisCache(new File(cacheLocation)));
+ }
+
+
+ /**
+ * Sets whether the user has explicitly disabled incremental analysis or not.
+ * If so, incremental analysis is not used, and all suggestions to use it are
+ * disabled. The analysis cached location is ignored, even if it's specified.
+ *
+ * @param noCache Whether to ignore incremental analysis or not
+ */
+ public void setIgnoreIncrementalAnalysis(boolean noCache) {
+ // see #getAnalysisCache for the implementation.
+ this.ignoreIncrementalAnalysis = noCache;
+ }
+
+
+ /**
+ * Returns whether incremental analysis was explicitly disabled by the user
+ * or not.
+ *
+ * @return {@code true} if incremental analysis is explicitly disabled
+ */
+ public boolean isIgnoreIncrementalAnalysis() {
+ return ignoreIncrementalAnalysis;
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/PMDVersion.java b/pmd-core/src/main/java/net/sourceforge/pmd/PMDVersion.java
new file mode 100644
index 00000000000..3e50b27392a
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/PMDVersion.java
@@ -0,0 +1,79 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Properties;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+/**
+ * Stores the current PMD version and provides utility methods around it.
+ */
+public final class PMDVersion {
+
+ private static final Logger LOG = Logger.getLogger(PMDVersion.class.getName());
+
+ /**
+ * Constant that contains always the current version of PMD.
+ */
+ public static final String VERSION;
+
+ private static final String UNKNOWN_VERSION = "unknown";
+
+ /**
+ * Determines the version from maven's generated pom.properties file.
+ */
+ static {
+ String pmdVersion = UNKNOWN_VERSION;
+ try (InputStream stream = PMDVersion.class.getResourceAsStream("/META-INF/maven/net.sourceforge.pmd/pmd-core/pom.properties")) {
+ if (stream != null) {
+ final Properties properties = new Properties();
+ properties.load(stream);
+ pmdVersion = properties.getProperty("version");
+ }
+ } catch (final IOException e) {
+ LOG.log(Level.FINE, "Couldn't determine version of PMD", e);
+ }
+
+ VERSION = pmdVersion;
+ }
+
+ private PMDVersion() {
+ throw new AssertionError("Can't instantiate utility classes");
+ }
+
+ /**
+ * Retrieves the next major release to be expected.
+ * Useful when logging deprecation messages to indicate when support will be removed.
+ *
+ * @return The next major release to be expected.
+ */
+ public static String getNextMajorRelease() {
+ if (isUnknown()) {
+ return UNKNOWN_VERSION;
+ }
+
+ final int major = Integer.parseInt(VERSION.split("\\.")[0]);
+ return (major + 1) + ".0.0";
+ }
+
+ /**
+ * Checks if the current version is unknown.
+ * @return True if an unknown version, false otherwise
+ */
+ public static boolean isUnknown() {
+ return UNKNOWN_VERSION.equals(VERSION);
+ }
+
+ /**
+ * Checks if the current version is a snapshot.
+ * @return True if a snapshot release, false otherwise
+ */
+ public static boolean isSnapshot() {
+ return VERSION.endsWith("-SNAPSHOT");
+ }
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/Report.java b/pmd-core/src/main/java/net/sourceforge/pmd/Report.java
index 0ed214c74a7..ff2a29a6720 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/Report.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/Report.java
@@ -169,10 +169,9 @@ public String getDetail() {
error.printStackTrace(writer);
return stringWriter.toString();
} catch (IOException e) {
- // can never happen when using StringWriter
+ // IOException on close - should never happen when using StringWriter
+ throw new RuntimeException(e);
}
-
- return null;
}
public String getFile() {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/Rule.java b/pmd-core/src/main/java/net/sourceforge/pmd/Rule.java
index 222b1da10ff..3fc13e727cb 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/Rule.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/Rule.java
@@ -112,6 +112,7 @@ public interface Rule extends PropertySource {
*
* @return the name
*/
+ @Override
String getName();
/**
@@ -257,54 +258,107 @@ public interface Rule extends PropertySource {
/**
* Sets whether this Rule uses Data Flow Analysis.
+ * @deprecated Use {@link #setDfa(boolean)} instead.
*/
- // FUTURE Use JavaBean conventions for boolean attributes
+ @Deprecated // To be removed in PMD 7.0.0
void setUsesDFA();
+ /**
+ * Sets whether this Rule uses Data Flow Analysis.
+ */
+ void setDfa(boolean isDfa);
+
/**
* Gets whether this Rule uses Data Flow Analysis.
*
* @return <code>true</code> if Data Flow Analysis is used.
+ * @deprecated Use {@link #isDfa()} instead.
*/
- // FUTURE Use JavaBean conventions for boolean attributes
+ @Deprecated // To be removed in PMD 7.0.0
boolean usesDFA();
+ /**
+ * Gets whether this Rule uses Data Flow Analysis.
+ *
+ * @return <code>true</code> if Data Flow Analysis is used.
+ */
+ boolean isDfa();
+
/**
* Sets whether this Rule uses Type Resolution.
+ * @deprecated Use {@link #setTypeResolution(boolean)} instead.
*/
- // FUTURE Use JavaBean conventions for boolean attributes
+ @Deprecated // To be removed in PMD 7.0.0
void setUsesTypeResolution();
+ /**
+ * Sets whether this Rule uses Type Resolution.
+ */
+ void setTypeResolution(boolean usingTypeResolution);
+
/**
* Gets whether this Rule uses Type Resolution.
*
* @return <code>true</code> if Type Resolution is used.
+ *
+ * @deprecated Use {@link #isTypeResolution()} instead
*/
- // FUTURE Use JavaBean conventions for boolean attributes
+ @Deprecated // To be removed in PMD 7.0.0
boolean usesTypeResolution();
/**
- * Sets whether this Rule uses Object-Oriented Metrics.
+ * Gets whether this Rule uses Type Resolution.
+ *
+ * @return <code>true</code> if Type Resolution is used.
+ */
+ boolean isTypeResolution();
+
+ /**
+ * Sets whether this Rule uses multi-file analysis.
+ * @deprecated use {@link #setMultifile(boolean)} instead.
+ */
+ @Deprecated // To be removed in PMD 7.0.0
+ void setUsesMultifile();
+
+ /**
+ * Sets whether this Rule uses multi-file analysis.
+ */
+ void setMultifile(boolean multifile);
+
+ /**
+ * Gets whether this Rule uses multi-file analysis.
+ *
+ * @return <code>true</code> if the multi file analysis is used.
+ *
+ * @deprecated Use {@link #isMultifile()} instead.
*/
- // FUTURE Use JavaBean conventions for boolean attributes
- void setUsesMetrics();
+ @Deprecated // To be removed in PMD 7.0.0
+ boolean usesMultifile();
/**
- * Gets whether this Rule uses Object-Oriented Metrics.
+ * Gets whether this Rule uses multi-file analysis.
*
- * @return <code>true</code> if the Metrics Framework is used.
+ * @return <code>true</code> if the multi file analysis is used.
*/
- // FUTURE Use JavaBean conventions for boolean attributes
- boolean usesMetrics();
+ boolean isMultifile();
/**
* Gets whether this Rule uses the RuleChain.
*
* @return <code>true</code> if RuleChain is used.
+ *
+ * @deprecated USe {@link #isRuleChain()} instead.
*/
- // FUTURE Use JavaBean conventions for boolean attributes
+ @Deprecated // To be removed in PMD 7.0.0
boolean usesRuleChain();
+ /**
+ * Gets whether this Rule uses the RuleChain.
+ *
+ * @return <code>true</code> if RuleChain is used.
+ */
+ boolean isRuleChain();
+
/**
* Gets the collection of AST node names visited by the Rule on the
* RuleChain.
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/RuleSet.java b/pmd-core/src/main/java/net/sourceforge/pmd/RuleSet.java
index 1fbefe1d9f5..71d5bc24a5a 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/RuleSet.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/RuleSet.java
@@ -18,8 +18,9 @@
import org.apache.commons.lang3.StringUtils;
-import net.sourceforge.pmd.benchmark.Benchmark;
-import net.sourceforge.pmd.benchmark.Benchmarker;
+import net.sourceforge.pmd.benchmark.TimeTracker;
+import net.sourceforge.pmd.benchmark.TimedOperation;
+import net.sourceforge.pmd.benchmark.TimedOperationCategory;
import net.sourceforge.pmd.cache.ChecksumAware;
import net.sourceforge.pmd.lang.Language;
import net.sourceforge.pmd.lang.LanguageVersion;
@@ -57,12 +58,9 @@ public class RuleSet implements ChecksumAware {
/**
* Creates a new RuleSet with the given checksum.
- *
- * @param checksum
- * A checksum of the ruleset, should change only if the ruleset
- * was configured differently
- * @param rules
- * The rules to be applied as part of this ruleset
+ *
+ * @param builder
+ * A rule set builder.
*/
private RuleSet(final RuleSetBuilder builder) {
checksum = builder.checksum;
@@ -122,15 +120,26 @@ public RuleSet(final RuleSet rs) {
* Add a new rule to this ruleset. Note that this method does not check
* for duplicates.
*
- * @param rule
+ * @param newRule
* the rule to be added
* @return The same builder, for a fluid programming interface
*/
- public RuleSetBuilder addRule(final Rule rule) {
- if (rule == null) {
+ public RuleSetBuilder addRule(final Rule newRule) {
+ if (newRule == null) {
throw new IllegalArgumentException(MISSING_RULE);
}
- rules.add(rule);
+
+ // check for duplicates - adding more than one rule with the same name will
+ // be problematic - see #RuleSet.getRuleByName(String)
+ for (Rule rule : rules) {
+ if (rule.getName().equals(newRule.getName()) && rule.getLanguage() == newRule.getLanguage()) {
+ LOG.warning("The rule with name " + newRule.getName() + " is duplicated. "
+ + "Future versions of PMD will reject to load such rulesets.");
+ break;
+ }
+ }
+
+ rules.add(newRule);
return this;
}
@@ -163,15 +172,22 @@ public RuleSetBuilder addRuleReplaceIfExists(final Rule rule) {
* same language was added before, so that the existent rule
* configuration won't be overridden.
*
- * @param rule
+ * @param ruleOrRef
* the new rule to add
* @return The same builder, for a fluid programming interface
*/
- public RuleSetBuilder addRuleIfNotExists(final Rule rule) {
- if (rule == null) {
+ public RuleSetBuilder addRuleIfNotExists(final Rule ruleOrRef) {
+ if (ruleOrRef == null) {
throw new IllegalArgumentException(MISSING_RULE);
}
+ // resolve the underlying rule, to avoid adding duplicated rules
+ // if the rule has been renamed/merged and moved at the same time
+ Rule rule = ruleOrRef;
+ while (rule instanceof RuleReference) {
+ rule = ((RuleReference) rule).getRule();
+ }
+
boolean exists = false;
for (final Rule r : rules) {
if (r.getName().equals(rule.getName()) && r.getLanguage() == rule.getLanguage()) {
@@ -180,7 +196,7 @@ public RuleSetBuilder addRuleIfNotExists(final Rule rule) {
}
}
if (!exists) {
- addRule(rule);
+ addRule(ruleOrRef);
}
return this;
}
@@ -207,9 +223,7 @@ public RuleSetBuilder addRuleByReference(final String ruleSetFileName, final Rul
ruleReference = (RuleReference) rule;
} else {
final RuleSetReference ruleSetReference = new RuleSetReference(ruleSetFileName);
- ruleReference = new RuleReference();
- ruleReference.setRule(rule);
- ruleReference.setRuleSetReference(ruleSetReference);
+ ruleReference = new RuleReference(rule, ruleSetReference);
}
rules.add(ruleReference);
return this;
@@ -387,6 +401,17 @@ public String getName() {
public RuleSet build() {
return new RuleSet(this);
}
+
+ public void filterRulesByPriority(RulePriority minimumPriority) {
+ Iterator<Rule> iterator = rules.iterator();
+ while (iterator.hasNext()) {
+ Rule rule = iterator.next();
+ if (rule.getPriority().compareTo(minimumPriority) > 0) {
+ LOG.fine("Removing rule " + rule.getName() + " due to priority: " + rule.getPriority() + " required: " + minimumPriority);
+ iterator.remove();
+ }
+ }
+ }
}
/**
@@ -441,7 +466,7 @@ public Rule getRuleByName(String ruleName) {
* <code>false</code> otherwise
*/
public boolean applies(File file) {
- return file != null ? filter.filter(file) : true;
+ return file == null || filter.filter(file);
}
/**
@@ -466,23 +491,24 @@ public void start(RuleContext ctx) {
* the current context
*/
public void apply(List<? extends Node> acuList, RuleContext ctx) {
- long start = System.nanoTime();
- for (Rule rule : rules) {
- try {
- if (!rule.usesRuleChain() && applies(rule, ctx.getLanguageVersion())) {
- rule.apply(acuList, ctx);
- long end = System.nanoTime();
- Benchmarker.mark(Benchmark.Rule, rule.getName(), end - start, 1);
- start = end;
- }
- } catch (RuntimeException e) {
- if (ctx.isIgnoreExceptions()) {
- if (LOG.isLoggable(Level.WARNING)) {
- LOG.log(Level.WARNING, "Exception applying rule " + rule.getName() + " on file "
- + ctx.getSourceCodeFilename() + ", continuing with next rule", e);
+ try (TimedOperation to = TimeTracker.startOperation(TimedOperationCategory.RULE)) {
+ for (Rule rule : rules) {
+ if (!rule.isRuleChain() && applies(rule, ctx.getLanguageVersion())) {
+
+ try (TimedOperation rto = TimeTracker.startOperation(TimedOperationCategory.RULE, rule.getName())) {
+ rule.apply(acuList, ctx);
+ } catch (RuntimeException e) {
+ if (ctx.isIgnoreExceptions()) {
+ ctx.getReport().addError(new Report.ProcessingError(e, ctx.getSourceCodeFilename()));
+
+ if (LOG.isLoggable(Level.WARNING)) {
+ LOG.log(Level.WARNING, "Exception applying rule " + rule.getName() + " on file "
+ + ctx.getSourceCodeFilename() + ", continuing with next rule", e);
+ }
+ } else {
+ throw e;
+ }
}
- } else {
- throw e;
}
}
}
@@ -580,7 +606,7 @@ public List<String> getIncludePatterns() {
*/
public boolean usesDFA(Language language) {
for (Rule r : rules) {
- if (r.getLanguage().equals(language) && r.usesDFA()) {
+ if (r.getLanguage().equals(language) && r.isDfa()) {
return true;
}
}
@@ -597,23 +623,26 @@ public boolean usesDFA(Language language) {
*/
public boolean usesTypeResolution(Language language) {
for (Rule r : rules) {
- if (r.getLanguage().equals(language) && r.usesTypeResolution()) {
+ if (r.getLanguage().equals(language) && r.isTypeResolution()) {
return true;
}
}
return false;
}
+
/**
- * Does any Rule for the given Language use the Metrics Framework?
+ * Does any Rule for the given Language use multi-file analysis?
+ *
+ * @param language
+ * The Language.
*
- * @param language The Language.
- * @return <code>true</code> if a Rule for the Language uses the Metrics
- * Framework, <code>false</code> otherwise.
+ * @return {@code true} if a Rule for the Language uses multi file analysis,
+ * {@code false} otherwise.
*/
- public boolean usesMetrics(Language language) {
+ public boolean usesMultifile(Language language) {
for (Rule r : rules) {
- if (r.getLanguage().equals(language) && r.usesMetrics()) {
+ if (r.getLanguage().equals(language) && r.isMultifile()) {
return true;
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/RuleSetFactory.java b/pmd-core/src/main/java/net/sourceforge/pmd/RuleSetFactory.java
index 70fac15de70..ec47ae5a545 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/RuleSetFactory.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/RuleSetFactory.java
@@ -4,17 +4,13 @@
package net.sourceforge.pmd;
-import static net.sourceforge.pmd.properties.PropertyDescriptorField.DEFAULT_VALUE;
-
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Collection;
-import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
-import java.util.Map;
import java.util.Properties;
import java.util.Set;
import java.util.logging.Level;
@@ -36,22 +32,17 @@
import net.sourceforge.pmd.RuleSet.RuleSetBuilder;
import net.sourceforge.pmd.lang.Language;
import net.sourceforge.pmd.lang.LanguageRegistry;
-import net.sourceforge.pmd.lang.LanguageVersion;
import net.sourceforge.pmd.lang.rule.MockRule;
import net.sourceforge.pmd.lang.rule.RuleReference;
import net.sourceforge.pmd.lang.rule.XPathRule;
-import net.sourceforge.pmd.properties.AbstractPropertyDescriptorFactory;
-import net.sourceforge.pmd.properties.PropertyDescriptor;
-import net.sourceforge.pmd.properties.PropertyDescriptorFactory;
-import net.sourceforge.pmd.properties.PropertyDescriptorField;
-import net.sourceforge.pmd.properties.PropertyDescriptorUtil;
+import net.sourceforge.pmd.rules.RuleFactory;
import net.sourceforge.pmd.util.ResourceLoader;
/**
* RuleSetFactory is responsible for creating RuleSet instances from XML
- * content. By default Rules will be loaded using the ClassLoader for this
- * class, using the {@link RulePriority#LOW} priority, with Rule deprecation
- * warnings off. By default, the ruleset compatibility filter is active, too.
+ * content. By default Rules will be loaded using the {@link RulePriority#LOW} priority,
+ * with Rule deprecation warnings off.
+ * By default, the ruleset compatibility filter is active, too.
* See {@link RuleSetFactoryCompatibility}.
*/
public class RuleSetFactory {
@@ -61,22 +52,29 @@ public class RuleSetFactory {
private static final String DESCRIPTION = "description";
private static final String UNEXPECTED_ELEMENT = "Unexpected element <";
private static final String PRIORITY = "priority";
- private static final String FOR_RULE = "' for Rule ";
- private static final String MESSAGE = "message";
- private static final String EXTERNAL_INFO_URL = "externalInfoUrl";
- private final ClassLoader classLoader;
+ private final ResourceLoader resourceLoader;
private final RulePriority minimumPriority;
private final boolean warnDeprecated;
private final RuleSetFactoryCompatibility compatibilityFilter;
public RuleSetFactory() {
- this(RuleSetFactory.class.getClassLoader(), RulePriority.LOW, false, true);
+ this(new ResourceLoader(), RulePriority.LOW, false, true);
}
+ /**
+ * @deprecated Use {@link #RuleSetFactory(ResourceLoader, RulePriority, boolean, boolean)} with
+ * {@link ResourceLoader} instead of a {@link ClassLoader}.
+ */
+ @Deprecated // to be removed with PMD 7.0.0.
public RuleSetFactory(final ClassLoader classLoader, final RulePriority minimumPriority,
final boolean warnDeprecated, final boolean enableCompatibility) {
- this.classLoader = classLoader;
+ this(new ResourceLoader(classLoader), minimumPriority, warnDeprecated, enableCompatibility);
+ }
+
+ public RuleSetFactory(final ResourceLoader resourceLoader, final RulePriority minimumPriority,
+ final boolean warnDeprecated, final boolean enableCompatibility) {
+ this.resourceLoader = resourceLoader;
this.minimumPriority = minimumPriority;
this.warnDeprecated = warnDeprecated;
@@ -97,7 +95,7 @@ public RuleSetFactory(final ClassLoader classLoader, final RulePriority minimumP
* factory.
*/
public RuleSetFactory(final RuleSetFactory factory, final boolean warnDeprecated) {
- this(factory.classLoader, factory.minimumPriority, warnDeprecated, factory.compatibilityFilter != null);
+ this(factory.resourceLoader, factory.minimumPriority, warnDeprecated, factory.compatibilityFilter != null);
}
/**
@@ -112,7 +110,7 @@ public RuleSetFactory(final RuleSetFactory factory, final boolean warnDeprecated
/**
* Returns an Iterator of RuleSet objects loaded from descriptions from the
- * "rulesets.properties" resource for each Language with Rule support.
+ * "categories.properties" resource for each Language with Rule support.
*
* @return An Iterator of RuleSet objects.
*
@@ -124,8 +122,8 @@ public Iterator<RuleSet> getRegisteredRuleSets() throws RuleSetNotFoundException
List<RuleSetReferenceId> ruleSetReferenceIds = new ArrayList<>();
for (Language language : LanguageRegistry.findWithRuleSupport()) {
Properties props = new Properties();
- rulesetsProperties = "rulesets/" + language.getTerseName() + "/rulesets.properties";
- try (InputStream inputStream = ResourceLoader.loadResourceAsStream(rulesetsProperties);) {
+ rulesetsProperties = "category/" + language.getTerseName() + "/categories.properties";
+ try (InputStream inputStream = resourceLoader.loadClassPathResourceAsStreamOrThrow(rulesetsProperties)) {
props.load(inputStream);
}
String rulesetFilenames = props.getProperty("rulesets.filenames");
@@ -134,7 +132,7 @@ public Iterator<RuleSet> getRegisteredRuleSets() throws RuleSetNotFoundException
return createRuleSets(ruleSetReferenceIds).getRuleSetsIterator();
} catch (IOException ioe) {
throw new RuntimeException("Couldn't find " + rulesetsProperties
- + "; please ensure that the rulesets directory is on the classpath. The current classpath is: "
+ + "; please ensure that the directory is on the classpath. The current classpath is: "
+ System.getProperty("java.class.path"));
}
}
@@ -143,7 +141,7 @@ public Iterator<RuleSet> getRegisteredRuleSets() throws RuleSetNotFoundException
* Create a RuleSets from a comma separated list of RuleSet reference IDs.
* This is a convenience method which calls
* {@link RuleSetReferenceId#parse(String)}, and then calls
- * {@link #createRuleSets(List)}. The currently configured ClassLoader is
+ * {@link #createRuleSets(List)}. The currently configured ResourceLoader is
* used.
*
* @param referenceString
@@ -158,7 +156,7 @@ public RuleSets createRuleSets(String referenceString) throws RuleSetNotFoundExc
/**
* Create a RuleSets from a list of RuleSetReferenceIds. The currently
- * configured ClassLoader is used.
+ * configured ResourceLoader is used.
*
* @param ruleSetReferenceIds
* The List of RuleSetReferenceId of the RuleSets to create.
@@ -180,7 +178,7 @@ public RuleSets createRuleSets(List<RuleSetReferenceId> ruleSetReferenceIds) thr
* convenience method which calls {@link RuleSetReferenceId#parse(String)},
* gets the first item in the List, and then calls
* {@link #createRuleSet(RuleSetReferenceId)}. The currently configured
- * ClassLoader is used.
+ * ResourceLoader is used.
*
* @param referenceString
* A comma separated list of RuleSet reference IDs.
@@ -192,14 +190,14 @@ public RuleSet createRuleSet(String referenceString) throws RuleSetNotFoundExcep
List<RuleSetReferenceId> references = RuleSetReferenceId.parse(referenceString);
if (references.isEmpty()) {
throw new RuleSetNotFoundException(
- "No RuleSetReferenceId can be parsed from the string: <" + referenceString + ">");
+ "No RuleSetReferenceId can be parsed from the string: <" + referenceString + '>');
}
return createRuleSet(references.get(0));
}
/**
* Create a RuleSet from a RuleSetReferenceId. Priority filtering is ignored
- * when loading a single Rule. The currently configured ClassLoader is used.
+ * when loading a single Rule. The currently configured ResourceLoader is used.
*
* @param ruleSetReferenceId
* The RuleSetReferenceId of the RuleSet to create.
@@ -291,7 +289,7 @@ public RuleSet createSingleRuleRuleSet(final Rule rule) {
/**
* Create a Rule from a RuleSet created from a file name resource. The
- * currently configured ClassLoader is used.
+ * currently configured ResourceLoader is used.
* <p>
* Any Rules in the RuleSet other than the one being created, are _not_
* created. Deprecated rules are _not_ ignored, so that they can be
@@ -329,7 +327,7 @@ private Rule createRule(RuleSetReferenceId ruleSetReferenceId, boolean withDepre
private RuleSet parseRuleSetNode(RuleSetReferenceId ruleSetReferenceId, boolean withDeprecatedRuleReferences)
throws RuleSetNotFoundException {
try (CheckedInputStream inputStream = new CheckedInputStream(
- ruleSetReferenceId.getInputStream(this.classLoader), new Adler32());) {
+ ruleSetReferenceId.getInputStream(resourceLoader), new Adler32());) {
if (!ruleSetReferenceId.isExternal()) {
throw new IllegalArgumentException(
"Cannot parse a RuleSet from a non-external reference: <" + ruleSetReferenceId + ">.");
@@ -379,6 +377,8 @@ private RuleSet parseRuleSetNode(RuleSetReferenceId ruleSetReferenceId, boolean
ruleSetBuilder.withDescription("Missing description");
}
+ ruleSetBuilder.filterRulesByPriority(minimumPriority);
+
return ruleSetBuilder.build();
} catch (ClassNotFoundException cnfe) {
return classNotFoundProblem(cnfe);
@@ -426,6 +426,7 @@ private DocumentBuilder createDocumentBuilder() throws ParserConfigurationExcept
dbf.setExpandEntityReferences(false);
} catch (final ParserConfigurationException e) {
// an unsupported feature... too bad, but won't fail execution due to this
+ LOG.log(Level.WARNING, "Ignored unsupported XML Parser Feature for parsing rulesets", e);
}
return dbf.newDocumentBuilder();
@@ -455,7 +456,7 @@ private void parseRuleNode(RuleSetReferenceId ruleSetReferenceId, RuleSetBuilder
Element ruleElement = (Element) ruleNode;
String ref = ruleElement.getAttribute("ref");
if (ref.endsWith("xml")) {
- parseRuleSetReferenceNode(ruleSetReferenceId, ruleSetBuilder, ruleElement, ref);
+ parseRuleSetReferenceNode(ruleSetBuilder, ruleElement, ref);
} else if (StringUtils.isBlank(ref)) {
parseSingleRuleNode(ruleSetReferenceId, ruleSetBuilder, ruleNode);
} else {
@@ -469,8 +470,6 @@ private void parseRuleNode(RuleSetReferenceId ruleSetReferenceId, RuleSetBuilder
* explicitly excluded, below the minimum priority threshold for this
* RuleSetFactory, or which are deprecated.
*
- * @param ruleSetReferenceId
- * The RuleSetReferenceId of the RuleSet being parsed.
* @param ruleSetBuilder
* The RuleSet being constructed.
* @param ruleElement
@@ -478,8 +477,8 @@ private void parseRuleNode(RuleSetReferenceId ruleSetReferenceId, RuleSetBuilder
* @param ref
* The RuleSet reference.
*/
- private void parseRuleSetReferenceNode(RuleSetReferenceId ruleSetReferenceId, RuleSetBuilder ruleSetBuilder,
- Element ruleElement, String ref) throws RuleSetNotFoundException {
+ private void parseRuleSetReferenceNode(RuleSetBuilder ruleSetBuilder, Element ruleElement, String ref)
+ throws RuleSetNotFoundException {
String priority = null;
NodeList childNodes = ruleElement.getChildNodes();
Set<String> excludedRulesCheck = new HashSet<>();
@@ -495,22 +494,44 @@ private void parseRuleSetReferenceNode(RuleSetReferenceId ruleSetReferenceId, Ru
}
final RuleSetReference ruleSetReference = new RuleSetReference(ref, true, excludedRulesCheck);
- RuleSetFactory ruleSetFactory = new RuleSetFactory(this, warnDeprecated);
+ // load the ruleset with minimum priority low, so that we get all rules, to be able to exclude any rule
+ // minimum priority will be applied again, before constructing the final ruleset
+ RuleSetFactory ruleSetFactory = new RuleSetFactory(resourceLoader, RulePriority.LOW, warnDeprecated, this.compatibilityFilter != null);
RuleSet otherRuleSet = ruleSetFactory.createRuleSet(RuleSetReferenceId.parse(ref).get(0));
+ List<RuleReference> potentialRules = new ArrayList<>();
+ int countDeprecated = 0;
for (Rule rule : otherRuleSet.getRules()) {
excludedRulesCheck.remove(rule.getName());
- if (!ruleSetReference.getExcludes().contains(rule.getName()) && !rule.isDeprecated()) {
- RuleReference ruleReference = new RuleReference();
- ruleReference.setRuleSetReference(ruleSetReference);
- ruleReference.setRule(rule);
- ruleSetBuilder.addRuleIfNotExists(ruleReference);
-
+ if (!ruleSetReference.getExcludes().contains(rule.getName())) {
+ RuleReference ruleReference = new RuleReference(rule, ruleSetReference);
// override the priority
if (priority != null) {
ruleReference.setPriority(RulePriority.valueOf(Integer.parseInt(priority)));
}
+
+ if (rule.isDeprecated()) {
+ countDeprecated++;
+ }
+ potentialRules.add(ruleReference);
}
}
+
+ boolean rulesetDeprecated = false;
+ if (!potentialRules.isEmpty() && potentialRules.size() == countDeprecated) {
+ // all rules in the ruleset have been deprecated - the ruleset itself is considered to be deprecated
+ rulesetDeprecated = true;
+ LOG.warning("The RuleSet " + ref + " has been deprecated and will be removed in PMD " + PMDVersion.getNextMajorRelease());
+ }
+
+ for (RuleReference r : potentialRules) {
+ if (rulesetDeprecated || !r.getRule().isDeprecated()) {
+ // add the rule, if either the ruleset itself is deprecated (then we add all rules)
+ // or if the rule is not deprecated (in that case, the ruleset might contain deprecated as well
+ // as valid references to rules)
+ ruleSetBuilder.addRuleIfNotExists(r);
+ }
+ }
+
if (!excludedRulesCheck.isEmpty()) {
throw new IllegalArgumentException(
"Unable to exclude rules " + excludedRulesCheck + "; perhaps the rule name is mispelled?");
@@ -538,117 +559,12 @@ private void parseSingleRuleNode(RuleSetReferenceId ruleSetReferenceId, RuleSetB
&& !isRuleName(ruleElement, ruleSetReferenceId.getRuleName())) {
return;
}
-
- String attribute = ruleElement.getAttribute("class");
- if (attribute == null || "".equals(attribute)) {
- throw new IllegalArgumentException("The 'class' field of rule can't be null, nor empty.");
- }
- Rule rule = (Rule) classLoader.loadClass(attribute).newInstance();
- rule.setName(ruleElement.getAttribute("name"));
-
- if (ruleElement.hasAttribute("language")) {
- String languageName = ruleElement.getAttribute("language");
- Language language = LanguageRegistry.findLanguageByTerseName(languageName);
- if (language == null) {
- throw new IllegalArgumentException("Unknown Language '" + languageName + FOR_RULE + rule.getName()
- + ", supported Languages are "
- + LanguageRegistry.commaSeparatedTerseNamesForLanguage(LanguageRegistry.findWithRuleSupport()));
- }
- rule.setLanguage(language);
- }
-
- Language language = rule.getLanguage();
- if (language == null) {
- throw new IllegalArgumentException(
- "Rule " + rule.getName() + " does not have a Language; missing 'language' attribute?");
- }
-
- if (ruleElement.hasAttribute("minimumLanguageVersion")) {
- String minimumLanguageVersionName = ruleElement.getAttribute("minimumLanguageVersion");
- LanguageVersion minimumLanguageVersion = language.getVersion(minimumLanguageVersionName);
- if (minimumLanguageVersion == null) {
- throw new IllegalArgumentException("Unknown minimum Language Version '" + minimumLanguageVersionName
- + "' for Language '" + language.getTerseName() + FOR_RULE + rule.getName()
- + "; supported Language Versions are: "
- + LanguageRegistry.commaSeparatedTerseNamesForLanguageVersion(language.getVersions()));
- }
- rule.setMinimumLanguageVersion(minimumLanguageVersion);
- }
-
- if (ruleElement.hasAttribute("maximumLanguageVersion")) {
- String maximumLanguageVersionName = ruleElement.getAttribute("maximumLanguageVersion");
- LanguageVersion maximumLanguageVersion = language.getVersion(maximumLanguageVersionName);
- if (maximumLanguageVersion == null) {
- throw new IllegalArgumentException("Unknown maximum Language Version '" + maximumLanguageVersionName
- + "' for Language '" + language.getTerseName() + FOR_RULE + rule.getName()
- + "; supported Language Versions are: "
- + LanguageRegistry.commaSeparatedTerseNamesForLanguageVersion(language.getVersions()));
- }
- rule.setMaximumLanguageVersion(maximumLanguageVersion);
- }
-
- if (rule.getMinimumLanguageVersion() != null && rule.getMaximumLanguageVersion() != null) {
- throw new IllegalArgumentException(
- "The minimum Language Version '" + rule.getMinimumLanguageVersion().getTerseName()
- + "' must be prior to the maximum Language Version '"
- + rule.getMaximumLanguageVersion().getTerseName() + FOR_RULE + rule.getName()
- + "; perhaps swap them around?");
- }
-
- String since = ruleElement.getAttribute("since");
- if (StringUtils.isNotBlank(since)) {
- rule.setSince(since);
- }
- rule.setMessage(ruleElement.getAttribute(MESSAGE));
+ Rule rule = new RuleFactory().buildRule(ruleElement);
rule.setRuleSetName(ruleSetBuilder.getName());
- rule.setExternalInfoUrl(ruleElement.getAttribute(EXTERNAL_INFO_URL));
-
- if (hasAttributeSetTrue(ruleElement, "deprecated")) {
- rule.setDeprecated(true);
- }
-
- if (hasAttributeSetTrue(ruleElement, "dfa")) {
- rule.setUsesDFA();
- }
- if (hasAttributeSetTrue(ruleElement, "typeResolution")) {
- rule.setUsesTypeResolution();
- }
-
- if (hasAttributeSetTrue(ruleElement, "metrics")) {
- rule.setUsesMetrics();
- }
-
- final NodeList nodeList = ruleElement.getChildNodes();
- for (int i = 0; i < nodeList.getLength(); i++) {
- Node node = nodeList.item(i);
- if (node.getNodeType() != Node.ELEMENT_NODE) {
- continue;
- }
- String nodeName = node.getNodeName();
- if (DESCRIPTION.equals(nodeName)) {
- rule.setDescription(parseTextNode(node));
- } else if ("example".equals(nodeName)) {
- rule.addExample(parseTextNode(node));
- } else if (PRIORITY.equals(nodeName)) {
- rule.setPriority(RulePriority.valueOf(Integer.parseInt(parseTextNode(node).trim())));
- } else if ("properties".equals(nodeName)) {
- parsePropertiesNode(rule, node);
- } else {
- throw new IllegalArgumentException(UNEXPECTED_ELEMENT + nodeName
- + "> encountered as child of <rule> element for Rule " + rule.getName());
- }
-
- }
- if (StringUtils.isNotBlank(ruleSetReferenceId.getRuleName())
- || rule.getPriority().compareTo(minimumPriority) <= 0) {
- ruleSetBuilder.addRule(rule);
- }
+ ruleSetBuilder.addRule(rule);
}
- private static boolean hasAttributeSetTrue(Element element, String attributeId) {
- return element.hasAttribute(attributeId) && "true".equalsIgnoreCase(element.getAttribute(attributeId));
- }
/**
* Parse a rule node as a RuleReference. A RuleReference is a single Rule
@@ -678,7 +594,9 @@ private void parseRuleReferenceNode(RuleSetReferenceId ruleSetReferenceId, RuleS
return;
}
- RuleSetFactory ruleSetFactory = new RuleSetFactory(this, warnDeprecated);
+ // load the ruleset with minimum priority low, so that we get all rules, to be able to exclude any rule
+ // minimum priority will be applied again, before constructing the final ruleset
+ RuleSetFactory ruleSetFactory = new RuleSetFactory(resourceLoader, RulePriority.LOW, warnDeprecated, this.compatibilityFilter != null);
boolean isSameRuleSet = false;
RuleSetReferenceId otherRuleSetReferenceId = RuleSetReferenceId.parse(ref).get(0);
@@ -699,67 +617,45 @@ && containsRule(ruleSetReferenceId, otherRuleSetReferenceId.getRuleName())) {
if (referencedRule instanceof RuleReference) {
RuleReference ruleReference = (RuleReference) referencedRule;
if (LOG.isLoggable(Level.WARNING)) {
- LOG.warning("Use Rule name " + ruleReference.getRuleSetReference().getRuleSetFileName() + "/"
+ LOG.warning("Use Rule name " + ruleReference.getRuleSetReference().getRuleSetFileName() + '/'
+ ruleReference.getOriginalName() + " instead of the deprecated Rule name "
+ otherRuleSetReferenceId
- + ". Future versions of PMD will remove support for this deprecated Rule name usage.");
+ + ". PMD " + PMDVersion.getNextMajorRelease()
+ + " will remove support for this deprecated Rule name usage.");
}
} else if (referencedRule instanceof MockRule) {
if (LOG.isLoggable(Level.WARNING)) {
LOG.warning("Discontinue using Rule name " + otherRuleSetReferenceId
+ " as it has been removed from PMD and no longer functions."
- + " Future versions of PMD will remove support for this Rule.");
+ + " PMD " + PMDVersion.getNextMajorRelease()
+ + " will remove support for this Rule.");
}
} else {
if (LOG.isLoggable(Level.WARNING)) {
LOG.warning("Discontinue using Rule name " + otherRuleSetReferenceId
+ " as it is scheduled for removal from PMD."
- + " Future versions of PMD will remove support for this Rule.");
+ + " PMD " + PMDVersion.getNextMajorRelease()
+ + " will remove support for this Rule.");
}
}
}
RuleSetReference ruleSetReference = new RuleSetReference(otherRuleSetReferenceId.getRuleSetFileName(), false);
- RuleReference ruleReference = new RuleReference();
- ruleReference.setRuleSetReference(ruleSetReference);
- ruleReference.setRule(referencedRule);
+ RuleReference ruleReference = new RuleFactory().decorateRule(referencedRule, ruleSetReference, ruleElement);
- if (ruleElement.hasAttribute("deprecated")) {
- ruleReference.setDeprecated(Boolean.parseBoolean(ruleElement.getAttribute("deprecated")));
- }
- if (ruleElement.hasAttribute("name")) {
- ruleReference.setName(ruleElement.getAttribute("name"));
- }
- if (ruleElement.hasAttribute(MESSAGE)) {
- ruleReference.setMessage(ruleElement.getAttribute(MESSAGE));
- }
- if (ruleElement.hasAttribute(EXTERNAL_INFO_URL)) {
- ruleReference.setExternalInfoUrl(ruleElement.getAttribute(EXTERNAL_INFO_URL));
- }
- for (int i = 0; i < ruleElement.getChildNodes().getLength(); i++) {
- Node node = ruleElement.getChildNodes().item(i);
- if (node.getNodeType() == Node.ELEMENT_NODE) {
- if (node.getNodeName().equals(DESCRIPTION)) {
- ruleReference.setDescription(parseTextNode(node));
- } else if (node.getNodeName().equals("example")) {
- ruleReference.addExample(parseTextNode(node));
- } else if (node.getNodeName().equals(PRIORITY)) {
- ruleReference.setPriority(RulePriority.valueOf(Integer.parseInt(parseTextNode(node))));
- } else if (node.getNodeName().equals("properties")) {
- parsePropertiesNode(ruleReference, node);
- } else {
- throw new IllegalArgumentException(UNEXPECTED_ELEMENT + node.getNodeName()
- + "> encountered as child of <rule> element for Rule " + ruleReference.getName());
- }
+ if (warnDeprecated && ruleReference.isDeprecated()) {
+ if (LOG.isLoggable(Level.WARNING)) {
+ LOG.warning("Use Rule name " + ruleReference.getRuleSetReference().getRuleSetFileName() + '/'
+ + ruleReference.getOriginalName() + " instead of the deprecated Rule name "
+ + ruleSetReferenceId.getRuleSetFileName() + '/' + ruleReference.getName()
+ + ". PMD " + PMDVersion.getNextMajorRelease()
+ + " will remove support for this deprecated Rule name usage.");
}
}
- if (StringUtils.isNotBlank(ruleSetReferenceId.getRuleName())
- || referencedRule.getPriority().compareTo(minimumPriority) <= 0) {
- if (withDeprecatedRuleReferences || !isSameRuleSet || !ruleReference.isDeprecated()) {
- ruleSetBuilder.addRuleReplaceIfExists(ruleReference);
- }
+ if (withDeprecatedRuleReferences || !isSameRuleSet || !ruleReference.isDeprecated()) {
+ ruleSetBuilder.addRuleReplaceIfExists(ruleReference);
}
}
@@ -774,7 +670,7 @@ && containsRule(ruleSetReferenceId, otherRuleSetReferenceId.getRuleName())) {
*/
private boolean containsRule(RuleSetReferenceId ruleSetReferenceId, String ruleName) {
boolean found = false;
- try (InputStream ruleSet = ruleSetReferenceId.getInputStream(classLoader)) {
+ try (InputStream ruleSet = ruleSetReferenceId.getInputStream(resourceLoader)) {
DocumentBuilder builder = createDocumentBuilder();
Document document = builder.parse(ruleSet);
Element ruleSetElement = document.getDocumentElement();
@@ -798,112 +694,6 @@ private static boolean isElementNode(Node node, String name) {
return node.getNodeType() == Node.ELEMENT_NODE && node.getNodeName().equals(name);
}
- /**
- * Parse a properties node.
- *
- * @param rule
- * The Rule to which the properties should be added.
- * @param propertiesNode
- * Must be a properties element node.
- */
- private static void parsePropertiesNode(Rule rule, Node propertiesNode) {
- for (int i = 0; i < propertiesNode.getChildNodes().getLength(); i++) {
- Node node = propertiesNode.getChildNodes().item(i);
- if (isElementNode(node, "property")) {
- parsePropertyNodeBR(rule, node);
- }
- }
- }
-
- private static String valueFrom(Node parentNode) {
-
- final NodeList nodeList = parentNode.getChildNodes();
-
- for (int i = 0; i < nodeList.getLength(); i++) {
- Node node = nodeList.item(i);
- if (isElementNode(node, "value")) {
- return parseTextNode(node);
- }
- }
- return null;
- }
-
-
- /**
- * Sets the value of a property.
- *
- * @param rule The rule which has the property
- * @param desc The property descriptor
- * @param strValue The string value of the property, converted to a T
- * @param <T> The type of values of the property descriptor
- */
- private static <T> void setValue(Rule rule, PropertyDescriptor<T> desc, String strValue) {
- T realValue = desc.valueFrom(strValue);
- rule.setProperty(desc, realValue);
- }
-
-
- /**
- * Parse a property node.
- *
- * @param rule The Rule to which the property should be added.
- * @param propertyNode Must be a property element node.
- */
- private static void parsePropertyNodeBR(Rule rule, Node propertyNode) {
-
- Element propertyElement = (Element) propertyNode;
- String typeId = propertyElement.getAttribute(PropertyDescriptorField.TYPE.attributeName());
- String strValue = propertyElement.getAttribute(DEFAULT_VALUE.attributeName());
- if (StringUtils.isBlank(strValue)) {
- strValue = valueFrom(propertyElement);
- }
-
- // Setting of existing property, or defining a new property?
- if (StringUtils.isBlank(typeId)) {
- String name = propertyElement.getAttribute(PropertyDescriptorField.NAME.attributeName());
-
- PropertyDescriptor<?> propertyDescriptor = rule.getPropertyDescriptor(name);
- if (propertyDescriptor == null) {
- throw new IllegalArgumentException(
- "Cannot set non-existant property '" + name + "' on Rule " + rule.getName());
- } else {
- setValue(rule, propertyDescriptor, strValue);
- }
- return;
- }
-
- PropertyDescriptorFactory<?> pdFactory = PropertyDescriptorUtil.factoryFor(typeId);
- if (pdFactory == null) {
- throw new RuntimeException("No property descriptor factory for type: " + typeId);
- }
-
- Set<PropertyDescriptorField> valueKeys = pdFactory.expectableFields();
- Map<PropertyDescriptorField, String> values = new HashMap<>(valueKeys.size());
-
- // populate a map of values for an individual descriptor
- for (PropertyDescriptorField field : valueKeys) {
- String valueStr = propertyElement.getAttribute(field.attributeName());
- if (valueStr != null) {
- values.put(field, valueStr);
- }
- }
-
- if (StringUtils.isBlank(values.get(DEFAULT_VALUE))) {
- NodeList children = propertyElement.getElementsByTagName(DEFAULT_VALUE.attributeName());
- if (children.getLength() == 1) {
- values.put(DEFAULT_VALUE, children.item(0).getTextContent());
- } else {
- throw new RuntimeException("No value defined!");
- }
- }
-
- // casting is not pretty but prevents the interface from having this method
- PropertyDescriptor<?> desc = ((AbstractPropertyDescriptorFactory<?>) pdFactory).createExternalWith(values);
-
- rule.definePropertyDescriptor(desc);
- setValue(rule, desc, strValue);
- }
-
/**
* Parse a String from a textually type node.
*
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/RuleSetFactoryCompatibility.java b/pmd-core/src/main/java/net/sourceforge/pmd/RuleSetFactoryCompatibility.java
index af39be8cf4b..c16057024d2 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/RuleSetFactoryCompatibility.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/RuleSetFactoryCompatibility.java
@@ -71,7 +71,17 @@ public RuleSetFactoryCompatibility() {
// PMD 6.0.0
addFilterRuleMoved("java", "controversial", "unnecessary", "UnnecessaryParentheses");
addFilterRuleRenamed("java", "unnecessary", "UnnecessaryParentheses", "UselessParentheses");
-
+ addFilterRuleMoved("java", "typeresolution", "coupling", "LooseCoupling");
+ addFilterRuleMoved("java", "typeresolution", "clone", "CloneMethodMustImplementCloneable");
+ addFilterRuleMoved("java", "typeresolution", "imports", "UnusedImports");
+ addFilterRuleMoved("java", "typeresolution", "strictexception", "SignatureDeclareThrowsException");
+ addFilterRuleRenamed("java", "naming", "MisleadingVariableName", "MIsLeadingVariableName");
+ addFilterRuleRenamed("java", "unnecessary", "UnnecessaryFinalModifier", "UnnecessaryModifier");
+ addFilterRuleRenamed("java", "empty", "EmptyStaticInitializer", "EmptyInitializer");
+ // GuardLogStatementJavaUtil moved and renamed...
+ addFilterRuleMoved("java", "logging-java", "logging-jakarta-commons", "GuardLogStatementJavaUtil");
+ addFilterRuleRenamed("java", "logging-jakarta-commons", "GuardLogStatementJavaUtil", "GuardLogStatement");
+ addFilterRuleRenamed("java", "logging-jakarta-commons", "GuardDebugLogging", "GuardLogStatement");
}
void addFilterRuleRenamed(String language, String ruleset, String oldName, String newName) {
@@ -105,8 +115,8 @@ public Reader filterRuleSetFile(InputStream stream) throws IOException {
return new StringReader(ruleset);
}
- private String applyAllFilters(String in) {
- String result = in;
+ private String applyAllFilters(String ruleset) {
+ String result = ruleset;
for (RuleSetFilter filter : filters) {
result = filter.apply(result);
}
@@ -184,9 +194,9 @@ public static RuleSetFilter ruleRemoved(String language, String ruleset, String
return filter;
}
- String apply(String in) {
- String result = in;
- Matcher matcher = refPattern.matcher(in);
+ String apply(String ruleset) {
+ String result = ruleset;
+ Matcher matcher = refPattern.matcher(ruleset);
if (matcher.find()) {
result = matcher.replaceAll(replacement);
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/RuleSetReferenceId.java b/pmd-core/src/main/java/net/sourceforge/pmd/RuleSetReferenceId.java
index 74a685de99f..e5ee6c47cce 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/RuleSetReferenceId.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/RuleSetReferenceId.java
@@ -12,7 +12,6 @@
import java.util.ArrayList;
import java.util.List;
-import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.StringUtils;
import net.sourceforge.pmd.util.ResourceLoader;
@@ -199,7 +198,7 @@ public RuleSetReferenceId(final String id, final RuleSetReferenceId externalRule
ruleName = null;
allRules = true;
} else {
- external = externalRuleSetReferenceId != null ? externalRuleSetReferenceId.isExternal() : false;
+ external = externalRuleSetReferenceId != null && externalRuleSetReferenceId.isExternal();
ruleSetFileName = externalRuleSetReferenceId != null
? externalRuleSetReferenceId.getRuleSetFileName() : null;
ruleName = id;
@@ -224,18 +223,13 @@ public RuleSetReferenceId(final String id, final RuleSetReferenceId externalRule
* @return <code>true</code> if the ruleset could be loaded,
* <code>false</code> otherwise.
*/
- private boolean checkRulesetExists(String name) {
+ private boolean checkRulesetExists(final String name) {
boolean resourceFound = false;
if (name != null) {
- try {
- InputStream resource = ResourceLoader.loadResourceAsStream(name,
- RuleSetReferenceId.class.getClassLoader());
- if (resource != null) {
- resourceFound = true;
- IOUtils.closeQuietly(resource);
- }
- } catch (RuleSetNotFoundException e) {
- resourceFound = false;
+ try (InputStream resource = new ResourceLoader().loadClassPathResourceAsStreamOrThrow(name)) {
+ resourceFound = true;
+ } catch (Exception ignored) {
+ // ignored
}
}
return resourceFound;
@@ -257,7 +251,7 @@ private String resolveBuiltInRuleset(final String name) {
int index = name.indexOf('-');
if (index >= 0) {
// Standard short name
- result = "rulesets/" + name.substring(0, index) + "/" + name.substring(index + 1) + ".xml";
+ result = "rulesets/" + name.substring(0, index) + '/' + name.substring(index + 1) + ".xml";
} else {
// A release RuleSet?
if (name.matches("[0-9]+.*")) {
@@ -299,17 +293,14 @@ private static boolean isHttpUrl(String name) {
return false;
}
- if (stripped.startsWith("http://") || stripped.startsWith("https://")) {
- return true;
- }
-
- return false;
+ return stripped.startsWith("http://") || stripped.startsWith("https://");
}
private static boolean isValidUrl(String name) {
if (isHttpUrl(name)) {
String url = StringUtils.strip(name);
try {
+ // FIXME : Do we really need to perform a request? if it's a url we should treat it as one even if the server is down
HttpURLConnection connection = (HttpURLConnection) new URL(url).openConnection();
connection.setRequestMethod("HEAD");
connection.setConnectTimeout(ResourceLoader.TIMEOUT);
@@ -393,22 +384,21 @@ public String getRuleName() {
}
/**
- * Try to load the RuleSet resource with the specified ClassLoader. Multiple
+ * Try to load the RuleSet resource with the specified ResourceLoader. Multiple
* attempts to get independent InputStream instances may be made, so
* subclasses must ensure they support this behavior. Delegates to an
* external RuleSetReferenceId if there is one associated with this
* instance.
*
- * @param classLoader
- * The ClassLoader to use.
+ * @param rl The {@link ResourceLoader} to use.
* @return An InputStream to that resource.
* @throws RuleSetNotFoundException
* if unable to find a resource.
*/
- public InputStream getInputStream(ClassLoader classLoader) throws RuleSetNotFoundException {
+ public InputStream getInputStream(final ResourceLoader rl) throws RuleSetNotFoundException {
if (externalRuleSetReferenceId == null) {
InputStream in = StringUtils.isBlank(ruleSetFileName) ? null
- : ResourceLoader.loadResourceAsStream(ruleSetFileName, classLoader);
+ : rl.loadResourceAsStream(ruleSetFileName);
if (in == null) {
throw new RuleSetNotFoundException("Can't find resource '" + ruleSetFileName + "' for rule '" + ruleName
+ "'" + ". Make sure the resource is a valid file or URL and is on the CLASSPATH. "
@@ -416,7 +406,7 @@ public InputStream getInputStream(ClassLoader classLoader) throws RuleSetNotFoun
}
return in;
} else {
- return externalRuleSetReferenceId.getInputStream(classLoader);
+ return externalRuleSetReferenceId.getInputStream(rl);
}
}
@@ -434,7 +424,7 @@ public String toString() {
if (allRules) {
return ruleSetFileName;
} else {
- return ruleSetFileName + "/" + ruleName;
+ return ruleSetFileName + '/' + ruleName;
}
} else {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/RuleSetWriter.java b/pmd-core/src/main/java/net/sourceforge/pmd/RuleSetWriter.java
index deae16d873c..70f6f23b41b 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/RuleSetWriter.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/RuleSetWriter.java
@@ -9,6 +9,8 @@
import java.util.List;
import java.util.Map;
import java.util.Set;
+import java.util.logging.Level;
+import java.util.logging.Logger;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.FactoryConfigurationError;
@@ -34,21 +36,21 @@
import net.sourceforge.pmd.lang.rule.XPathRule;
import net.sourceforge.pmd.properties.PropertyDescriptor;
import net.sourceforge.pmd.properties.PropertyDescriptorField;
-import net.sourceforge.pmd.properties.PropertyDescriptorUtil;
+import net.sourceforge.pmd.properties.PropertyTypeId;
/**
* This class represents a way to serialize a RuleSet to an XML configuration
* file.
*/
public class RuleSetWriter {
+ private static final Logger LOG = Logger.getLogger(RuleSetWriter.class.getName());
public static final String RULESET_2_0_0_NS_URI = "http://pmd.sourceforge.net/ruleset/2.0.0";
- public static final String RULESET_3_0_0_NS_URI = "http://pmd.sourceforge.net/ruleset/3.0.0";
/**
* @deprecated use {@link #RULESET_2_0_0_NS_URI} instead
*/
- @Deprecated
+ @Deprecated // To be removed in PMD 7.0.0
public static final String RULESET_NS_URI = RULESET_2_0_0_NS_URI;
private final OutputStream outputStream;
@@ -79,6 +81,7 @@ public void write(RuleSet ruleSet) {
transformerFactory.setAttribute("indent-number", 3);
} catch (IllegalArgumentException iae) {
// ignore it, specific to one parser
+ LOG.log(Level.FINE, "Couldn't set indentation", iae);
}
Transformer transformer = transformerFactory.newTransformer();
transformer.setOutputProperty(OutputKeys.METHOD, "xml");
@@ -99,10 +102,10 @@ public void write(RuleSet ruleSet) {
}
private Element createRuleSetElement(RuleSet ruleSet) {
- Element ruleSetElement = document.createElementNS(RULESET_3_0_0_NS_URI, "ruleset");
+ Element ruleSetElement = document.createElementNS(RULESET_2_0_0_NS_URI, "ruleset");
ruleSetElement.setAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance");
ruleSetElement.setAttributeNS("http://www.w3.org/2001/XMLSchema-instance", "xsi:schemaLocation",
- RULESET_3_0_0_NS_URI + " http://pmd.sourceforge.net/ruleset_3_0_0.xsd");
+ RULESET_2_0_0_NS_URI + " https://pmd.sourceforge.io/ruleset_2_0_0.xsd");
ruleSetElement.setAttribute("name", ruleSet.getName());
Element descriptionElement = createDescriptionElement(ruleSet.getDescription());
@@ -139,11 +142,11 @@ private Element createIncludePatternElement(String includePattern) {
}
private Element createRuleElement() {
- return document.createElementNS(RULESET_3_0_0_NS_URI, "rule");
+ return document.createElementNS(RULESET_2_0_0_NS_URI, "rule");
}
private Element createExcludeElement(String exclude) {
- Element element = document.createElementNS(RULESET_3_0_0_NS_URI, "exclude");
+ Element element = document.createElementNS(RULESET_2_0_0_NS_URI, "exclude");
element.setAttribute("name", exclude);
return element;
}
@@ -157,7 +160,7 @@ private Element createPriorityElement(RulePriority priority) {
}
private Element createPropertiesElement() {
- return document.createElementNS(RULESET_3_0_0_NS_URI, "properties");
+ return document.createElementNS(RULESET_2_0_0_NS_URI, "properties");
}
private Element createRuleElement(Rule rule) {
@@ -167,8 +170,7 @@ private Element createRuleElement(Rule rule) {
if (ruleSetReference.isAllRules()) {
if (!ruleSetFileNames.contains(ruleSetReference.getRuleSetFileName())) {
ruleSetFileNames.add(ruleSetReference.getRuleSetFileName());
- Element ruleSetReferenceElement = createRuleSetReferenceElement(ruleSetReference);
- return ruleSetReferenceElement;
+ return createRuleSetReferenceElement(ruleSetReference);
} else {
return null;
}
@@ -178,7 +180,7 @@ private Element createRuleElement(Rule rule) {
LanguageVersion maximumLanguageVersion = ruleReference.getOverriddenMaximumLanguageVersion();
Boolean deprecated = ruleReference.isOverriddenDeprecated();
String name = ruleReference.getOverriddenName();
- String ref = ruleReference.getRuleSetReference().getRuleSetFileName() + "/"
+ String ref = ruleReference.getRuleSetReference().getRuleSetFileName() + '/'
+ ruleReference.getRule().getName();
String message = ruleReference.getOverriddenMessage();
String externalInfoUrl = ruleReference.getOverriddenExternalInfoUrl();
@@ -197,7 +199,7 @@ private Element createRuleElement(Rule rule) {
return createSingleRuleElement(rule instanceof ImmutableLanguage ? null : rule.getLanguage(),
rule.getMinimumLanguageVersion(), rule.getMaximumLanguageVersion(), rule.isDeprecated(),
rule.getName(), rule.getSince(), null, rule.getMessage(), rule.getExternalInfoUrl(),
- rule.getRuleClass(), rule.usesDFA(), rule.usesTypeResolution(), rule.usesMetrics(),
+ rule.getRuleClass(), rule.isDfa(), rule.isTypeResolution(), rule.isMultifile(),
rule.getDescription(),
rule.getPriority(), rule.getPropertyDescriptors(), rule.getPropertiesByPropertyDescriptor(),
rule.getExamples());
@@ -213,7 +215,7 @@ private void setIfNonNull(Object value, Element target, String id) {
private Element createSingleRuleElement(Language language, LanguageVersion minimumLanguageVersion,
LanguageVersion maximumLanguageVersion, Boolean deprecated, String name, String since, String ref,
String message, String externalInfoUrl, String clazz, Boolean dfa, Boolean typeResolution,
- Boolean metrics,
+ Boolean multifile, // NOPMD: TODO multifile
String description, RulePriority priority, List<PropertyDescriptor<?>> propertyDescriptors,
Map<PropertyDescriptor<?>, Object> propertiesByPropertyDescriptor, List<String> examples) {
Element ruleElement = createRuleElement();
@@ -236,7 +238,7 @@ private Element createSingleRuleElement(Language language, LanguageVersion minim
setIfNonNull(externalInfoUrl, ruleElement, "externalInfoUrl");
setIfNonNull(dfa, ruleElement, "dfa");
setIfNonNull(typeResolution, ruleElement, "typeResolution");
- setIfNonNull(metrics, ruleElement, "metrics");
+ //TODO multifile: setIfNonNull(multifile, ruleElement, "multifile");
if (description != null) {
Element descriptionElement = createDescriptionElement(description);
@@ -330,7 +332,7 @@ private Element createPropertiesElement(List<PropertyDescriptor<?>> propertyDesc
}
private Element createPropertyValueElement(PropertyDescriptor propertyDescriptor, Object value) {
- Element propertyElement = document.createElementNS(RULESET_3_0_0_NS_URI, "property");
+ Element propertyElement = document.createElementNS(RULESET_2_0_0_NS_URI, "property");
propertyElement.setAttribute("name", propertyDescriptor.name());
String valueString = propertyDescriptor.asDelimitedString(value);
if (XPathRule.XPATH_DESCRIPTOR.equals(propertyDescriptor)) {
@@ -349,7 +351,7 @@ private Element createPropertyDefinitionElementBR(PropertyDescriptor<?> property
final Element propertyElement = createPropertyValueElement(propertyDescriptor,
propertyDescriptor.defaultValue());
propertyElement.setAttribute(PropertyDescriptorField.TYPE.attributeName(),
- PropertyDescriptorUtil.typeIdFor(propertyDescriptor.type(),
+ PropertyTypeId.typeIdFor(propertyDescriptor.type(),
propertyDescriptor.isMultiValue()));
Map<PropertyDescriptorField, String> propertyValuesById = propertyDescriptor.attributeValuesById();
@@ -361,14 +363,14 @@ private Element createPropertyDefinitionElementBR(PropertyDescriptor<?> property
}
private Element createTextElement(String name, String value) {
- Element element = document.createElementNS(RULESET_3_0_0_NS_URI, name);
+ Element element = document.createElementNS(RULESET_2_0_0_NS_URI, name);
Text text = document.createTextNode(value);
element.appendChild(text);
return element;
}
private Element createCDATASectionElement(String name, String value) {
- Element element = document.createElementNS(RULESET_3_0_0_NS_URI, name);
+ Element element = document.createElementNS(RULESET_2_0_0_NS_URI, name);
CDATASection cdataSection = document.createCDATASection(value);
element.appendChild(cdataSection);
return element;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/RuleSets.java b/pmd-core/src/main/java/net/sourceforge/pmd/RuleSets.java
index c28f323a6ce..90168308586 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/RuleSets.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/RuleSets.java
@@ -35,8 +35,9 @@ public class RuleSets {
* Public constructor.
*/
public RuleSets() {
+ // default constructor
}
-
+
/**
* Copy constructor. Deep copies RuleSets.
* @param ruleSets The RuleSets to copy.
@@ -54,7 +55,6 @@ public RuleSets(final RuleSets ruleSets) {
* the RuleSet
*/
public RuleSets(RuleSet ruleSet) {
- this();
addRuleSet(ruleSet);
}
@@ -77,7 +77,7 @@ public void addRuleSet(RuleSet ruleSet) {
* @return RuleSet[]
*/
public RuleSet[] getAllRuleSets() {
- return ruleSets.toArray(new RuleSet[ruleSets.size()]);
+ return ruleSets.toArray(new RuleSet[0]);
}
public Iterator<RuleSet> getRuleSetsIterator() {
@@ -220,15 +220,17 @@ public boolean usesTypeResolution(Language language) {
}
/**
- * Does any Rule for the given Language use the Metrics Framework?
+ * Does any Rule for the given Language use multi-file analysis?
+ *
+ * @param language
+ * The Language.
*
- * @param language The Language.
- * @return <code>true</code> if a Rule for the Language uses the Metrics
- * Framework, <code>false</code> otherwise.
+ * @return {@code true} if a Rule for the Language uses multi file analysis,
+ * {@code false} otherwise.
*/
- public boolean usesMetrics(Language language) {
+ public boolean usesMultifile(Language language) {
for (RuleSet ruleSet : ruleSets) {
- if (ruleSet.usesMetrics(language)) {
+ if (ruleSet.usesMultifile(language)) {
return true;
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/RulesetsFactoryUtils.java b/pmd-core/src/main/java/net/sourceforge/pmd/RulesetsFactoryUtils.java
index 2b0857a8cca..e13384111a8 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/RulesetsFactoryUtils.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/RulesetsFactoryUtils.java
@@ -7,8 +7,10 @@
import java.util.logging.Level;
import java.util.logging.Logger;
-import net.sourceforge.pmd.benchmark.Benchmark;
-import net.sourceforge.pmd.benchmark.Benchmarker;
+import net.sourceforge.pmd.benchmark.TimeTracker;
+import net.sourceforge.pmd.benchmark.TimedOperation;
+import net.sourceforge.pmd.benchmark.TimedOperationCategory;
+import net.sourceforge.pmd.util.ResourceLoader;
public final class RulesetsFactoryUtils {
@@ -36,7 +38,7 @@ public static RuleSets getRuleSets(String rulesets, RuleSetFactory factory) {
ruleSets = factory.createRuleSets(rulesets);
printRuleNamesInDebug(ruleSets);
if (ruleSets.ruleCount() == 0) {
- String msg = "No rules found. Maybe you mispelled a rule name? (" + rulesets + ")";
+ String msg = "No rules found. Maybe you mispelled a rule name? (" + rulesets + ')';
LOG.log(Level.SEVERE, msg);
throw new IllegalArgumentException(msg);
}
@@ -61,19 +63,14 @@ public static RuleSets getRuleSets(String rulesets, RuleSetFactory factory) {
* a ruleset couldn't be found.
*/
public static RuleSets getRuleSetsWithBenchmark(String rulesets, RuleSetFactory factory) {
- long loadRuleStart = System.nanoTime();
- RuleSets ruleSets = null;
- try {
- ruleSets = getRuleSets(rulesets, factory);
- } finally {
- long endLoadRules = System.nanoTime();
- Benchmarker.mark(Benchmark.LoadRules, endLoadRules - loadRuleStart, 0);
+ try (TimedOperation to = TimeTracker.startOperation(TimedOperationCategory.LOAD_RULES)) {
+ return getRuleSets(rulesets, factory);
}
- return ruleSets;
}
- public static RuleSetFactory getRulesetFactory(final PMDConfiguration configuration) {
- return new RuleSetFactory(configuration.getClassLoader(), configuration.getMinimumPriority(), true,
+ public static RuleSetFactory getRulesetFactory(final PMDConfiguration configuration,
+ final ResourceLoader resourceLoader) {
+ return new RuleSetFactory(resourceLoader, configuration.getMinimumPriority(), true,
configuration.isRuleSetFactoryCompatibilityEnabled());
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/SourceCodeProcessor.java b/pmd-core/src/main/java/net/sourceforge/pmd/SourceCodeProcessor.java
index e361f742093..ddc0f200ec8 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/SourceCodeProcessor.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/SourceCodeProcessor.java
@@ -4,17 +4,16 @@
package net.sourceforge.pmd;
+import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
-import java.io.UnsupportedEncodingException;
import java.util.Collections;
import java.util.List;
-import org.apache.commons.io.IOUtils;
-
-import net.sourceforge.pmd.benchmark.Benchmark;
-import net.sourceforge.pmd.benchmark.Benchmarker;
+import net.sourceforge.pmd.benchmark.TimeTracker;
+import net.sourceforge.pmd.benchmark.TimedOperation;
+import net.sourceforge.pmd.benchmark.TimedOperationCategory;
import net.sourceforge.pmd.lang.Language;
import net.sourceforge.pmd.lang.LanguageVersion;
import net.sourceforge.pmd.lang.LanguageVersionHandler;
@@ -48,10 +47,10 @@ public SourceCodeProcessor(PMDConfiguration configuration) {
* @see #processSourceCode(Reader, RuleSets, RuleContext)
*/
public void processSourceCode(InputStream sourceCode, RuleSets ruleSets, RuleContext ctx) throws PMDException {
- try {
- processSourceCode(new InputStreamReader(sourceCode, configuration.getSourceEncoding()), ruleSets, ctx);
- } catch (UnsupportedEncodingException uee) {
- throw new PMDException("Unsupported encoding exception: " + uee.getMessage());
+ try (Reader streamReader = new InputStreamReader(sourceCode, configuration.getSourceEncoding())) {
+ processSourceCode(streamReader, ruleSets, ctx);
+ } catch (IOException e) {
+ throw new PMDException("IO exception: " + e.getMessage(), e);
}
}
@@ -102,26 +101,29 @@ public void processSourceCode(Reader sourceCode, RuleSets ruleSets, RuleContext
configuration.getAnalysisCache().analysisFailed(ctx.getSourceCodeFile());
throw new PMDException("Error while processing " + ctx.getSourceCodeFilename(), e);
} finally {
- IOUtils.closeQuietly(sourceCode);
ruleSets.end(ctx);
}
}
}
private Node parse(RuleContext ctx, Reader sourceCode, Parser parser) {
- long start = System.nanoTime();
- Node rootNode = parser.parse(ctx.getSourceCodeFilename(), sourceCode);
- ctx.getReport().suppress(parser.getSuppressMap());
- long end = System.nanoTime();
- Benchmarker.mark(Benchmark.Parser, end - start, 0);
- return rootNode;
+ try (TimedOperation to = TimeTracker.startOperation(TimedOperationCategory.PARSER)) {
+ Node rootNode = parser.parse(ctx.getSourceCodeFilename(), sourceCode);
+ ctx.getReport().suppress(parser.getSuppressMap());
+ return rootNode;
+ }
}
private void symbolFacade(Node rootNode, LanguageVersionHandler languageVersionHandler) {
- long start = System.nanoTime();
- languageVersionHandler.getSymbolFacade(configuration.getClassLoader()).start(rootNode);
- long end = System.nanoTime();
- Benchmarker.mark(Benchmark.SymbolTable, end - start, 0);
+ try (TimedOperation to = TimeTracker.startOperation(TimedOperationCategory.SYMBOL_TABLE)) {
+ languageVersionHandler.getSymbolFacade(configuration.getClassLoader()).start(rootNode);
+ }
+ }
+
+ private void resolveQualifiedNames(Node rootNode, LanguageVersionHandler handler) {
+ try (TimedOperation to = TimeTracker.startOperation(TimedOperationCategory.QUALIFIED_NAME_RESOLUTION)) {
+ handler.getQualifiedNameResolutionFacade(configuration.getClassLoader()).start(rootNode);
+ }
}
// private ParserOptions getParserOptions(final LanguageVersionHandler
@@ -135,11 +137,10 @@ private void symbolFacade(Node rootNode, LanguageVersionHandler languageVersionH
private void usesDFA(LanguageVersion languageVersion, Node rootNode, RuleSets ruleSets, Language language) {
if (ruleSets.usesDFA(language)) {
- long start = System.nanoTime();
- VisitorStarter dataFlowFacade = languageVersion.getLanguageVersionHandler().getDataFlowFacade();
- dataFlowFacade.start(rootNode);
- long end = System.nanoTime();
- Benchmarker.mark(Benchmark.DFA, end - start, 0);
+ try (TimedOperation to = TimeTracker.startOperation(TimedOperationCategory.DFA)) {
+ VisitorStarter dataFlowFacade = languageVersion.getLanguageVersionHandler().getDataFlowFacade();
+ dataFlowFacade.start(rootNode);
+ }
}
}
@@ -147,37 +148,37 @@ private void usesTypeResolution(LanguageVersion languageVersion, Node rootNode,
Language language) {
if (ruleSets.usesTypeResolution(language)) {
- long start = System.nanoTime();
- languageVersion.getLanguageVersionHandler().getTypeResolutionFacade(configuration.getClassLoader())
- .start(rootNode);
- long end = System.nanoTime();
- Benchmarker.mark(Benchmark.TypeResolution, end - start, 0);
+ try (TimedOperation to = TimeTracker.startOperation(TimedOperationCategory.TYPE_RESOLUTION)) {
+ languageVersion.getLanguageVersionHandler().getTypeResolutionFacade(configuration.getClassLoader())
+ .start(rootNode);
+ }
}
}
- private void usesMetrics(LanguageVersion languageVersion, Node rootNode, RuleSets ruleSets,
- Language language) {
- if (ruleSets.usesMetrics(language)) {
- long start = System.nanoTime();
- languageVersion.getLanguageVersionHandler().getMetricsVisitorFacade()
- .start(rootNode);
- long end = System.nanoTime();
- Benchmarker.mark(Benchmark.MetricsVisitor, end - start, 0);
+ private void usesMultifile(Node rootNode, LanguageVersionHandler languageVersionHandler, RuleSets ruleSets,
+ Language language) {
+
+ if (ruleSets.usesMultifile(language)) {
+ try (TimedOperation to = TimeTracker.startOperation(TimedOperationCategory.MULTIFILE_ANALYSIS)) {
+ languageVersionHandler.getMultifileFacade().start(rootNode);
+ }
}
}
+
private void processSource(Reader sourceCode, RuleSets ruleSets, RuleContext ctx) {
LanguageVersion languageVersion = ctx.getLanguageVersion();
LanguageVersionHandler languageVersionHandler = languageVersion.getLanguageVersionHandler();
Parser parser = PMD.parserFor(languageVersion, configuration);
Node rootNode = parse(ctx, sourceCode, parser);
+ resolveQualifiedNames(rootNode, languageVersionHandler);
symbolFacade(rootNode, languageVersionHandler);
Language language = languageVersion.getLanguage();
usesDFA(languageVersion, rootNode, ruleSets, language);
usesTypeResolution(languageVersion, rootNode, ruleSets, language);
- usesMetrics(languageVersion, rootNode, ruleSets, language);
+ usesMultifile(rootNode, languageVersionHandler, ruleSets, language);
List<Node> acus = Collections.singletonList(rootNode);
ruleSets.apply(acus, ctx, language);
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/annotation/Experimental.java b/pmd-core/src/main/java/net/sourceforge/pmd/annotation/Experimental.java
new file mode 100644
index 00000000000..82a838e616f
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/annotation/Experimental.java
@@ -0,0 +1,18 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.annotation;
+
+import java.lang.annotation.Documented;
+
+
+/**
+ * Indicates the feature is in experimental state: its existence, signature or behavior
+ * might change without warning from one release to the next.
+ *
+ * @since 6.7.0
+ */
+@Documented
+public @interface Experimental {
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/annotation/InternalApi.java b/pmd-core/src/main/java/net/sourceforge/pmd/annotation/InternalApi.java
new file mode 100644
index 00000000000..fbcef903503
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/annotation/InternalApi.java
@@ -0,0 +1,25 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.annotation;
+
+import java.lang.annotation.Documented;
+
+
+/**
+ * Tags API members that are not publicly supported API.
+ * Such members may be removed, renamed, moved, or otherwise
+ * broken at any time and should not be relied upon outside
+ * of the main PMD codebase.
+ *
+ * <p>Members and types tagged with this annotation will remain
+ * supported until 7.0.0, after which some will be moved to internal
+ * packages, or will see their visibility reduced.
+ *
+ * @since 6.7.0
+ */
+// NOTE: use @Deprecated with this annotation to raise a compiler warning until 7.0.0
+@Documented
+public @interface InternalApi {
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/annotation/ReservedSubclassing.java b/pmd-core/src/main/java/net/sourceforge/pmd/annotation/ReservedSubclassing.java
new file mode 100644
index 00000000000..47f10de80cc
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/annotation/ReservedSubclassing.java
@@ -0,0 +1,37 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.annotation;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Target;
+
+
+/**
+ * Indicates that subclassing this type is not publicly
+ * supported API. Abstract methods may be added or removed
+ * at any time, which could break binary compatibility with
+ * existing implementors. Protected methods are also part of
+ * the private API of this type.
+ *
+ * <p>The API that is not inheritance-specific (unless {@linkplain InternalApi noted otherwise},
+ * all public members), is still public API and will remain binary-
+ * compatible between major releases.
+ *
+ * <p>Types tagged with this annotation will remain supported
+ * until 7.0.0, at which point no guarantees will be maintained
+ * about the stability of the inheritance hierarchy for external
+ * clients.
+ *
+ * <p>This should be used for example for base rule classes that
+ * are meant to be used in PMD only, or for AST-related interfaces
+ * and abstract classes.
+ *
+ * @since 6.7.0
+ */
+@Target(ElementType.TYPE)
+@Documented
+public @interface ReservedSubclassing {
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/ant/Formatter.java b/pmd-core/src/main/java/net/sourceforge/pmd/ant/Formatter.java
index b1224fbed60..140de7ef82c 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/ant/Formatter.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/ant/Formatter.java
@@ -206,9 +206,9 @@ private static String getConsoleEncoding() {
if (res instanceof Charset) {
return ((Charset) res).name();
}
- } catch (NoSuchFieldException e) {
+ } catch (NoSuchFieldException ignored) {
// fall-through
- } catch (IllegalAccessException e) {
+ } catch (IllegalAccessException ignored) {
// fall-through
}
return getNativeConsoleEncoding();
@@ -224,11 +224,11 @@ private static String getNativeConsoleEncoding() {
if (res instanceof String) {
return (String) res;
}
- } catch (NoSuchMethodException e) {
+ } catch (NoSuchMethodException ignored) {
// fall-through
- } catch (InvocationTargetException e) {
+ } catch (InvocationTargetException ignored) {
// fall-through
- } catch (IllegalAccessException e) {
+ } catch (IllegalAccessException ignored) {
// fall-through
}
return null;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/ant/PMDTask.java b/pmd-core/src/main/java/net/sourceforge/pmd/ant/PMDTask.java
index 85241b290f3..378b8396e2c 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/ant/PMDTask.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/ant/PMDTask.java
@@ -36,6 +36,7 @@ public class PMDTask extends Task {
private String failuresPropertyName;
private SourceLanguage sourceLanguage;
private String cacheLocation;
+ private boolean noCache;
private final Collection<RuleSetWrapper> nestedRules = new ArrayList<>();
@Override
@@ -254,4 +255,13 @@ public String getCacheLocation() {
public void setCacheLocation(String cacheLocation) {
this.cacheLocation = cacheLocation;
}
+
+
+ public boolean isNoCache() {
+ return noCache;
+ }
+
+ public void setNoCache(boolean noCache) {
+ this.noCache = noCache;
+ }
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/ant/internal/PMDTaskImpl.java b/pmd-core/src/main/java/net/sourceforge/pmd/ant/internal/PMDTaskImpl.java
index b76a0682b39..e7d34c5bdd6 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/ant/internal/PMDTaskImpl.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/ant/internal/PMDTaskImpl.java
@@ -12,10 +12,7 @@
import java.util.LinkedList;
import java.util.List;
import java.util.concurrent.atomic.AtomicInteger;
-import java.util.logging.Handler;
-import java.util.logging.Level;
-import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.tools.ant.AntClassLoader;
import org.apache.tools.ant.BuildException;
@@ -42,7 +39,9 @@
import net.sourceforge.pmd.lang.LanguageVersion;
import net.sourceforge.pmd.renderers.AbstractRenderer;
import net.sourceforge.pmd.renderers.Renderer;
+import net.sourceforge.pmd.util.ClasspathClassLoader;
import net.sourceforge.pmd.util.IOUtil;
+import net.sourceforge.pmd.util.ResourceLoader;
import net.sourceforge.pmd.util.datasource.DataSource;
import net.sourceforge.pmd.util.datasource.FileDataSource;
import net.sourceforge.pmd.util.log.AntLogHandler;
@@ -79,13 +78,14 @@ public PMDTaskImpl(PMDTask task) {
this.failuresPropertyName = task.getFailuresPropertyName();
configuration.setMinimumPriority(RulePriority.valueOf(task.getMinimumPriority()));
configuration.setAnalysisCacheLocation(task.getCacheLocation());
+ configuration.setIgnoreIncrementalAnalysis(task.isNoCache());
SourceLanguage version = task.getSourceLanguage();
if (version != null) {
LanguageVersion languageVersion = LanguageRegistry
- .findLanguageVersionByTerseName(version.getName() + " " + version.getVersion());
+ .findLanguageVersionByTerseName(version.getName() + ' ' + version.getVersion());
if (languageVersion == null) {
- throw new BuildException("The following language is not supported:" + version + ".");
+ throw new BuildException("The following language is not supported:" + version + '.');
}
configuration.setDefaultLanguageVersion(languageVersion);
}
@@ -101,9 +101,11 @@ public PMDTaskImpl(PMDTask task) {
private void doTask() {
setupClassLoader();
-
+
// Setup RuleSetFactory and validate RuleSets
- RuleSetFactory ruleSetFactory = RulesetsFactoryUtils.getRulesetFactory(configuration);
+ final ResourceLoader rl = setupResourceLoader();
+ RuleSetFactory ruleSetFactory = RulesetsFactoryUtils.getRulesetFactory(configuration, rl);
+
try {
// This is just used to validate and display rules. Each thread will create its own ruleset
String ruleSets = configuration.getRuleSets();
@@ -208,6 +210,27 @@ public String defaultFileExtension() {
}
}
+ private ResourceLoader setupResourceLoader() {
+ if (classpath == null) {
+ classpath = new Path(project);
+ }
+
+ /*
+ * 'basedir' is added to the path to make sure that relative paths such
+ * as "<ruleset>resources/custom_ruleset.xml</ruleset>" still work when
+ * ant is invoked from a different directory using "-f"
+ */
+ classpath.add(new Path(null, project.getBaseDir().toString()));
+
+ project.log("Using the AntClassLoader: " + classpath, Project.MSG_VERBOSE);
+ // must be true, otherwise you'll get ClassCastExceptions as classes
+ // are loaded twice
+ // and exist in multiple class loaders
+ final boolean parentFirst = true;
+ return new ResourceLoader(new AntClassLoader(Thread.currentThread().getContextClassLoader(),
+ project, classpath, parentFirst));
+ }
+
private void handleError(RuleContext ctx, Report errorReport, RuntimeException pmde) {
pmde.printStackTrace();
@@ -216,12 +239,13 @@ private void handleError(RuleContext ctx, Report errorReport, RuntimeException p
Throwable cause = pmde.getCause();
if (cause != null) {
- StringWriter strWriter = new StringWriter();
- PrintWriter printWriter = new PrintWriter(strWriter);
- cause.printStackTrace(printWriter);
- project.log(strWriter.toString(), Project.MSG_VERBOSE);
- IOUtils.closeQuietly(printWriter);
-
+ try (StringWriter strWriter = new StringWriter();
+ PrintWriter printWriter = new PrintWriter(strWriter)) {
+ cause.printStackTrace(printWriter);
+ project.log(strWriter.toString(), Project.MSG_VERBOSE);
+ } catch (IOException e) {
+ project.log("Error while closing stream", e, Project.MSG_ERR);
+ }
if (StringUtils.isNotBlank(cause.getMessage())) {
project.log(cause.getMessage(), Project.MSG_VERBOSE);
}
@@ -234,24 +258,6 @@ private void handleError(RuleContext ctx, Report errorReport, RuntimeException p
}
private void setupClassLoader() {
- if (classpath == null) {
- classpath = new Path(project);
- }
- /*
- * 'basedir' is added to the path to make sure that relative paths such
- * as "<ruleset>resources/custom_ruleset.xml</ruleset>" still work when
- * ant is invoked from a different directory using "-f"
- */
- classpath.add(new Path(null, project.getBaseDir().toString()));
-
- project.log("Using the AntClassLoader: " + classpath, Project.MSG_VERBOSE);
- // must be true, otherwise you'll get ClassCastExceptions as classes
- // are loaded twice
- // and exist in multiple class loaders
- boolean parentFirst = true;
- configuration.setClassLoader(
- new AntClassLoader(Thread.currentThread().getContextClassLoader(), project, classpath, parentFirst));
-
try {
if (auxClasspath != null) {
project.log("Using auxclasspath: " + auxClasspath, Project.MSG_VERBOSE);
@@ -263,13 +269,17 @@ private void setupClassLoader() {
}
public void execute() throws BuildException {
- final Handler antLogHandler = new AntLogHandler(project);
- final ScopedLogHandlersManager logManager = new ScopedLogHandlersManager(Level.FINEST, antLogHandler);
+ final AntLogHandler antLogHandler = new AntLogHandler(project);
+ final ScopedLogHandlersManager logManager = new ScopedLogHandlersManager(antLogHandler.getAntLogLevel(), antLogHandler);
try {
doTask();
} finally {
logManager.close();
- IOUtil.tryCloseClassLoader(configuration.getClassLoader());
+ // only close the classloader, if it is ours. Otherwise we end up with class not found
+ // exceptions
+ if (configuration.getClassLoader() instanceof ClasspathClassLoader) {
+ IOUtil.tryCloseClassLoader(configuration.getClassLoader());
+ }
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/Benchmark.java b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/Benchmark.java
index ac37b993e59..7cf422214a6 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/Benchmark.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/Benchmark.java
@@ -5,32 +5,37 @@
package net.sourceforge.pmd.benchmark;
/**
+ * Represents an execution phase for benchmarking purposes.
*
* @author Brian Remedios
*/
+@Deprecated
public enum Benchmark {
- Rule(0, null),
- RuleChainRule(1, null),
- CollectFiles(2, "Collect files"),
- LoadRules(3, "Load rules"),
- Parser(4, "Parser"),
- SymbolTable(5, "Symbol table"),
- DFA(6, "DFA"),
- TypeResolution(7, "Type resolution"),
- MetricsVisitor(8, "Metrics"),
- RuleChainVisit(9, "RuleChain visit"),
- Reporting(10, "Reporting"),
- RuleTotal(11, "Rule total"),
- RuleChainTotal(12, "Rule chain rule total"),
- MeasuredTotal(13, "Measured total"),
- NonMeasuredTotal(14, "Non-measured total"),
- TotalPMD(15, "Total PMD");
+ // The constants must be sorted in execution order,
+ // the index is derived from the ordinal of the constant
+ Rule(null),
+ RuleChainRule(null),
+ CollectFiles("Collect files"),
+ LoadRules("Load rules"),
+ Parser("Parser"),
+ QualifiedNameResolution("Qualified name resolution"),
+ SymbolTable("Symbol table"),
+ DFA("DFA"),
+ TypeResolution("Type resolution"),
+ RuleChainVisit("RuleChain visit"),
+ Multifile("Multifile analysis"),
+ Reporting("Reporting"),
+ RuleTotal("Rule total"),
+ RuleChainTotal("Rule chain rule total"),
+ MeasuredTotal("Measured total"),
+ NonMeasuredTotal("Non-measured total"),
+ TotalPMD("Total PMD");
- public final int index;
+ public final int index = ordinal();
public final String name;
- Benchmark(int idx, String theName) {
- index = idx;
+
+ Benchmark(String theName) {
name = theName;
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/BenchmarkReport.java b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/BenchmarkReport.java
index 49f021cf40a..c0cdb123b07 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/BenchmarkReport.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/BenchmarkReport.java
@@ -12,19 +12,20 @@
*
* @author Brian Remedios
*/
+@Deprecated
public interface BenchmarkReport {
/**
*
- * @param stressResults
- * @param out
+ * @param stressResults the durations from the stress test run
+ * @param stream the report is written into this stream
*/
- void generate(Set<RuleDuration> stressResults, PrintStream out);
+ void generate(Set<RuleDuration> stressResults, PrintStream stream);
/**
*
* @param benchmarksByName
- * @param out
+ * @param stream the report is written into this stream
*/
- void generate(Map<String, BenchmarkResult> benchmarksByName, PrintStream out);
+ void generate(Map<String, BenchmarkResult> benchmarksByName, PrintStream stream);
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/BenchmarkResult.java b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/BenchmarkResult.java
index 80ec47df53f..5f929eda3fe 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/BenchmarkResult.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/BenchmarkResult.java
@@ -4,6 +4,7 @@
package net.sourceforge.pmd.benchmark;
+@Deprecated
class BenchmarkResult implements Comparable<BenchmarkResult> {
public final Benchmark type;
@@ -37,10 +38,9 @@ public void update(long time, long count) {
@Override
public int compareTo(BenchmarkResult benchmarkResult) {
- int cmp = type.index - benchmarkResult.type.index;
+ int cmp = Integer.compare(type.index, benchmarkResult.type.index);
if (cmp == 0) {
- long delta = this.time - benchmarkResult.time;
- cmp = delta > 0 ? 1 : (delta < 0 ? -1 : 0);
+ cmp = Long.compare(this.time, benchmarkResult.time);
}
return cmp;
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/Benchmarker.java b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/Benchmarker.java
index 3f60278e59a..d200d351a5a 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/Benchmarker.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/Benchmarker.java
@@ -4,9 +4,10 @@
package net.sourceforge.pmd.benchmark;
+import java.io.BufferedInputStream;
import java.io.IOException;
+import java.io.InputStream;
import java.io.InputStreamReader;
-import java.io.Reader;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
@@ -14,7 +15,6 @@
import java.util.Set;
import java.util.TreeSet;
-import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.StringUtils;
import net.sourceforge.pmd.PMD;
@@ -36,10 +36,10 @@
import net.sourceforge.pmd.util.datasource.DataSource;
/**
- *
- *
+ * @deprecated use {@link TimeTracker} instead
*/
-public class Benchmarker {
+@Deprecated
+public final class Benchmarker {
private static final Map<String, BenchmarkResult> BENCHMARKS_BY_NAME = new HashMap<>();
@@ -144,11 +144,8 @@ private static void parseStress(Parser parser, List<DataSource> dataSources, boo
long start = System.currentTimeMillis();
for (DataSource dataSource : dataSources) {
- InputStreamReader reader = new InputStreamReader(dataSource.getInputStream());
- try {
+ try (InputStreamReader reader = new InputStreamReader(dataSource.getInputStream())) {
parser.parse(dataSource.getNiceFileName(false, null), reader);
- } finally {
- IOUtils.closeQuietly(reader);
}
}
@@ -191,12 +188,9 @@ private static void stress(LanguageVersion languageVersion, RuleSet ruleSet, Lis
RuleContext ctx = new RuleContext();
long start = System.currentTimeMillis();
for (DataSource dataSource : dataSources) {
- Reader reader = new InputStreamReader(dataSource.getInputStream());
- try {
+ try (InputStream stream = new BufferedInputStream(dataSource.getInputStream())) {
ctx.setSourceCodeFilename(dataSource.getNiceFileName(false, null));
- new SourceCodeProcessor(config).processSourceCode(reader, ruleSets, ctx);
- } finally {
- IOUtils.closeQuietly(reader);
+ new SourceCodeProcessor(config).processSourceCode(stream, ruleSets, ctx);
}
}
long end = System.currentTimeMillis();
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/RuleDuration.java b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/RuleDuration.java
index 417ee3d41af..35e2e6affa9 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/RuleDuration.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/RuleDuration.java
@@ -6,6 +6,7 @@
import net.sourceforge.pmd.Rule;
+@Deprecated
public class RuleDuration implements Comparable<RuleDuration> {
public Rule rule;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/StringBuilderCR.java b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/StringBuilderCR.java
index a07840f606f..36cab0443ea 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/StringBuilderCR.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/StringBuilderCR.java
@@ -10,6 +10,7 @@
*
* @author Brian Remedios
*/
+@Deprecated
public class StringBuilderCR {
private final String cr;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/TextReport.java b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/TextReport.java
index 9bc1c0b27ac..24881067906 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/TextReport.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/TextReport.java
@@ -20,25 +20,19 @@
*
*
*/
+@Deprecated
public class TextReport implements BenchmarkReport {
private static final int TIME_COLUMN = 48;
private static final int NAME_COLUMN_WIDTH = 50;
private static final int VALUE_COLUMN_WIDTH = 8;
- /**
- *
- * @param stressResults the durations from the stress test run
- * @param out
- * PrintStream
- * @see BenchmarkReport#generate(Set, PrintStream)
- */
@Override
- public void generate(Set<RuleDuration> stressResults, PrintStream out) {
+ public void generate(Set<RuleDuration> stressResults, PrintStream stream) {
- out.println("=========================================================");
- out.println("Rule\t\t\t\t\t\tTime in ms");
- out.println("=========================================================");
+ stream.println("=========================================================");
+ stream.println("Rule\t\t\t\t\t\tTime in ms");
+ stream.println("=========================================================");
for (RuleDuration result : stressResults) {
StringBuilder buffer = new StringBuilder(result.rule.getName());
@@ -46,25 +40,18 @@ public void generate(Set<RuleDuration> stressResults, PrintStream out) {
buffer.append(' ');
}
buffer.append(result.time);
- out.println(out.toString());
+ stream.println(stream.toString());
}
- out.println("=========================================================");
+ stream.println("=========================================================");
}
public void report(Map<String, BenchmarkResult> benchmarksByName) {
generate(benchmarksByName, System.out);
}
- /**
- *
- * @param benchmarksByName
- * @param out
- * PrintStream
- * @see BenchmarkReport#generate(Map, PrintStream)
- */
@Override
- public void generate(Map<String, BenchmarkResult> benchmarksByName, PrintStream out) {
+ public void generate(Map<String, BenchmarkResult> benchmarksByName, PrintStream stream) {
List<BenchmarkResult> results = new ArrayList<>(benchmarksByName.values());
@@ -153,7 +140,7 @@ public void generate(Map<String, BenchmarkResult> benchmarksByName, PrintStream
buf.appendLn(buf2.toString());
}
- out.print(buf.toString());
+ stream.print(buf.toString());
}
/**
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/TextTimingReportRenderer.java b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/TextTimingReportRenderer.java
new file mode 100644
index 00000000000..6aa88bc486a
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/TextTimingReportRenderer.java
@@ -0,0 +1,144 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.benchmark;
+
+import java.io.IOException;
+import java.io.Writer;
+import java.text.MessageFormat;
+import java.util.Comparator;
+import java.util.Map;
+import java.util.Map.Entry;
+import java.util.TreeSet;
+
+import org.apache.commons.lang3.StringUtils;
+
+import net.sourceforge.pmd.PMD;
+import net.sourceforge.pmd.benchmark.TimeTracker.TimedResult;
+
+/**
+ * A text based renderer for {@link TimingReport}.
+ * @author Juan MartÃn Sotuyo Dodero
+ */
+public class TextTimingReportRenderer implements TimingReportRenderer {
+
+ private static final String TIME_FORMAT = "{0,number,0.0000}";
+ private static final String CUSTOM_COUNTER_FORMAT = "{0,number,###,###,###}";
+
+ private static final int LABEL_COLUMN_WIDTH = 50;
+ private static final int TIME_COLUMN_WIDTH = 12;
+ private static final int SELF_TIME_COLUMN_WIDTH = 17;
+ private static final int CALL_COLUMN_WIDTH = 9;
+ private static final int COUNTER_COLUMN_WIDTH = 12;
+
+ private static final int COLUMNS = LABEL_COLUMN_WIDTH + TIME_COLUMN_WIDTH
+ + SELF_TIME_COLUMN_WIDTH + CALL_COLUMN_WIDTH + COUNTER_COLUMN_WIDTH;
+
+ @Override
+ public void render(final TimingReport report, final Writer writer) throws IOException {
+ for (final TimedOperationCategory category : TimedOperationCategory.values()) {
+ final Map<String, TimedResult> labeledMeasurements = report.getLabeledMeasurements(category);
+ if (!labeledMeasurements.isEmpty()) {
+ renderCategoryMeasurements(category, labeledMeasurements, writer);
+ }
+ }
+
+ renderHeader("Summary", writer);
+
+ for (final TimedOperationCategory category : TimedOperationCategory.values()) {
+ final TimedResult timedResult = report.getUnlabeledMeasurements(category);
+ if (timedResult != null) {
+ renderMeasurement(category.displayName(), timedResult, writer);
+ }
+ }
+
+ writer.write(PMD.EOL);
+ renderHeader("Total", writer);
+
+ writer.write(StringUtils.rightPad("Wall Clock Time", LABEL_COLUMN_WIDTH));
+ final String wallClockTime = MessageFormat.format(TIME_FORMAT, report.getWallClockMillis() / 1000.0);
+ writer.write(StringUtils.leftPad(wallClockTime, TIME_COLUMN_WIDTH));
+ writer.write(PMD.EOL);
+
+ writer.flush();
+ }
+
+ private void renderMeasurement(final String label, final TimedResult timedResult,
+ final Writer writer) throws IOException {
+ writer.write(StringUtils.rightPad(label, LABEL_COLUMN_WIDTH));
+
+ final String time = MessageFormat.format(TIME_FORMAT, timedResult.totalTimeNanos.get() / 1000000000.0);
+ writer.write(StringUtils.leftPad(time, TIME_COLUMN_WIDTH));
+
+ final String selfTime = MessageFormat.format(TIME_FORMAT, timedResult.selfTimeNanos.get() / 1000000000.0);
+ writer.write(StringUtils.leftPad(selfTime, SELF_TIME_COLUMN_WIDTH));
+
+ if (timedResult.callCount.get() > 0) {
+ final String callCount = MessageFormat.format(CUSTOM_COUNTER_FORMAT, timedResult.callCount.get());
+ writer.write(StringUtils.leftPad(callCount, CALL_COLUMN_WIDTH));
+
+ if (timedResult.extraDataCounter.get() > 0) {
+ final String counter = MessageFormat.format(CUSTOM_COUNTER_FORMAT, timedResult.extraDataCounter.get());
+ writer.write(StringUtils.leftPad(counter, COUNTER_COLUMN_WIDTH));
+ }
+ }
+
+ writer.write(PMD.EOL);
+ }
+
+ private void renderCategoryMeasurements(final TimedOperationCategory category,
+ final Map<String, TimedResult> labeledMeasurements, final Writer writer) throws IOException {
+ renderHeader(category.displayName(), writer);
+
+ final TimedResult grandTotal = new TimedResult();
+ final TreeSet<Map.Entry<String, TimedResult>> sortedKeySet = new TreeSet<>(
+ new Comparator<Map.Entry<String, TimedResult>>() {
+ @Override
+ public int compare(final Entry<String, TimedResult> o1, final Entry<String, TimedResult> o2) {
+ return Long.compare(o1.getValue().selfTimeNanos.get(), o2.getValue().selfTimeNanos.get());
+ }
+ });
+ sortedKeySet.addAll(labeledMeasurements.entrySet());
+
+ for (final Map.Entry<String, TimedResult> entry : sortedKeySet) {
+ renderMeasurement(entry.getKey(), entry.getValue(), writer);
+ grandTotal.mergeTimes(entry.getValue());
+ }
+
+ writer.write(PMD.EOL);
+ renderMeasurement("Total " + category.displayName(), grandTotal, writer);
+ writer.write(PMD.EOL);
+ }
+
+ private void renderHeader(final String displayName, final Writer writer) throws IOException {
+ final StringBuilder sb = new StringBuilder(COLUMNS)
+ .append(displayName);
+
+ // Make sure we have an even-length string
+ if (displayName.length() % 2 == 1) {
+ sb.append(' ');
+ }
+
+ // Surround with <<< and >>>
+ sb.insert(0, "<<< ").append(" >>>");
+
+ // Create the ruler
+ while (sb.length() < COLUMNS) {
+ sb.insert(0, '-').append('-');
+ }
+
+ writer.write(sb.toString());
+ writer.write(PMD.EOL);
+
+ // Write table titles
+ writer.write(StringUtils.rightPad("Label", LABEL_COLUMN_WIDTH));
+ writer.write(StringUtils.leftPad("Time (secs)", TIME_COLUMN_WIDTH));
+ writer.write(StringUtils.leftPad("Self Time (secs)", SELF_TIME_COLUMN_WIDTH));
+ writer.write(StringUtils.leftPad("# Calls", CALL_COLUMN_WIDTH));
+ writer.write(StringUtils.leftPad("Counter", COUNTER_COLUMN_WIDTH));
+ writer.write(PMD.EOL);
+ writer.write(PMD.EOL);
+ }
+
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/TimeTracker.java b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/TimeTracker.java
new file mode 100644
index 00000000000..8bf202fa86c
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/TimeTracker.java
@@ -0,0 +1,286 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.benchmark;
+
+import java.util.Collections;
+import java.util.LinkedList;
+import java.util.Objects;
+import java.util.Queue;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ConcurrentMap;
+import java.util.concurrent.atomic.AtomicInteger;
+import java.util.concurrent.atomic.AtomicLong;
+
+/**
+ * A time tracker class to measure time spent on different sections of PMD analysis.
+ * The class is thread-aware, allowing to differentiate CPU and wall clock time.
+ *
+ * @author Juan MartÃn Sotuyo Dodero
+ */
+public final class TimeTracker {
+
+ private static boolean trackTime = false;
+ private static long wallClockStartMillis = -1;
+ private static final ThreadLocal<Queue<TimerEntry>> TIMER_ENTRIES;
+ private static final ConcurrentMap<TimedOperationKey, TimedResult> ACCUMULATED_RESULTS = new ConcurrentHashMap<>();
+ private static final TimedOperation NOOP_TIMED_OPERATION = new TimedOperation() {
+
+ @Override
+ public void close() {
+ // noop
+ }
+
+ @Override
+ public void close(final int count) {
+ // noop
+ }
+ };
+
+ static {
+ TIMER_ENTRIES = new ThreadLocal<Queue<TimerEntry>>() {
+ @Override
+ protected Queue<TimerEntry> initialValue() {
+ return Collections.asLifoQueue(new LinkedList<TimerEntry>());
+ }
+ };
+ }
+
+ private TimeTracker() {
+ throw new AssertionError("Can't instantiate utility class");
+ }
+
+ /**
+ * Starts global tracking. Allows tracking operations to take place and starts the wall clock.
+ * Must be called once PMD starts if tracking is desired, no tracking will be performed otherwise.
+ */
+ public static void startGlobalTracking() {
+ wallClockStartMillis = System.currentTimeMillis();
+ trackTime = true;
+ ACCUMULATED_RESULTS.clear(); // just in case
+ initThread(); // init main thread
+ }
+
+ /**
+ * Stops global tracking. Stops the wall clock. All further operations will be treated as NOOP.
+ * @return The timed data obtained through the run.
+ */
+ public static TimingReport stopGlobalTracking() {
+ if (!trackTime) {
+ return null;
+ }
+
+ finishThread(); // finish the main thread
+ trackTime = false;
+
+ // Fix UNACCOUNTED metric (total time is meaningless as is call count)
+ final TimedResult unaccountedResult = ACCUMULATED_RESULTS.get(
+ new TimedOperationKey(TimedOperationCategory.UNACCOUNTED, null));
+ unaccountedResult.totalTimeNanos.set(unaccountedResult.selfTimeNanos.get());
+ unaccountedResult.callCount.set(0);
+
+ return new TimingReport(System.currentTimeMillis() - wallClockStartMillis, ACCUMULATED_RESULTS);
+ }
+
+ /**
+ * Initialize a thread, starting to track it's own time.
+ */
+ public static void initThread() {
+ if (!trackTime) {
+ return;
+ }
+
+ startOperation(TimedOperationCategory.UNACCOUNTED);
+ }
+
+ /**
+ * Finishes tracking a thread.
+ */
+ public static void finishThread() {
+ if (!trackTime) {
+ return;
+ }
+
+ finishOperation(0);
+
+ // clean up thread-locals in multithread analysis
+ if (TIMER_ENTRIES.get().isEmpty()) {
+ TIMER_ENTRIES.remove();
+ }
+ }
+
+ /**
+ * Starts tracking an operation.
+ * @param category The category under which to track the operation.
+ * @return The current timed operation being tracked.
+ */
+ public static TimedOperation startOperation(final TimedOperationCategory category) {
+ return startOperation(category, null);
+ }
+
+ /**
+ * Starts tracking an operation.
+ * @param category The category under which to track the operation.
+ * @param label A label to be added to the category. Allows to differentiate measures within a single category.
+ * @return The current timed operation being tracked.
+ */
+ public static TimedOperation startOperation(final TimedOperationCategory category, final String label) {
+ if (!trackTime) {
+ return NOOP_TIMED_OPERATION;
+ }
+
+ TIMER_ENTRIES.get().add(new TimerEntry(category, label));
+ return new TimedOperationImpl();
+ }
+
+ /**
+ * Finishes tracking an operation.
+ * @param extraDataCounter An optional additional data counter to track along the measurements.
+ * Users are free to track any extra value they want (ie: number of analyzed nodes,
+ * iterations in a loop, etc.)
+ */
+ /* default */ static void finishOperation(final long extraDataCounter) {
+ if (!trackTime) {
+ return;
+ }
+
+ final Queue<TimerEntry> queue = TIMER_ENTRIES.get();
+ final TimerEntry timerEntry = queue.remove();
+
+ // Compute if absent
+ TimedResult result = ACCUMULATED_RESULTS.get(timerEntry.operation);
+ if (result == null) {
+ ACCUMULATED_RESULTS.putIfAbsent(timerEntry.operation, new TimedResult());
+ result = ACCUMULATED_RESULTS.get(timerEntry.operation);
+ }
+
+ // Update counters and let next element on the stack ignore the time we spent
+ final long delta = result.accumulate(timerEntry, extraDataCounter);
+ if (!queue.isEmpty()) {
+ queue.peek().inNestedOperationsNanos += delta;
+ }
+ }
+
+ /**
+ * An entry in the open timers queue. Defines an operation that has started and hasn't finished yet.
+ */
+ private static class TimerEntry {
+ /* package */ final TimedOperationKey operation;
+ /* package */ final long start;
+ /* package */ long inNestedOperationsNanos = 0;
+
+ /* package */ TimerEntry(final TimedOperationCategory category, final String label) {
+ this.operation = new TimedOperationKey(category, label);
+ this.start = System.nanoTime();
+ }
+
+ @Override
+ public String toString() {
+ return "TimerEntry for " + operation;
+ }
+ }
+
+ /**
+ * Aggregate results measured so far for a given category + label.
+ */
+ /* package */ static class TimedResult {
+ /* package */ AtomicLong totalTimeNanos = new AtomicLong();
+ /* package */ AtomicLong selfTimeNanos = new AtomicLong();
+ /* package */ AtomicInteger callCount = new AtomicInteger();
+ /* package */ AtomicLong extraDataCounter = new AtomicLong();
+
+ /**
+ * Adds a new {@link TimerEntry} to the results.
+ * @param timerEntry The entry to be added
+ * @param extraData Any extra data counter to be added
+ * @return The delta time transcurred since the {@link TimerEntry} began in nanos.
+ */
+ /* package */ long accumulate(final TimerEntry timerEntry, final long extraData) {
+ final long delta = System.nanoTime() - timerEntry.start;
+
+ totalTimeNanos.getAndAdd(delta);
+ selfTimeNanos.getAndAdd(delta - timerEntry.inNestedOperationsNanos);
+ callCount.getAndIncrement();
+ extraDataCounter.getAndAdd(extraData);
+
+ return delta;
+ }
+
+ /**
+ * Merges the times (and only the times) from another {@link TimedResult} into self.
+ * @param timedResult The {@link TimedResult} to merge
+ */
+ /* package */ void mergeTimes(final TimedResult timedResult) {
+ totalTimeNanos.getAndAdd(timedResult.totalTimeNanos.get());
+ selfTimeNanos.getAndAdd(timedResult.selfTimeNanos.get());
+ }
+ }
+
+ /**
+ * A unique identifier for a timed operation
+ */
+ /* package */ static class TimedOperationKey {
+ /* package */ final TimedOperationCategory category;
+ /* package */ final String label;
+
+ /* package */ TimedOperationKey(final TimedOperationCategory category, final String label) {
+ this.category = category;
+ this.label = label;
+ }
+
+ @Override
+ public int hashCode() {
+ final int prime = 31;
+ int result = 1;
+ result = prime * result + ((category == null) ? 0 : category.hashCode());
+ result = prime * result + ((label == null) ? 0 : label.hashCode());
+ return result;
+ }
+
+ @Override
+ public boolean equals(final Object obj) {
+ if (this == obj) {
+ return true;
+ }
+ if (obj == null) {
+ return false;
+ }
+ if (getClass() != obj.getClass()) {
+ return false;
+ }
+ TimedOperationKey other = (TimedOperationKey) obj;
+ if (category != other.category) {
+ return false;
+ }
+ return Objects.equals(label, other.label);
+ }
+
+ @Override
+ public String toString() {
+ return "TimedOperationKey [category=" + category + ", label=" + label + "]";
+ }
+ }
+
+ /**
+ * A standard timed operation implementation.
+ */
+ private static class TimedOperationImpl implements TimedOperation {
+ private boolean closed = false;
+
+ @Override
+ public void close() {
+ close(0);
+ }
+
+ @Override
+ public void close(int extraDataCounter) {
+ if (closed) {
+ return;
+ }
+
+ closed = true;
+ TimeTracker.finishOperation(extraDataCounter);
+ }
+ }
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/TimedOperation.java b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/TimedOperation.java
new file mode 100644
index 00000000000..20978cdf49f
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/TimedOperation.java
@@ -0,0 +1,25 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.benchmark;
+
+/**
+ * Describes a timed operation. It's {@link AutoCloseable}, for ease of use.
+ */
+public interface TimedOperation extends AutoCloseable {
+
+ /**
+ * Stops tracking if not already stopped.
+ */
+ @Override
+ void close();
+
+ /**
+ * Stops tracking if not already stopped.
+ * @param extraDataCounter An optional additional data counter to track along the measurements.
+ * Users are free to track any extra value they want (ie: number of analyzed nodes,
+ * iterations in a loop, etc.)
+ */
+ void close(int extraDataCounter);
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/TimedOperationCategory.java b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/TimedOperationCategory.java
new file mode 100644
index 00000000000..5876a7f77b6
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/TimedOperationCategory.java
@@ -0,0 +1,39 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.benchmark;
+
+import java.util.Locale;
+
+import org.apache.commons.lang3.StringUtils;
+
+/**
+ * @author Juan MartÃn Sotuyo Dodero
+ */
+public enum TimedOperationCategory {
+ RULE,
+ RULECHAIN_RULE,
+ COLLECT_FILES,
+ LOAD_RULES,
+ PARSER,
+ QUALIFIED_NAME_RESOLUTION,
+ SYMBOL_TABLE,
+ DFA,
+ TYPE_RESOLUTION,
+ RULECHAIN_VISIT,
+ MULTIFILE_ANALYSIS,
+ REPORTING,
+ FILE_PROCESSING,
+ UNACCOUNTED;
+
+ public String displayName() {
+ final String[] parts = name().toLowerCase(Locale.getDefault()).split("_");
+ final StringBuilder sb = new StringBuilder();
+ for (final String part : parts) {
+ sb.append(StringUtils.capitalize(part)).append(' ');
+ }
+ sb.setLength(sb.length() - 1); // remove the final space
+ return sb.toString();
+ }
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/TimingReport.java b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/TimingReport.java
new file mode 100644
index 00000000000..f8fed28d931
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/TimingReport.java
@@ -0,0 +1,54 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.benchmark;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import net.sourceforge.pmd.benchmark.TimeTracker.TimedOperationKey;
+import net.sourceforge.pmd.benchmark.TimeTracker.TimedResult;
+
+/**
+ * A report on timing data obtained through the execution of PMD
+ * @author Juan MartÃn Sotuyo Dodero
+ */
+public class TimingReport {
+
+ private final long wallClockMillis;
+ private final Map<TimedOperationKey, TimedResult> results;
+
+ /* package */ TimingReport(final long wallClockMillis, final Map<TimedOperationKey, TimedResult> accumulatedResults) {
+ this.wallClockMillis = wallClockMillis;
+ results = accumulatedResults;
+ }
+
+ public Map<String, TimedResult> getLabeledMeasurements(final TimedOperationCategory category) {
+ final Map<String, TimedResult> ret = new HashMap<>();
+
+ for (final Map.Entry<TimedOperationKey, TimedResult> entry : results.entrySet()) {
+ final TimedOperationKey timedOperation = entry.getKey();
+ if (timedOperation.category == category && timedOperation.label != null) {
+ ret.put(timedOperation.label, entry.getValue());
+ }
+ }
+
+ return ret;
+ }
+
+ public TimedResult getUnlabeledMeasurements(final TimedOperationCategory category) {
+ for (final Map.Entry<TimedOperationKey, TimedResult> entry : results.entrySet()) {
+ final TimedOperationKey timedOperation = entry.getKey();
+ if (timedOperation.category == category && timedOperation.label == null) {
+ return entry.getValue();
+ }
+ }
+
+ return null;
+ }
+
+ public long getWallClockMillis() {
+ return wallClockMillis;
+ }
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/TimingReportRenderer.java b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/TimingReportRenderer.java
new file mode 100644
index 00000000000..8bd8818c266
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/benchmark/TimingReportRenderer.java
@@ -0,0 +1,23 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.benchmark;
+
+import java.io.IOException;
+import java.io.Writer;
+
+/**
+ * Defines a renderer for {@link TimingReport}.
+ * @author Juan MartÃn Sotuyo Dodero
+ */
+public interface TimingReportRenderer {
+
+ /**
+ * Renders the given report into the given writer.
+ * @param report The report data to render
+ * @param writer The writer on which to render
+ * @throws IOException if the write operation fails
+ */
+ void render(TimingReport report, Writer writer) throws IOException;
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cache/AbstractAnalysisCache.java b/pmd-core/src/main/java/net/sourceforge/pmd/cache/AbstractAnalysisCache.java
index 6b128275cca..9a0fa6e5086 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/cache/AbstractAnalysisCache.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cache/AbstractAnalysisCache.java
@@ -5,15 +5,30 @@
package net.sourceforge.pmd.cache;
import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.net.URL;
import java.net.URLClassLoader;
-import java.util.Arrays;
+import java.nio.file.FileVisitOption;
+import java.nio.file.FileVisitResult;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.SimpleFileVisitor;
+import java.nio.file.attribute.BasicFileAttributes;
+import java.util.ArrayList;
import java.util.Collections;
+import java.util.EnumSet;
import java.util.List;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
+import java.util.logging.Level;
import java.util.logging.Logger;
+import java.util.zip.Adler32;
+import java.util.zip.CheckedInputStream;
-import net.sourceforge.pmd.PMD;
+import org.apache.commons.io.IOUtils;
+
+import net.sourceforge.pmd.PMDVersion;
import net.sourceforge.pmd.Rule;
import net.sourceforge.pmd.RuleSets;
import net.sourceforge.pmd.RuleViolation;
@@ -28,15 +43,16 @@ public abstract class AbstractAnalysisCache implements AnalysisCache {
protected final String pmdVersion;
protected final ConcurrentMap<String, AnalysisResult> fileResultsCache;
protected final ConcurrentMap<String, AnalysisResult> updatedResultsCache;
- protected long rulesetChecksum;
- protected long classpathChecksum;
protected final CachedRuleMapper ruleMapper = new CachedRuleMapper();
-
+ protected long rulesetChecksum;
+ protected long auxClassPathChecksum;
+ protected long executionClassPathChecksum;
+
/**
* Creates a new empty cache
*/
public AbstractAnalysisCache() {
- pmdVersion = PMD.VERSION;
+ pmdVersion = PMDVersion.VERSION;
fileResultsCache = new ConcurrentHashMap<>();
updatedResultsCache = new ConcurrentHashMap<>();
}
@@ -46,16 +62,24 @@ public boolean isUpToDate(final File sourceFile) {
// There is a new file being analyzed, prepare entry in updated cache
final AnalysisResult updatedResult = new AnalysisResult(sourceFile);
updatedResultsCache.put(sourceFile.getPath(), updatedResult);
-
+
// Now check the old cache
final AnalysisResult analysisResult = fileResultsCache.get(sourceFile.getPath());
-
- if (analysisResult == null) {
- // new file, need to analyze it
- return false;
+
+ // is this a known file? has it changed?
+ final boolean result = analysisResult != null
+ && analysisResult.getFileChecksum() == updatedResult.getFileChecksum();
+
+ if (LOG.isLoggable(Level.FINE)) {
+ if (result) {
+ LOG.fine("Incremental Analysis cache HIT");
+ } else {
+ LOG.fine("Incremental Analysis cache MISS - "
+ + (analysisResult != null ? "file changed" : "no previous result found"));
+ }
}
-
- return analysisResult.getFileChecksum() == updatedResult.getFileChecksum();
+
+ return result;
}
@Override
@@ -75,32 +99,46 @@ public void analysisFailed(final File sourceFile) {
updatedResultsCache.remove(sourceFile.getPath());
}
+
+ /**
+ * Returns true if the cache exists. If so, normal cache validity checks
+ * will be performed. Otherwise, the cache is necessarily invalid (e.g. on a first run).
+ */
+ protected abstract boolean cacheExists();
+
+
@Override
- public void checkValidity(final RuleSets ruleSets, final ClassLoader classLoader) {
- boolean cacheIsValid = true;
+ public void checkValidity(final RuleSets ruleSets, final ClassLoader auxclassPathClassLoader) {
+ boolean cacheIsValid = cacheExists();
- if (ruleSets.getChecksum() != rulesetChecksum) {
+ if (cacheIsValid && ruleSets.getChecksum() != rulesetChecksum) {
LOG.info("Analysis cache invalidated, rulesets changed.");
cacheIsValid = false;
}
- final long classLoaderChecksum;
- if (classLoader instanceof URLClassLoader) {
- final URLClassLoader urlClassLoader = (URLClassLoader) classLoader;
- classLoaderChecksum = Arrays.hashCode(urlClassLoader.getURLs());
-
- if (cacheIsValid && classLoaderChecksum != classpathChecksum) {
+ final long currentAuxClassPathChecksum;
+ if (auxclassPathClassLoader instanceof URLClassLoader) {
+ final URLClassLoader urlClassLoader = (URLClassLoader) auxclassPathClassLoader;
+ currentAuxClassPathChecksum = computeClassPathHash(urlClassLoader.getURLs());
+
+ if (cacheIsValid && currentAuxClassPathChecksum != auxClassPathChecksum) {
// Do we even care?
for (final Rule r : ruleSets.getAllRules()) {
- if (r.usesDFA() || r.usesTypeResolution()) {
- LOG.info("Analysis cache invalidated, classpath changed.");
+ if (r.isDfa() || r.isTypeResolution()) {
+ LOG.info("Analysis cache invalidated, auxclasspath changed.");
cacheIsValid = false;
break;
}
}
}
} else {
- classLoaderChecksum = 0;
+ currentAuxClassPathChecksum = 0;
+ }
+
+ final long currentExecutionClassPathChecksum = computeClassPathHash(getClassPathEntries());
+ if (cacheIsValid && currentExecutionClassPathChecksum != executionClassPathChecksum) {
+ LOG.info("Analysis cache invalidated, execution classpath changed.");
+ cacheIsValid = false;
}
if (!cacheIsValid) {
@@ -110,14 +148,66 @@ public void checkValidity(final RuleSets ruleSets, final ClassLoader classLoader
// Update the local checksums
rulesetChecksum = ruleSets.getChecksum();
- classpathChecksum = classLoaderChecksum;
+ auxClassPathChecksum = currentAuxClassPathChecksum;
+ executionClassPathChecksum = currentExecutionClassPathChecksum;
ruleMapper.initialize(ruleSets);
}
+ private URL[] getClassPathEntries() {
+ final String classpath = System.getProperty("java.class.path");
+ final String[] classpathEntries = classpath.split(File.pathSeparator);
+ final List<URL> entries = new ArrayList<>();
+
+ try {
+ for (final String entry : classpathEntries) {
+ final File f = new File(entry);
+ if (f.isFile()) {
+ entries.add(f.toURI().toURL());
+ } else {
+ Files.walkFileTree(f.toPath(), EnumSet.of(FileVisitOption.FOLLOW_LINKS), Integer.MAX_VALUE,
+ new SimpleFileVisitor<Path>() {
+ @Override
+ public FileVisitResult visitFile(final Path file,
+ final BasicFileAttributes attrs) throws IOException {
+ if (!attrs.isSymbolicLink()) { // Broken link that can't be followed
+ entries.add(file.toUri().toURL());
+ }
+ return FileVisitResult.CONTINUE;
+ }
+ });
+ }
+ }
+ } catch (final IOException e) {
+ LOG.log(Level.SEVERE, "Incremental analysis can't check execution classpath contents", e);
+ throw new RuntimeException(e);
+ }
+
+ return entries.toArray(new URL[0]);
+ }
+
+ private long computeClassPathHash(final URL... classpathEntry) {
+ final Adler32 adler32 = new Adler32();
+ for (final URL url : classpathEntry) {
+ try (CheckedInputStream inputStream = new CheckedInputStream(url.openStream(), adler32)) {
+ // Just read it, the CheckedInputStream will update the checksum on it's own
+ while (IOUtils.skip(inputStream, Long.MAX_VALUE) == Long.MAX_VALUE) {
+ // just loop
+ }
+ } catch (final FileNotFoundException ignored) {
+ LOG.warning("Auxclasspath entry " + url.toString() + " doesn't exist, ignoring it");
+ } catch (final IOException e) {
+ // Can this even happen?
+ LOG.log(Level.SEVERE, "Incremental analysis can't check auxclasspath contents", e);
+ throw new RuntimeException(e);
+ }
+ }
+ return adler32.getValue();
+ }
+
@Override
public void ruleViolationAdded(final RuleViolation ruleViolation) {
final AnalysisResult analysisResult = updatedResultsCache.get(ruleViolation.getFilename());
-
+
analysisResult.addViolation(ruleViolation);
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cache/AnalysisCache.java b/pmd-core/src/main/java/net/sourceforge/pmd/cache/AnalysisCache.java
index c2632d74c21..001e3acb6d2 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/cache/AnalysisCache.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cache/AnalysisCache.java
@@ -13,16 +13,22 @@
/**
* An analysis cache for incremental analysis.
+ * Simultaneously manages the old version of the cache,
+ * and the new, most up-to-date violation cache.
*/
public interface AnalysisCache extends ThreadSafeReportListener {
/**
- * Persist the analysis results on whatever means is used by the cache
+ * Persists the updated analysis results on whatever medium is used by the cache.
*/
void persist();
/**
- * Check if a given file is up to date in the cache and can be skipped from analysis
+ * Checks if a given file is up to date in the cache and can be skipped from analysis.
+ * Regardless of the return value of this method, each call adds the parameter to the
+ * updated cache, which allows {@link #ruleViolationAdded(RuleViolation)} to add a rule
+ * violation to the file. TODO is this really best behaviour? This side-effects seems counter-intuitive.
+ *
* @param sourceFile The file to check in the cache
* @return True if the cache is a hit, false otherwise
*/
@@ -36,15 +42,19 @@ public interface AnalysisCache extends ThreadSafeReportListener {
List<RuleViolation> getCachedViolations(File sourceFile);
/**
- * Notifies the cache that analysis of the given file has failed and should not be cached
+ * Notifies the cache that analysis of the given file has failed and should not be cached.
* @param sourceFile The file whose analysis failed
*/
void analysisFailed(File sourceFile);
/**
* Checks if the cache is valid for the configured rulesets and class loader.
+ * If the provided rulesets and classpath don't match those of the cache, the
+ * cache is invalidated. This needs to be called before analysis, as it
+ * conditions the good behaviour of {@link #isUpToDate(File)}.
+ *
* @param ruleSets The rulesets configured for this analysis.
- * @param classLoader The class loader configured for this analysis.
+ * @param auxclassPathClassLoader The class loader for auxclasspath configured for this analysis.
*/
- void checkValidity(RuleSets ruleSets, ClassLoader classLoader);
+ void checkValidity(RuleSets ruleSets, ClassLoader auxclassPathClassLoader);
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cache/AnalysisResult.java b/pmd-core/src/main/java/net/sourceforge/pmd/cache/AnalysisResult.java
index 5475556b481..4e4569bedeb 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/cache/AnalysisResult.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cache/AnalysisResult.java
@@ -38,15 +38,15 @@ public AnalysisResult(final File sourceFile) {
private static long computeFileChecksum(final File sourceFile) {
try (
CheckedInputStream stream = new CheckedInputStream(
- new BufferedInputStream(new FileInputStream(sourceFile)), new Adler32());
+ new BufferedInputStream(new FileInputStream(sourceFile)), new Adler32());
) {
// Just read it, the CheckedInputStream will update the checksum on it's own
IOUtils.skipFully(stream, sourceFile.length());
return stream.getChecksum().getValue();
- } catch (final IOException e) {
+ } catch (final IOException ignored) {
// We don't really care, if it's unreadable
- // the analysis will fail and report the error on it's own
+ // the analysis will fail and report the error on it's own since the checksum won't match
}
return 0;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cache/FileAnalysisCache.java b/pmd-core/src/main/java/net/sourceforge/pmd/cache/FileAnalysisCache.java
index 450f9701e50..84065947154 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/cache/FileAnalysisCache.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cache/FileAnalysisCache.java
@@ -17,7 +17,7 @@
import java.util.List;
import java.util.Map;
-import net.sourceforge.pmd.PMD;
+import net.sourceforge.pmd.PMDVersion;
import net.sourceforge.pmd.RuleViolation;
/**
@@ -26,7 +26,7 @@
public class FileAnalysisCache extends AbstractAnalysisCache {
private final File cacheFile;
-
+
/**
* Creates a new cache backed by the given file, and attempts to load pre-existing data from it.
* @param cache The file on which to store analysis cache
@@ -43,25 +43,26 @@ public FileAnalysisCache(final File cache) {
* @param cacheFile The file which backs the file analysis cache.
*/
private void loadFromFile(final File cacheFile) {
- if (cacheFile.exists()) {
+ if (cacheExists()) {
try (
DataInputStream inputStream = new DataInputStream(
new BufferedInputStream(new FileInputStream(cacheFile)));
) {
final String cacheVersion = inputStream.readUTF();
-
- if (PMD.VERSION.equals(cacheVersion)) {
+
+ if (PMDVersion.VERSION.equals(cacheVersion)) {
// Cache seems valid, load the rest
-
+
// Get checksums
rulesetChecksum = inputStream.readLong();
- classpathChecksum = inputStream.readLong();
-
+ auxClassPathChecksum = inputStream.readLong();
+ executionClassPathChecksum = inputStream.readLong();
+
// Cached results
while (inputStream.available() > 0) {
final String fileName = inputStream.readUTF();
final long checksum = inputStream.readLong();
-
+
final int countViolations = inputStream.readInt();
final List<RuleViolation> violations = new ArrayList<>(countViolations);
for (int i = 0; i < countViolations; i++) {
@@ -70,21 +71,33 @@ private void loadFromFile(final File cacheFile) {
fileResultsCache.put(fileName, new AnalysisResult(checksum, violations));
}
+
+ LOG.info("Analysis cache loaded");
} else {
LOG.info("Analysis cache invalidated, PMD version changed.");
}
} catch (final EOFException e) {
LOG.warning("Cache file " + cacheFile.getPath() + " is malformed, will not be used for current analysis");
} catch (final IOException e) {
- LOG.severe("Could not load analysis cache to file. " + e.getMessage());
+ LOG.severe("Could not load analysis cache from file. " + e.getMessage());
}
+ } else if (cacheFile.isDirectory()) {
+ LOG.severe("The configured cache location must be the path to a file, but is a directory.");
}
}
@Override
public void persist() {
+
+ if (cacheFile.isDirectory()) {
+ LOG.severe("Cannot persist the cache, the given path points to a directory.");
+ return;
+ }
+
+ boolean cacheFileShouldBeCreated = !cacheFile.exists();
+
// Create directories missing along the way
- if (!cacheFile.exists()) {
+ if (cacheFileShouldBeCreated) {
final File parentFile = cacheFile.getAbsoluteFile().getParentFile();
if (parentFile != null && !parentFile.exists()) {
parentFile.mkdirs();
@@ -93,26 +106,38 @@ public void persist() {
try (
DataOutputStream outputStream = new DataOutputStream(
- new BufferedOutputStream(new FileOutputStream(cacheFile)));
+ new BufferedOutputStream(new FileOutputStream(cacheFile)))
) {
outputStream.writeUTF(pmdVersion);
-
+
outputStream.writeLong(rulesetChecksum);
- outputStream.writeLong(classpathChecksum);
-
+ outputStream.writeLong(auxClassPathChecksum);
+ outputStream.writeLong(executionClassPathChecksum);
+
for (final Map.Entry<String, AnalysisResult> resultEntry : updatedResultsCache.entrySet()) {
final List<RuleViolation> violations = resultEntry.getValue().getViolations();
outputStream.writeUTF(resultEntry.getKey());
outputStream.writeLong(resultEntry.getValue().getFileChecksum());
-
+
outputStream.writeInt(violations.size());
for (final RuleViolation rv : violations) {
CachedRuleViolation.storeToStream(outputStream, rv);
}
}
+ if (cacheFileShouldBeCreated) {
+ LOG.info("Analysis cache created");
+ } else {
+ LOG.info("Analysis cache updated");
+ }
} catch (final IOException e) {
LOG.severe("Could not persist analysis cache to file. " + e.getMessage());
}
}
+
+
+ @Override
+ protected boolean cacheExists() {
+ return cacheFile.exists() && cacheFile.isFile() && cacheFile.length() > 0;
+ }
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cache/NoopAnalysisCache.java b/pmd-core/src/main/java/net/sourceforge/pmd/cache/NoopAnalysisCache.java
index b723ccc4c84..bbab1088ac8 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/cache/NoopAnalysisCache.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cache/NoopAnalysisCache.java
@@ -16,7 +16,7 @@
* A NOOP analysis cache. Easier / safer than null-checking.
*/
public class NoopAnalysisCache implements AnalysisCache {
-
+
@Override
public void ruleViolationAdded(final RuleViolation ruleViolation) {
// noop
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cli/PMDCommandLineInterface.java b/pmd-core/src/main/java/net/sourceforge/pmd/cli/PMDCommandLineInterface.java
index ca00f441c43..03fe697a36e 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/cli/PMDCommandLineInterface.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cli/PMDCommandLineInterface.java
@@ -7,6 +7,7 @@
import java.util.Properties;
import net.sourceforge.pmd.PMD;
+import net.sourceforge.pmd.PMDVersion;
import net.sourceforge.pmd.lang.LanguageRegistry;
import net.sourceforge.pmd.properties.PropertyDescriptor;
import net.sourceforge.pmd.renderers.Renderer;
@@ -19,7 +20,7 @@
* @author Romain Pelisse <belaran@gmail.com>
*
*/
-public class PMDCommandLineInterface {
+public final class PMDCommandLineInterface {
public static final String PROG_NAME = "pmd";
@@ -93,7 +94,7 @@ private static String getExamples() {
private static String getWindowsLaunchCmd() {
final String WINDOWS_PROMPT = "C:\\>";
- final String launchCmd = "pmd-bin-" + PMD.VERSION + "\\bin\\pmd.bat";
+ final String launchCmd = "pmd-bin-" + PMDVersion.VERSION + "\\bin\\pmd.bat";
return WINDOWS_PROMPT + launchCmd;
}
@@ -101,25 +102,19 @@ private static String getWindowsExample() {
final String launchCmd = getWindowsLaunchCmd();
final String WINDOWS_PATH_TO_CODE = "c:\\my\\source\\code ";
- return "For example on windows: " + PMD.EOL + launchCmd + " -dir " + WINDOWS_PATH_TO_CODE
- + "-format text -R java-unusedcode,java-imports -version 1.5 -language java -debug" + PMD.EOL
- + launchCmd + " -dir " + WINDOWS_PATH_TO_CODE
- + "-f xml -rulesets java-basic,java-design -encoding UTF-8" + PMD.EOL + launchCmd + " -d "
- + WINDOWS_PATH_TO_CODE + "-rulesets java-typeresolution -auxclasspath commons-collections.jar;derby.jar"
- + PMD.EOL + launchCmd + " -d " + WINDOWS_PATH_TO_CODE
- + "-f html -R java-typeresolution -auxclasspath file:///C:/my/classpathfile" + PMD.EOL + PMD.EOL;
+ return "For example on windows: " + PMD.EOL
+ + launchCmd + " -dir " + WINDOWS_PATH_TO_CODE + "-format text -R rulesets/java/quickstart.xml -version 1.5 -language java -debug" + PMD.EOL
+ + launchCmd + " -dir " + WINDOWS_PATH_TO_CODE + "-f xml -rulesets rulesets/java/quickstart.xml,category/java/codestyle.xml -encoding UTF-8" + PMD.EOL
+ + launchCmd + " -d " + WINDOWS_PATH_TO_CODE + "-rulesets rulesets/java/quickstart.xml -auxclasspath lib\\commons-collections.jar;lib\\derby.jar" + PMD.EOL
+ + launchCmd + " -d " + WINDOWS_PATH_TO_CODE + "-f html -R rulesets/java/quickstart.xml -auxclasspath file:///C:/my/classpathfile" + PMD.EOL + PMD.EOL;
}
private static String getUnixExample() {
- final String UNIX_PROMPT = "$ ";
- final String launchCmd = "pmd-bin-" + PMD.VERSION + "/bin/run.sh pmd";
- return "For example on *nix: " + PMD.EOL + UNIX_PROMPT + launchCmd
- + " -dir /home/workspace/src/main/java/code -f html -rulesets java-basic,java-design" + PMD.EOL
- + UNIX_PROMPT + launchCmd
- + " -d ./src/main/java/code -f xslt -R java-basic,java-design -property xsltFilename=my-own.xsl"
- + PMD.EOL + UNIX_PROMPT + launchCmd
- + " -d ./src/main/java/code -f html -R java-typeresolution -auxclasspath commons-collections.jar:derby.jar"
- + PMD.EOL;
+ final String launchCmd = "$ pmd-bin-" + PMDVersion.VERSION + "/bin/run.sh pmd";
+ return "For example on *nix: " + PMD.EOL
+ + launchCmd + " -dir /home/workspace/src/main/java/code -f html -rulesets rulesets/java/quickstart.xml,category/java/codestyle.xml" + PMD.EOL
+ + launchCmd + " -d ./src/main/java/code -R rulesets/java/quickstart.xml -f xslt -property xsltFilename=my-own.xsl" + PMD.EOL
+ + launchCmd + " -d ./src/main/java/code -f html -R rulesets/java/quickstart.xml -auxclasspath commons-collections.jar:derby.jar" + PMD.EOL;
}
private static String supportedVersions() {
@@ -138,7 +133,7 @@ public static void main(String[] args) {
}
public static String jarName() {
- return "pmd-" + PMD.VERSION + ".jar";
+ return "pmd-" + PMDVersion.VERSION + ".jar";
}
private static String getReports() {
@@ -183,7 +178,7 @@ private static boolean isExitAfterRunSet() {
if (noExit == null) {
noExit = System.getProperty(NO_EXIT_AFTER_RUN);
}
- return (noExit == null ? true : false);
+ return noExit == null;
}
private static void setStatusCode(int statusCode) {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cli/PMDParameters.java b/pmd-core/src/main/java/net/sourceforge/pmd/cli/PMDParameters.java
index acf68c391c1..218a40923de 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/cli/PMDParameters.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cli/PMDParameters.java
@@ -15,6 +15,7 @@
import net.sourceforge.pmd.lang.LanguageVersion;
import com.beust.jcommander.IStringConverter;
+import com.beust.jcommander.IValueValidator;
import com.beust.jcommander.Parameter;
import com.beust.jcommander.ParameterException;
import com.beust.jcommander.validators.PositiveInteger;
@@ -25,16 +26,18 @@ public class PMDParameters {
required = true)
private String rulesets;
- @Parameter(names = { "-uri", "-u" }, description = "Database URI for sources.", required = false)
+ @Parameter(names = { "-uri", "-u" }, description = "Database URI for sources.")
private String uri;
- @Parameter(names = { "-dir", "-d" }, description = "Root directory for sources.", required = false)
+ @Parameter(names = { "-dir", "-d" }, description = "Root directory for sources.")
private String sourceDir;
- @Parameter(names = { "-filelist" }, description = "Path to a file containing a list of files to analyze.",
- required = false)
+ @Parameter(names = "-filelist", description = "Path to a file containing a list of files to analyze.")
private String fileListPath;
+ @Parameter(names = "-ignorelist", description = "Path to a file containing a list of files to ignore.")
+ private String ignoreListPath;
+
@Parameter(names = { "-format", "-f" }, description = "Report format type.")
private String format = "text"; // Enhance to support other usage
@@ -50,7 +53,7 @@ public class PMDParameters {
@Parameter(names = { "-threads", "-t" }, description = "Sets the number of threads used by PMD.",
validateWith = PositiveInteger.class)
- private Integer threads = 1;
+ private int threads = 1;
@Parameter(names = { "-benchmark", "-b" },
description = "Benchmark mode - output a benchmark report upon completion; default to System.err.")
@@ -66,13 +69,14 @@ public class PMDParameters {
private boolean showsuppressed = false;
@Parameter(names = "-suppressmarker",
- description = "Specifies the string that marks the a line which PMD should ignore; default is NOPMD.")
+ description = "Specifies the string that marks a line which PMD should ignore; default is NOPMD.")
private String suppressmarker = "NOPMD";
@Parameter(names = { "-minimumpriority", "-min" },
- description = "Rule priority threshold; rules with lower priority than configured here won't be used. Default is '5' which is the lowest priority.",
- converter = RulePriorityConverter.class)
- private RulePriority minimumPriority = RulePriority.LOW;
+ description = "Rule priority threshold; rules with lower priority than configured here won't be used. "
+ + "Valid values are integers between 1 and 5 (inclusive), with 5 being the lowest priority.",
+ validateValueWith = RulePriorityValidator.class)
+ private int minimumPriority = RulePriority.LOW.getPriority();
@Parameter(names = { "-property", "-P" }, description = "{name}={value}: Define a property for the report format.",
converter = PropertyConverter.class)
@@ -98,10 +102,17 @@ public class PMDParameters {
@Parameter(names = "-norulesetcompatibility",
description = "Disable the ruleset compatibility filter. The filter is active by default and tries automatically 'fix' old ruleset files with old rule names")
private boolean noRuleSetCompatibility = false;
-
- @Parameter(names = "-cache", description = "Specify the location of the cache file for incremental analysis.")
+
+ @Parameter(names = "-cache", arity = 1,
+ description = "Specify the location of the cache file for incremental analysis. "
+ + "This should be the full path to the file, including the desired file name (not just the parent directory). "
+ + "If the file doesn't exist, it will be created on the first run. The file will be overwritten on each run "
+ + "with the most up-to-date rule violations.")
private String cacheLocation = null;
+ @Parameter(names = "-no-cache", description = "Explicitly disable incremental analysis. The '-cache' option is ignored if this switch is present in the command line.")
+ private boolean noCache = false;
+
// this has to be a public static class, so that JCommander can use it!
public static class PropertyConverter implements IStringConverter<Properties> {
@@ -122,7 +133,20 @@ public Properties convert(String value) {
}
}
+
// this has to be a public static class, so that JCommander can use it!
+ public static class RulePriorityValidator implements IValueValidator<Integer> {
+
+ @Override
+ public void validate(String name, Integer value) throws ParameterException {
+ if (value < 1 || value > 5) {
+ throw new ParameterException("Priority values can only be integer value, between 1 and 5," + value + " is not valid");
+ }
+ }
+ }
+
+ /** @deprecated Will be removed in 7.0.0 */
+ @Deprecated
public static class RulePriorityConverter implements IStringConverter<RulePriority> {
public int validate(String value) throws ParameterException {
@@ -140,45 +164,70 @@ public RulePriority convert(String value) {
}
}
- public static PMDConfiguration transformParametersIntoConfiguration(PMDParameters params) {
- if (null == params.getSourceDir() && null == params.getUri() && null == params.getFileListPath()) {
+
+ /**
+ * Converts these parameters into a configuration.
+ *
+ * @return A new PMDConfiguration corresponding to these parameters
+ *
+ * @throws IllegalArgumentException if the parameters are inconsistent or incomplete
+ */
+ public PMDConfiguration toConfiguration() {
+ if (null == this.getSourceDir() && null == this.getUri() && null == this.getFileListPath()) {
throw new IllegalArgumentException(
"Please provide a parameter for source root directory (-dir or -d), database URI (-uri or -u), or file list path (-filelist).");
}
PMDConfiguration configuration = new PMDConfiguration();
- configuration.setInputPaths(params.getSourceDir());
- configuration.setInputFilePath(params.getFileListPath());
- configuration.setInputUri(params.getUri());
- configuration.setReportFormat(params.getFormat());
- configuration.setBenchmark(params.isBenchmark());
- configuration.setDebug(params.isDebug());
- configuration.setMinimumPriority(params.getMinimumPriority());
- configuration.setReportFile(params.getReportfile());
- configuration.setReportProperties(params.getProperties());
- configuration.setReportShortNames(params.isShortnames());
- configuration.setRuleSets(params.getRulesets());
- configuration.setRuleSetFactoryCompatibilityEnabled(!params.noRuleSetCompatibility);
- configuration.setShowSuppressedViolations(params.isShowsuppressed());
- configuration.setSourceEncoding(params.getEncoding());
- configuration.setStressTest(params.isStress());
- configuration.setSuppressMarker(params.getSuppressmarker());
- configuration.setThreads(params.getThreads());
- configuration.setFailOnViolation(params.isFailOnViolation());
- configuration.setAnalysisCacheLocation(params.cacheLocation);
+ configuration.setInputPaths(this.getSourceDir());
+ configuration.setInputFilePath(this.getFileListPath());
+ configuration.setIgnoreFilePath(this.getIgnoreListPath());
+ configuration.setInputUri(this.getUri());
+ configuration.setReportFormat(this.getFormat());
+ configuration.setBenchmark(this.isBenchmark());
+ configuration.setDebug(this.isDebug());
+ configuration.setMinimumPriority(this.getMinimumPriority());
+ configuration.setReportFile(this.getReportfile());
+ configuration.setReportProperties(this.getProperties());
+ configuration.setReportShortNames(this.isShortnames());
+ configuration.setRuleSets(this.getRulesets());
+ configuration.setRuleSetFactoryCompatibilityEnabled(!this.noRuleSetCompatibility);
+ configuration.setShowSuppressedViolations(this.isShowsuppressed());
+ configuration.setSourceEncoding(this.getEncoding());
+ configuration.setStressTest(this.isStress());
+ configuration.setSuppressMarker(this.getSuppressmarker());
+ configuration.setThreads(this.getThreads());
+ configuration.setFailOnViolation(this.isFailOnViolation());
+ configuration.setAnalysisCacheLocation(this.cacheLocation);
+ configuration.setIgnoreIncrementalAnalysis(this.isIgnoreIncrementalAnalysis());
LanguageVersion languageVersion = LanguageRegistry
- .findLanguageVersionByTerseName(params.getLanguage() + " " + params.getVersion());
+ .findLanguageVersionByTerseName(this.getLanguage() + ' ' + this.getVersion());
if (languageVersion != null) {
configuration.getLanguageVersionDiscoverer().setDefaultLanguageVersion(languageVersion);
}
try {
- configuration.prependClasspath(params.getAuxclasspath());
+ configuration.prependClasspath(this.getAuxclasspath());
} catch (IOException e) {
throw new IllegalArgumentException("Invalid auxiliary classpath: " + e.getMessage(), e);
}
return configuration;
}
+
+ public boolean isIgnoreIncrementalAnalysis() {
+ return noCache;
+ }
+
+
+ /**
+ * {@link #toConfiguration()}.
+ * @deprecated To be removed in 7.0.0. Use the instance method {@link #toConfiguration()}.
+ */
+ @Deprecated
+ public static PMDConfiguration transformParametersIntoConfiguration(PMDParameters params) {
+ return params.toConfiguration();
+ }
+
public boolean isDebug() {
return debug;
}
@@ -216,7 +265,7 @@ public String getSuppressmarker() {
}
public RulePriority getMinimumPriority() {
- return minimumPriority;
+ return RulePriority.valueOf(minimumPriority);
}
public Properties getProperties() {
@@ -258,6 +307,10 @@ public String getFileListPath() {
return fileListPath;
}
+ public String getIgnoreListPath() {
+ return ignoreListPath;
+ }
+
public String getFormat() {
return format;
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/AbstractTokenizer.java b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/AbstractTokenizer.java
index 296deb83479..7309fd2f4c7 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/AbstractTokenizer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/AbstractTokenizer.java
@@ -5,6 +5,7 @@
package net.sourceforge.pmd.cpd;
import java.util.List;
+import java.util.Locale;
/**
*
@@ -51,7 +52,7 @@ public void tokenize(SourceCode tokens, Tokens tokenEntries) {
loc = getTokenFromLine(token, loc);
if (token.length() > 0 && !isIgnorableString(token.toString())) {
if (downcaseString) {
- token = new StringBuilder(token.toString().toLowerCase());
+ token = new StringBuilder(token.toString().toLowerCase(Locale.ROOT));
}
// need to re-think how to link this
// if ( CPD.debugEnable ) {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/AntlrTokenizer.java b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/AntlrTokenizer.java
new file mode 100644
index 00000000000..aad0d2379ab
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/AntlrTokenizer.java
@@ -0,0 +1,54 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.cpd;
+
+import org.antlr.v4.runtime.CharStream;
+import org.antlr.v4.runtime.CharStreams;
+import org.antlr.v4.runtime.Token;
+
+import net.sourceforge.pmd.cpd.token.AntlrToken;
+import net.sourceforge.pmd.lang.antlr.AntlrTokenManager;
+import net.sourceforge.pmd.lang.ast.TokenMgrError;
+
+/**
+ * Generic implementation of a {@link Tokenizer} useful to any Antlr grammar.
+ */
+public abstract class AntlrTokenizer implements Tokenizer {
+
+ protected abstract AntlrTokenManager getLexerForSource(SourceCode sourceCode);
+
+ @Override
+ public void tokenize(final SourceCode sourceCode, final Tokens tokenEntries) {
+
+ AntlrTokenManager tokenManager = getLexerForSource(sourceCode);
+
+ try {
+ AntlrToken token = (AntlrToken) tokenManager.getNextToken();
+
+ while (token.getType() != Token.EOF) {
+ if (!token.isHidden()) {
+ final TokenEntry tokenEntry =
+ new TokenEntry(token.getImage(), tokenManager.getFileName(), token.getBeginLine());
+
+ tokenEntries.add(tokenEntry);
+ }
+ token = (AntlrToken) tokenManager.getNextToken();
+ }
+ } catch (final AntlrTokenManager.ANTLRSyntaxError err) {
+ // Wrap exceptions of the ANTLR tokenizer in a TokenMgrError, so they are correctly handled
+ // when CPD is executed with the '--skipLexicalErrors' command line option
+ throw new TokenMgrError("Lexical error in file " + tokenManager.getFileName() + " at line "
+ + err.getLine() + ", column " + err.getColumn() + ". Encountered: " + err.getMessage(),
+ TokenMgrError.LEXICAL_ERROR);
+ } finally {
+ tokenEntries.add(TokenEntry.getEOF());
+ }
+ }
+
+ /* default */ static CharStream getCharStreamFromSourceCode(final SourceCode sourceCode) {
+ StringBuilder buffer = sourceCode.getCodeBuffer();
+ return CharStreams.fromString(buffer.toString());
+ }
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/AnyTokenizer.java b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/AnyTokenizer.java
index 8983f90bfee..2e9745bb8e5 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/AnyTokenizer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/AnyTokenizer.java
@@ -6,11 +6,9 @@
import java.io.BufferedReader;
import java.io.CharArrayReader;
-import java.util.NoSuchElementException;
+import java.io.IOException;
import java.util.StringTokenizer;
-import org.apache.commons.io.IOUtils;
-
/**
* This class does a best-guess try-anything tokenization.
*
@@ -22,31 +20,24 @@ public class AnyTokenizer implements Tokenizer {
@Override
public void tokenize(SourceCode sourceCode, Tokens tokenEntries) {
StringBuilder sb = sourceCode.getCodeBuffer();
- BufferedReader reader = new BufferedReader(new CharArrayReader(sb.toString().toCharArray()));
- try {
+ try (BufferedReader reader = new BufferedReader(new CharArrayReader(sb.toString().toCharArray()))) {
int lineNumber = 1;
String line = reader.readLine();
while (line != null) {
StringTokenizer tokenizer = new StringTokenizer(line, TOKENS, true);
- try {
+ while (tokenizer.hasMoreTokens()) {
String token = tokenizer.nextToken();
- while (token != null) {
- if (!" ".equals(token) && !"\t".equals(token)) {
- tokenEntries.add(new TokenEntry(token, sourceCode.getFileName(), lineNumber));
- }
- token = tokenizer.nextToken();
+ if (!" ".equals(token) && !"\t".equals(token)) {
+ tokenEntries.add(new TokenEntry(token, sourceCode.getFileName(), lineNumber));
}
- } catch (NoSuchElementException ex) {
- // done with tokens
}
// advance iteration variables
line = reader.readLine();
lineNumber++;
}
- } catch (Exception ex) {
- ex.printStackTrace();
+ } catch (IOException ignored) {
+ ignored.printStackTrace();
} finally {
- IOUtils.closeQuietly(reader);
tokenEntries.add(TokenEntry.getEOF());
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/CPDCommandLineInterface.java b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/CPDCommandLineInterface.java
index ffb4bc1d190..5a2f9d80fa8 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/CPDCommandLineInterface.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/CPDCommandLineInterface.java
@@ -4,9 +4,11 @@
package net.sourceforge.pmd.cpd;
+import java.io.BufferedWriter;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
+import java.io.OutputStreamWriter;
import java.net.URISyntaxException;
import java.util.ArrayList;
import java.util.Arrays;
@@ -14,13 +16,14 @@
import java.util.logging.Logger;
import net.sourceforge.pmd.PMD;
+import net.sourceforge.pmd.PMDVersion;
import net.sourceforge.pmd.util.FileUtil;
import net.sourceforge.pmd.util.database.DBURI;
import com.beust.jcommander.JCommander;
import com.beust.jcommander.ParameterException;
-public class CPDCommandLineInterface {
+public final class CPDCommandLineInterface {
private static final Logger LOGGER = Logger.getLogger(CPDCommandLineInterface.class.getName());
private static final int DUPLICATE_CODE_FOUND = 4;
@@ -46,7 +49,7 @@ private static boolean isExitAfterRunSet() {
if (noExit == null) {
noExit = System.getProperty(NO_EXIT_AFTER_RUN);
}
- return (noExit == null ? true : false);
+ return noExit == null;
}
private static void setStatusCode(int statusCode) {
@@ -83,7 +86,12 @@ public static void main(String[] args) {
addSourceFilesToCPD(cpd, arguments);
cpd.go();
- System.out.println(arguments.getRenderer().render(cpd.getMatches()));
+ if (arguments.getCPDRenderer() == null) {
+ // legacy writer
+ System.out.println(arguments.getRenderer().render(cpd.getMatches()));
+ } else {
+ arguments.getCPDRenderer().render(cpd.getMatches(), new BufferedWriter(new OutputStreamWriter(System.out)));
+ }
if (cpd.getMatches().hasNext()) {
if (arguments.isFailOnViolation()) {
setStatusCodeOrExit(DUPLICATE_CODE_FOUND);
@@ -93,7 +101,7 @@ public static void main(String[] args) {
} else {
setStatusCodeOrExit(0);
}
- } catch (RuntimeException e) {
+ } catch (IOException | RuntimeException e) {
e.printStackTrace();
setStatusCodeOrExit(ERROR_STATUS);
}
@@ -177,12 +185,12 @@ private static void addSourceURIToCPD(String uri, CPD cpd) {
public static String buildUsageText() {
String helpText = " For example on Windows:" + PMD.EOL;
- helpText += " C:\\>" + "pmd-bin-" + PMD.VERSION + "\\bin\\cpd.bat"
+ helpText += " C:\\>" + "pmd-bin-" + PMDVersion.VERSION + "\\bin\\cpd.bat"
+ " --minimum-tokens 100 --files c:\\jdk18\\src\\java" + PMD.EOL;
helpText += PMD.EOL;
helpText += " For example on *nix:" + PMD.EOL;
- helpText += " $ " + "pmd-bin-" + PMD.VERSION + "/bin/run.sh cpd"
+ helpText += " $ " + "pmd-bin-" + PMDVersion.VERSION + "/bin/run.sh cpd"
+ " --minimum-tokens 100 --files /path/to/java/code" + PMD.EOL;
helpText += PMD.EOL;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/CPDConfiguration.java b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/CPDConfiguration.java
index 1f9b4179123..ad5d8cee585 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/CPDConfiguration.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/CPDConfiguration.java
@@ -21,6 +21,7 @@
import java.util.Set;
import net.sourceforge.pmd.AbstractConfiguration;
+import net.sourceforge.pmd.cpd.renderer.CPDRenderer;
import net.sourceforge.pmd.util.FileFinder;
import net.sourceforge.pmd.util.FileUtil;
@@ -36,10 +37,17 @@
public class CPDConfiguration extends AbstractConfiguration {
public static final String DEFAULT_LANGUAGE = "java";
-
public static final String DEFAULT_RENDERER = "text";
- private static final Map<String, Class<? extends Renderer>> RENDERERS = new HashMap<>();
+ private static final Map<String, Class<? extends CPDRenderer>> RENDERERS = new HashMap<>();
+
+ static {
+ RENDERERS.put(DEFAULT_RENDERER, SimpleRenderer.class);
+ RENDERERS.put("xml", XMLRenderer.class);
+ RENDERERS.put("csv", CSVRenderer.class);
+ RENDERERS.put("csv_with_linecount_per_file", CSVWithLinecountPerFileRenderer.class);
+ RENDERERS.put("vs", VSRenderer.class);
+ }
@Parameter(names = "--language", description = "Sources code language. Default value is " + DEFAULT_LANGUAGE,
required = false, converter = LanguageConverter.class)
@@ -61,7 +69,10 @@ public class CPDConfiguration extends AbstractConfiguration {
* The actual renderer. constructed by using the {@link #rendererName}. This
* property is only valid after {@link #postContruct()} has been called!
*/
+ @Deprecated
private Renderer renderer;
+
+ private CPDRenderer cpdRenderer;
private String encoding;
@@ -133,9 +144,6 @@ public Language convert(String languageString) {
}
}
- public CPDConfiguration() {
- }
-
@Parameter(names = "--encoding", description = "Character encoding to use when processing files", required = false)
public void setEncoding(String encoding) {
this.encoding = encoding;
@@ -143,7 +151,7 @@ public void setEncoding(String encoding) {
}
public SourceCode sourceCodeFor(File file) {
- return new SourceCode(new SourceCode.FileCodeLoader(file, getSourceEncoding()));
+ return new SourceCode(new SourceCode.FileCodeLoader(file, getSourceEncoding().name()));
}
public SourceCode sourceCodeFor(Reader reader, String sourceCodeName) {
@@ -151,31 +159,33 @@ public SourceCode sourceCodeFor(Reader reader, String sourceCodeName) {
}
public void postContruct() {
- if (this.getLanguage() == null) {
- this.setLanguage(CPDConfiguration.getLanguageFromString(DEFAULT_LANGUAGE));
+ if (getLanguage() == null) {
+ setLanguage(CPDConfiguration.getLanguageFromString(DEFAULT_LANGUAGE));
}
- if (this.getRendererName() == null) {
- this.setRendererName(DEFAULT_RENDERER);
+ if (getRendererName() == null) {
+ setRendererName(DEFAULT_RENDERER);
}
- if (this.getRenderer() == null) {
- this.setRenderer(getRendererFromString(getRendererName(), this.getEncoding()));
+ if (getRenderer() == null && getCPDRenderer() == null) {
+ try {
+ setCPDRenderer(getCPDRendererFromString(getRendererName(), getEncoding()));
+ } catch (ClassCastException e) {
+ // The renderer class configured is not using the new CPDRenderer interface...
+ setRenderer(getRendererFromString(getRendererName(), getEncoding()));
+ }
}
}
- static {
- RENDERERS.put(DEFAULT_RENDERER, SimpleRenderer.class);
- RENDERERS.put("xml", XMLRenderer.class);
- RENDERERS.put("csv", CSVRenderer.class);
- RENDERERS.put("csv_with_linecount_per_file", CSVWithLinecountPerFileRenderer.class);
- RENDERERS.put("vs", VSRenderer.class);
- }
-
+ /**
+ * @deprecated Use {@link #getCPDRendererFromString(String, String)} instead
+ */
+ @Deprecated
public static Renderer getRendererFromString(String name, String encoding) {
String clazzname = name;
if (clazzname == null || "".equals(clazzname)) {
clazzname = DEFAULT_RENDERER;
}
- Class<? extends Renderer> clazz = RENDERERS.get(clazzname.toLowerCase(Locale.ROOT));
+ @SuppressWarnings("unchecked") // Safe, all standard implementations implement both interfaces
+ Class<? extends Renderer> clazz = (Class<? extends Renderer>) RENDERERS.get(clazzname.toLowerCase(Locale.ROOT));
if (clazz == null) {
try {
clazz = Class.forName(clazzname).asSubclass(Renderer.class);
@@ -193,8 +203,32 @@ public static Renderer getRendererFromString(String name, String encoding) {
return new SimpleRenderer();
}
}
+
+ public static CPDRenderer getCPDRendererFromString(String name, String encoding) {
+ String clazzname = name;
+ if (clazzname == null || "".equals(clazzname)) {
+ clazzname = DEFAULT_RENDERER;
+ }
+ Class<? extends CPDRenderer> clazz = RENDERERS.get(clazzname.toLowerCase(Locale.ROOT));
+ if (clazz == null) {
+ try {
+ clazz = Class.forName(clazzname).asSubclass(CPDRenderer.class);
+ } catch (ClassNotFoundException e) {
+ System.err.println("Can't find class '" + name + "', defaulting to SimpleRenderer.");
+ clazz = SimpleRenderer.class;
+ }
+ }
+ try {
+ CPDRenderer renderer = clazz.getDeclaredConstructor().newInstance();
+ setRendererEncoding(renderer, encoding);
+ return renderer;
+ } catch (Exception e) {
+ System.err.println("Couldn't instantiate renderer, defaulting to SimpleRenderer: " + e);
+ return new SimpleRenderer();
+ }
+ }
- private static void setRendererEncoding(Renderer renderer, String encoding)
+ private static void setRendererEncoding(Object renderer, String encoding)
throws IllegalAccessException, InvocationTargetException {
try {
PropertyDescriptor encodingProperty = new PropertyDescriptor("encoding", renderer.getClass());
@@ -202,7 +236,7 @@ private static void setRendererEncoding(Renderer renderer, String encoding)
if (method != null) {
method.invoke(renderer, encoding);
}
- } catch (IntrospectionException e) {
+ } catch (IntrospectionException ignored) {
// ignored - maybe this renderer doesn't have a encoding property
}
}
@@ -276,9 +310,17 @@ public void setRendererName(String rendererName) {
this.rendererName = rendererName;
}
+ /**
+ * @deprecated Use {@link #getCPDRenderer()} instead
+ */
+ @Deprecated
public Renderer getRenderer() {
return renderer;
}
+
+ public CPDRenderer getCPDRenderer() {
+ return cpdRenderer;
+ }
public Tokenizer tokenizer() {
if (language == null) {
@@ -309,7 +351,7 @@ public FilenameFilter filenameFilter() {
}
}
- FilenameFilter filter = new FilenameFilter() {
+ return new FilenameFilter() {
@Override
public boolean accept(File dir, String name) {
File f = new File(dir, name);
@@ -320,11 +362,21 @@ public boolean accept(File dir, String name) {
return languageFilter.accept(dir, name);
}
};
- return filter;
}
+ /**
+ * @deprecated Use {@link #setCPDRenderer(CPDRenderer)} instead
+ * @param renderer
+ */
+ @Deprecated
public void setRenderer(Renderer renderer) {
this.renderer = renderer;
+ this.cpdRenderer = null;
+ }
+
+ public void setCPDRenderer(CPDRenderer renderer) {
+ this.cpdRenderer = renderer;
+ this.renderer = null;
}
public boolean isIgnoreLiterals() {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/CPDNullListener.java b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/CPDNullListener.java
index dd0a132bf10..64b6060166b 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/CPDNullListener.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/CPDNullListener.java
@@ -9,9 +9,11 @@
public class CPDNullListener implements CPDListener {
@Override
public void addedFile(int fileCount, File file) {
+ // does nothing - override it if necessary
}
@Override
public void phaseUpdate(int phase) {
+ // does nothing - override it if necessary
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/CPDTask.java b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/CPDTask.java
index 46322d96abc..abf9f6e7076 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/CPDTask.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/CPDTask.java
@@ -4,8 +4,13 @@
package net.sourceforge.pmd.cpd;
+import java.io.BufferedWriter;
import java.io.File;
+import java.io.FileOutputStream;
import java.io.IOException;
+import java.io.OutputStream;
+import java.io.OutputStreamWriter;
+import java.io.Writer;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
@@ -18,6 +23,8 @@
import org.apache.tools.ant.types.EnumeratedAttribute;
import org.apache.tools.ant.types.FileSet;
+import net.sourceforge.pmd.cpd.renderer.CPDRenderer;
+
/**
* CPDTask
*
@@ -123,16 +130,28 @@ private void report(CPD cpd) throws ReportException {
if (!cpd.getMatches().hasNext()) {
log("No duplicates over " + minimumTokenCount + " tokens found", Project.MSG_INFO);
}
- Renderer renderer = createRenderer();
- FileReporter reporter;
- if (outputFile == null) {
- reporter = new FileReporter(encoding);
- } else if (outputFile.isAbsolute()) {
- reporter = new FileReporter(outputFile, encoding);
- } else {
- reporter = new FileReporter(new File(getProject().getBaseDir(), outputFile.toString()), encoding);
+ CPDRenderer renderer = createRenderer();
+
+ try {
+ final OutputStream os;
+ if (outputFile == null) {
+ os = System.out;
+ } else if (outputFile.isAbsolute()) {
+ os = new FileOutputStream(outputFile);
+ } else {
+ os = new FileOutputStream(new File(getProject().getBaseDir(), outputFile.toString()));
+ }
+
+ if (encoding == null) {
+ encoding = System.getProperty("file.encoding");
+ }
+
+ try (Writer writer = new BufferedWriter(new OutputStreamWriter(os, encoding))) {
+ renderer.render(cpd.getMatches(), writer);
+ }
+ } catch (IOException ioe) {
+ throw new ReportException(ioe);
}
- reporter.report(renderer.render(cpd.getMatches()));
}
private void tokenizeFiles(CPD cpd) throws IOException {
@@ -155,7 +174,7 @@ private long analyzeCode(CPD cpd) {
return stop - start;
}
- private Renderer createRenderer() {
+ private CPDRenderer createRenderer() {
if (format.equals(TEXT_FORMAT)) {
return new SimpleRenderer();
} else if (format.equals(CSV_FORMAT)) {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/CSVRenderer.java b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/CSVRenderer.java
index 197b39c6cd8..78260b43599 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/CSVRenderer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/CSVRenderer.java
@@ -4,16 +4,20 @@
package net.sourceforge.pmd.cpd;
+import java.io.IOException;
+import java.io.StringWriter;
+import java.io.Writer;
import java.util.Iterator;
import org.apache.commons.lang3.StringEscapeUtils;
import net.sourceforge.pmd.PMD;
+import net.sourceforge.pmd.cpd.renderer.CPDRenderer;
-public class CSVRenderer implements Renderer {
+public class CSVRenderer implements Renderer, CPDRenderer {
- private char separator;
- private boolean lineCountPerFile;
+ private final char separator;
+ private final boolean lineCountPerFile;
public static final char DEFAULT_SEPARATOR = ',';
public static final boolean DEFAULT_LINECOUNTPERFILE = false;
@@ -37,34 +41,44 @@ public CSVRenderer(char separatorChar, boolean lineCountPerFile) {
@Override
public String render(Iterator<Match> matches) {
- StringBuilder csv = new StringBuilder(1000);
+ StringWriter writer = new StringWriter(1000);
+ try {
+ render(matches, writer);
+ } catch (IOException ignored) {
+ // Not really possible with a StringWriter
+ }
+ return writer.toString();
+ }
+ @Override
+ public void render(Iterator<Match> matches, Writer writer) throws IOException {
if (!lineCountPerFile) {
- csv.append("lines").append(separator);
+ writer.append("lines").append(separator);
}
- csv.append("tokens").append(separator).append("occurrences").append(PMD.EOL);
+ writer.append("tokens").append(separator).append("occurrences").append(PMD.EOL);
while (matches.hasNext()) {
Match match = matches.next();
if (!lineCountPerFile) {
- csv.append(match.getLineCount()).append(separator);
+ writer.append(String.valueOf(match.getLineCount())).append(separator);
}
- csv.append(match.getTokenCount()).append(separator).append(match.getMarkCount()).append(separator);
+ writer.append(String.valueOf(match.getTokenCount())).append(separator)
+ .append(String.valueOf(match.getMarkCount())).append(separator);
for (Iterator<Mark> marks = match.iterator(); marks.hasNext();) {
Mark mark = marks.next();
- csv.append(mark.getBeginLine()).append(separator);
+ writer.append(String.valueOf(mark.getBeginLine())).append(separator);
if (lineCountPerFile) {
- csv.append(mark.getLineCount()).append(separator);
+ writer.append(String.valueOf(mark.getLineCount())).append(separator);
}
- csv.append(StringEscapeUtils.escapeCsv(mark.getFilename()));
+ writer.append(StringEscapeUtils.escapeCsv(mark.getFilename()));
if (marks.hasNext()) {
- csv.append(separator);
+ writer.append(separator);
}
}
- csv.append(PMD.EOL);
+ writer.append(PMD.EOL);
}
- return csv.toString();
+ writer.flush();
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/FileReporter.java b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/FileReporter.java
index 75de5b14d5e..033171a34ce 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/FileReporter.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/FileReporter.java
@@ -6,17 +6,20 @@
import java.io.BufferedWriter;
import java.io.File;
+import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.Writer;
-import org.apache.commons.io.IOUtils;
+import net.sourceforge.pmd.cpd.renderer.CPDRenderer;
/**
* @author Philippe T'Seyen
+ * @deprecated {@link CPDRenderer} directly renders to a Writer
*/
+@Deprecated // to be removed with 7.0.0
public class FileReporter {
private File reportFile;
private String encoding;
@@ -35,22 +38,14 @@ public FileReporter(File reportFile, String encoding) {
}
public void report(String content) throws ReportException {
- try {
- Writer writer = null;
- try {
- OutputStream outputStream;
- if (reportFile == null) {
- outputStream = System.out;
- } else {
- outputStream = new FileOutputStream(reportFile);
- }
- writer = new BufferedWriter(new OutputStreamWriter(outputStream, encoding));
- writer.write(content);
- } finally {
- IOUtils.closeQuietly(writer);
- }
+ try (Writer writer = new BufferedWriter(new OutputStreamWriter(getOutputStream(), encoding))) {
+ writer.write(content);
} catch (IOException ioe) {
throw new ReportException(ioe);
}
}
+
+ private OutputStream getOutputStream() throws FileNotFoundException {
+ return reportFile == null ? System.out : new FileOutputStream(reportFile);
+ }
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/GUI.java b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/GUI.java
index 7cfbaec817b..c6e7c4727b8 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/GUI.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/GUI.java
@@ -21,6 +21,7 @@
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.PrintWriter;
+import java.io.Writer;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
@@ -31,7 +32,6 @@
import java.util.Map;
import java.util.Properties;
import java.util.Set;
-
import javax.swing.AbstractButton;
import javax.swing.BorderFactory;
import javax.swing.JButton;
@@ -58,16 +58,15 @@
import javax.swing.Timer;
import javax.swing.event.ListSelectionEvent;
import javax.swing.event.ListSelectionListener;
-import javax.swing.event.TableModelListener;
+import javax.swing.table.AbstractTableModel;
import javax.swing.table.DefaultTableCellRenderer;
import javax.swing.table.JTableHeader;
import javax.swing.table.TableColumn;
import javax.swing.table.TableColumnModel;
import javax.swing.table.TableModel;
-import org.apache.commons.io.IOUtils;
-
-import net.sourceforge.pmd.PMD;
+import net.sourceforge.pmd.PMDVersion;
+import net.sourceforge.pmd.cpd.renderer.CPDRenderer;
public class GUI implements CPDListener {
@@ -75,25 +74,25 @@ public class GUI implements CPDListener {
// String render(Iterator<Match> items);
// }
- private static final Object[][] RENDERER_SETS = new Object[][] { { "Text", new Renderer() {
+ private static final Object[][] RENDERER_SETS = new Object[][] { { "Text", new CPDRenderer() {
@Override
- public String render(Iterator<Match> items) {
- return new SimpleRenderer().render(items);
+ public void render(Iterator<Match> items, Writer writer) throws IOException {
+ new SimpleRenderer().render(items, writer);
}
- }, }, { "XML", new Renderer() {
+ }, }, { "XML", new CPDRenderer() {
@Override
- public String render(Iterator<Match> items) {
- return new XMLRenderer().render(items);
+ public void render(Iterator<Match> items, Writer writer) throws IOException {
+ new XMLRenderer().render(items, writer);
}
- }, }, { "CSV (comma)", new Renderer() {
+ }, }, { "CSV (comma)", new CPDRenderer() {
@Override
- public String render(Iterator<Match> items) {
- return new CSVRenderer(',').render(items);
+ public void render(Iterator<Match> items, Writer writer) throws IOException {
+ new CSVRenderer(',').render(items, writer);
}
- }, }, { "CSV (tab)", new Renderer() {
+ }, }, { "CSV (tab)", new CPDRenderer() {
@Override
- public String render(Iterator<Match> items) {
- return new CSVRenderer('\t').render(items);
+ public void render(Iterator<Match> items, Writer writer) throws IOException {
+ new CSVRenderer('\t').render(items, writer);
}
}, }, };
@@ -139,7 +138,7 @@ public Language languageFor(Properties p) {
@Override
public String[] extensions() {
List<String> exts = lang.getExtensions();
- return exts.toArray(new String[exts.size()]);
+ return exts.toArray(new String[0]);
}
@Override
@@ -254,9 +253,9 @@ public void run() {
private class SaveListener implements ActionListener {
- final Renderer renderer;
+ final CPDRenderer renderer;
- SaveListener(Renderer theRenderer) {
+ SaveListener(CPDRenderer theRenderer) {
renderer = theRenderer;
}
@@ -270,16 +269,12 @@ public void actionPerformed(ActionEvent evt) {
}
if (!f.canWrite()) {
- PrintWriter pw = null;
- try {
- pw = new PrintWriter(new FileOutputStream(f));
- pw.write(renderer.render(matches.iterator()));
+ try (PrintWriter pw = new PrintWriter(new FileOutputStream(f))) {
+ renderer.render(matches.iterator(), pw);
pw.flush();
JOptionPane.showMessageDialog(frame, "Saved " + matches.size() + " matches");
} catch (IOException e) {
error("Couldn't save file" + f.getAbsolutePath(), e);
- } finally {
- IOUtils.closeQuietly(pw);
}
} else {
error("Could not write to file " + f.getAbsolutePath(), null);
@@ -356,13 +351,13 @@ private void addSaveOptionsTo(JMenu menu) {
for (int i = 0; i < RENDERER_SETS.length; i++) {
saveItem = new JMenuItem("Save as " + RENDERER_SETS[i][0]);
- saveItem.addActionListener(new SaveListener((Renderer) RENDERER_SETS[i][1]));
+ saveItem.addActionListener(new SaveListener((CPDRenderer) RENDERER_SETS[i][1]));
menu.add(saveItem);
}
}
public GUI() {
- frame = new JFrame("PMD Duplicate Code Detector (v " + PMD.VERSION + ')');
+ frame = new JFrame("PMD Duplicate Code Detector (v " + PMDVersion.VERSION + ')');
timeField.setEditable(false);
@@ -636,7 +631,7 @@ private String setLabelFor(Match match) {
int separatorPos = sourceId.lastIndexOf(File.separatorChar);
label = "..." + sourceId.substring(separatorPos);
} else {
- label = "(" + sourceIDs.size() + " separate files)";
+ label = String.format("(%d separate files)", sourceIDs.size());
}
match.setLabel(label);
@@ -725,7 +720,7 @@ private Timer createTimer() {
final long start = System.currentTimeMillis();
- Timer t = new Timer(1000, new ActionListener() {
+ return new Timer(1000, new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {
long now = System.currentTimeMillis();
@@ -736,7 +731,6 @@ public void actionPerformed(ActionEvent e) {
timeField.setText(formatTime(minutes, seconds));
}
});
- return t;
}
private static String formatTime(long minutes, long seconds) {
@@ -753,21 +747,21 @@ private static String formatTime(long minutes, long seconds) {
return sb.toString();
}
- private interface SortingTableModel<E> extends TableModel {
- int sortColumn();
+ private abstract class SortingTableModel<E> extends AbstractTableModel {
+ abstract int sortColumn();
- void sortColumn(int column);
+ abstract void sortColumn(int column);
- boolean sortDescending();
+ abstract boolean sortDescending();
- void sortDescending(boolean flag);
+ abstract void sortDescending(boolean flag);
- void sort(Comparator<E> comparator);
+ abstract void sort(Comparator<E> comparator);
}
private TableModel tableModelFrom(final List<Match> items) {
- TableModel model = new SortingTableModel<Match>() {
+ return new SortingTableModel<Match>() {
private int sortColumn;
private boolean sortDescending;
@@ -809,23 +803,11 @@ public Class<?> getColumnClass(int columnIndex) {
return Object.class;
}
- @Override
- public void setValueAt(Object aValue, int rowIndex, int columnIndex) {
- }
-
@Override
public String getColumnName(int i) {
return matchColumns[i].label();
}
- @Override
- public void addTableModelListener(TableModelListener l) {
- }
-
- @Override
- public void removeTableModelListener(TableModelListener l) {
- }
-
@Override
public int sortColumn() {
return sortColumn;
@@ -854,8 +836,6 @@ public void sort(Comparator<Match> comparator) {
}
}
};
-
- return model;
}
private void sortOnColumn(int columnIndex) {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/GridBagHelper.java b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/GridBagHelper.java
index f1aa601fd2e..393cf43eb73 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/GridBagHelper.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/GridBagHelper.java
@@ -10,7 +10,6 @@
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
-
import javax.swing.JLabel;
import javax.swing.SwingConstants;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/LanguageFactory.java b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/LanguageFactory.java
index 66559a53268..336a49a00c5 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/LanguageFactory.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/LanguageFactory.java
@@ -72,7 +72,7 @@ public static Language createLanguage(String language, Properties properties) {
if (BY_EXTENSION.equals(language)) {
implementation = instance.getLanguageByExtension(properties.getProperty(EXTENSION));
} else {
- implementation = instance.languages.get(instance.languageAliases(language).toLowerCase());
+ implementation = instance.languages.get(instance.languageAliases(language).toLowerCase(Locale.ROOT));
}
if (implementation == null) {
// No proper implementation
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/Renderer.java b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/Renderer.java
index 200dc040351..1c5f85c31f2 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/Renderer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/Renderer.java
@@ -6,9 +6,13 @@
import java.util.Iterator;
+import net.sourceforge.pmd.cpd.renderer.CPDRenderer;
+
/**
* @author Philippe T'Seyen
+ * @deprecated Use {@link CPDRenderer} instead
*/
+@Deprecated // to be removed with 7.0.0
public interface Renderer {
String render(Iterator<Match> matches);
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/SimpleRenderer.java b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/SimpleRenderer.java
index dc2d4ef38b3..9ccef7f4f18 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/SimpleRenderer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/SimpleRenderer.java
@@ -4,12 +4,16 @@
package net.sourceforge.pmd.cpd;
+import java.io.IOException;
+import java.io.StringWriter;
+import java.io.Writer;
import java.util.Iterator;
import net.sourceforge.pmd.PMD;
+import net.sourceforge.pmd.cpd.renderer.CPDRenderer;
import net.sourceforge.pmd.util.StringUtil;
-public class SimpleRenderer implements Renderer {
+public class SimpleRenderer implements Renderer, CPDRenderer {
private String separator;
private boolean trimLeadingWhitespace;
@@ -29,53 +33,59 @@ public SimpleRenderer(String theSeparator) {
separator = theSeparator;
}
- private void renderOn(StringBuilder rpt, Match match) {
+ private void renderOn(Writer writer, Match match) throws IOException {
- rpt.append("Found a ").append(match.getLineCount()).append(" line (").append(match.getTokenCount())
+ writer.append("Found a ").append(String.valueOf(match.getLineCount())).append(" line (").append(String.valueOf(match.getTokenCount()))
.append(" tokens) duplication in the following files: ").append(PMD.EOL);
for (Iterator<Mark> occurrences = match.iterator(); occurrences.hasNext();) {
Mark mark = occurrences.next();
- rpt.append("Starting at line ").append(mark.getBeginLine()).append(" of ").append(mark.getFilename())
+ writer.append("Starting at line ").append(String.valueOf(mark.getBeginLine())).append(" of ").append(mark.getFilename())
.append(PMD.EOL);
}
- rpt.append(PMD.EOL); // add a line to separate the source from the desc
- // above
+ writer.append(PMD.EOL); // add a line to separate the source from the desc above
String source = match.getSourceCodeSlice();
if (trimLeadingWhitespace) {
- String[] lines = source.split("[" + PMD.EOL + "]");
+ String[] lines = source.split('[' + PMD.EOL + ']');
int trimDepth = StringUtil.maxCommonLeadingWhitespaceForAll(lines);
if (trimDepth > 0) {
lines = StringUtil.trimStartOn(lines, trimDepth);
}
for (int i = 0; i < lines.length; i++) {
- rpt.append(lines[i]).append(PMD.EOL);
+ writer.append(lines[i]).append(PMD.EOL);
}
return;
}
- rpt.append(source).append(PMD.EOL);
+ writer.append(source).append(PMD.EOL);
}
@Override
public String render(Iterator<Match> matches) {
+ StringWriter writer = new StringWriter(300);
+ try {
+ render(matches, writer);
+ } catch (IOException ignored) {
+ // Not really possible with a StringWriter
+ }
+ return writer.toString();
+ }
- StringBuilder rpt = new StringBuilder(300);
-
+ @Override
+ public void render(Iterator<Match> matches, Writer writer) throws IOException {
if (matches.hasNext()) {
- renderOn(rpt, matches.next());
+ renderOn(writer, matches.next());
}
Match match;
while (matches.hasNext()) {
match = matches.next();
- rpt.append(separator).append(PMD.EOL);
- renderOn(rpt, match);
-
+ writer.append(separator).append(PMD.EOL);
+ renderOn(writer, match);
}
- return rpt.toString();
+ writer.flush();
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/VSRenderer.java b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/VSRenderer.java
index 8e80a783b78..f34622e2f0f 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/VSRenderer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/VSRenderer.java
@@ -4,28 +4,40 @@
package net.sourceforge.pmd.cpd;
+import java.io.IOException;
+import java.io.StringWriter;
+import java.io.Writer;
import java.util.Iterator;
import net.sourceforge.pmd.PMD;
+import net.sourceforge.pmd.cpd.renderer.CPDRenderer;
-public class VSRenderer implements Renderer {
+public class VSRenderer implements Renderer, CPDRenderer {
@Override
public String render(Iterator<Match> matches) {
+ StringWriter writer = new StringWriter(300);
+ try {
+ render(matches, writer);
+ } catch (IOException ignored) {
+ // Not really possible with a StringWriter
+ }
+ return writer.toString();
+ }
- StringBuilder buffer = new StringBuilder(300);
-
+ @Override
+ public void render(Iterator<Match> matches, Writer writer) throws IOException {
for (Match match; matches.hasNext();) {
match = matches.next();
Mark mark;
for (Iterator<Mark> iterator = match.iterator(); iterator.hasNext();) {
mark = iterator.next();
- buffer.append(mark.getFilename());
- buffer.append('(').append(mark.getBeginLine()).append("):");
- buffer.append(" Between lines " + mark.getBeginLine() + " and "
+ writer.append(mark.getFilename())
+ .append('(').append(String.valueOf(mark.getBeginLine())).append("):")
+ .append(" Between lines " + mark.getBeginLine() + " and "
+ (mark.getBeginLine() + match.getLineCount()) + PMD.EOL);
}
}
- return buffer.toString();
+ writer.flush();
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/XMLRenderer.java b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/XMLRenderer.java
index 14c28f458c0..bea6819f9c8 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/XMLRenderer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/XMLRenderer.java
@@ -4,9 +4,10 @@
package net.sourceforge.pmd.cpd;
+import java.io.IOException;
import java.io.StringWriter;
+import java.io.Writer;
import java.util.Iterator;
-
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
@@ -20,12 +21,14 @@
import org.w3c.dom.Document;
import org.w3c.dom.Element;
+import net.sourceforge.pmd.cpd.renderer.CPDRenderer;
+
/**
* @author Philippe T'Seyen - original implementation
* @author Romain Pelisse - javax.xml implementation
*
*/
-public final class XMLRenderer implements Renderer {
+public final class XMLRenderer implements Renderer, CPDRenderer {
private String encoding;
@@ -69,7 +72,7 @@ private Document createDocument() {
}
}
- private String xmlDocToString(Document doc) {
+ private void dumpDocToWriter(Document doc, Writer writer) {
try {
TransformerFactory tf = TransformerFactory.newInstance();
Transformer transformer = tf.newTransformer();
@@ -77,9 +80,7 @@ private String xmlDocToString(Document doc) {
transformer.setOutputProperty(OutputKeys.ENCODING, encoding);
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
transformer.setOutputProperty(OutputKeys.CDATA_SECTION_ELEMENTS, "codefragment");
- StringWriter writer = new StringWriter();
transformer.transform(new DOMSource(doc), new StreamResult(writer));
- return writer.toString();
} catch (TransformerException e) {
throw new IllegalStateException(e);
}
@@ -87,6 +88,17 @@ private String xmlDocToString(Document doc) {
@Override
public String render(Iterator<Match> matches) {
+ StringWriter writer = new StringWriter();
+ try {
+ render(matches, writer);
+ } catch (IOException ignored) {
+ // Not really possible with a StringWriter
+ }
+ return writer.toString();
+ }
+
+ @Override
+ public void render(Iterator<Match> matches, Writer writer) throws IOException {
Document doc = createDocument();
Element root = doc.createElement("pmd-cpd");
doc.appendChild(root);
@@ -97,7 +109,8 @@ public String render(Iterator<Match> matches) {
root.appendChild(addCodeSnippet(doc,
addFilesToDuplicationElement(doc, createDuplicationElement(doc, match), match), match));
}
- return xmlDocToString(doc);
+ dumpDocToWriter(doc, writer);
+ writer.flush();
}
private Element addFilesToDuplicationElement(Document doc, Element duplication, Match match) {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/renderer/CPDRenderer.java b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/renderer/CPDRenderer.java
new file mode 100644
index 00000000000..4f3b601f04f
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/renderer/CPDRenderer.java
@@ -0,0 +1,15 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.cpd.renderer;
+
+import java.io.IOException;
+import java.io.Writer;
+import java.util.Iterator;
+
+import net.sourceforge.pmd.cpd.Match;
+
+public interface CPDRenderer {
+ void render(Iterator<Match> matches, Writer writer) throws IOException;
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/token/AntlrToken.java b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/token/AntlrToken.java
new file mode 100644
index 00000000000..6df0fd1e503
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/token/AntlrToken.java
@@ -0,0 +1,74 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.cpd.token;
+
+import org.antlr.v4.runtime.Lexer;
+import org.antlr.v4.runtime.Token;
+
+import net.sourceforge.pmd.lang.ast.GenericToken;
+
+/**
+ * Generic Antlr representation of a token.
+ */
+public class AntlrToken implements GenericToken {
+
+ private final Token token;
+ private final AntlrToken previousComment;
+
+ /**
+ * Constructor
+ *
+ * @param token The antlr token implementation
+ * @param previousComment The previous comment
+ */
+ public AntlrToken(final Token token, final AntlrToken previousComment) {
+ this.token = token;
+ this.previousComment = previousComment;
+ }
+
+ @Override
+ public GenericToken getNext() {
+ // Antlr implementation does not require this
+ return null;
+ }
+
+ @Override
+ public GenericToken getPreviousComment() {
+ return previousComment;
+ }
+
+ @Override
+ public String getImage() {
+ return token.getText();
+ }
+
+ @Override
+ public int getBeginLine() {
+ return token.getLine();
+ }
+
+ @Override
+ public int getEndLine() {
+ return token.getLine();
+ }
+
+ @Override
+ public int getBeginColumn() {
+ return token.getCharPositionInLine();
+ }
+
+ @Override
+ public int getEndColumn() {
+ return token.getCharPositionInLine() + token.getStopIndex() - token.getStartIndex();
+ }
+
+ public int getType() {
+ return token.getType();
+ }
+
+ public boolean isHidden() {
+ return token.getChannel() == Lexer.HIDDEN;
+ }
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/token/JavaCCTokenFilter.java b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/token/JavaCCTokenFilter.java
new file mode 100644
index 00000000000..0b1cd53b4e0
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/token/JavaCCTokenFilter.java
@@ -0,0 +1,84 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.cpd.token;
+
+import net.sourceforge.pmd.lang.TokenManager;
+import net.sourceforge.pmd.lang.ast.GenericToken;
+
+/**
+ * A generic filter for JavaCC-based token managers that allows to use comments
+ * to enable / disable analysis of parts of the stream
+ */
+public class JavaCCTokenFilter implements TokenFilter {
+
+ private final TokenManager tokenManager;
+ private boolean discardingSuppressing;
+
+ /**
+ * Creates a new JavaCCTokenFilter
+ * @param tokenManager The token manager from which to retrieve tokens to be filtered
+ */
+ public JavaCCTokenFilter(final TokenManager tokenManager) {
+ this.tokenManager = tokenManager;
+ }
+
+ @Override
+ public final GenericToken getNextToken() {
+ GenericToken currentToken = (GenericToken) tokenManager.getNextToken();
+ while (!currentToken.getImage().isEmpty()) {
+ analyzeToken(currentToken);
+ processCPDSuppression(currentToken);
+
+ if (!isDiscarding()) {
+ return currentToken;
+ }
+
+ currentToken = (GenericToken) tokenManager.getNextToken();
+ }
+
+ return null;
+ }
+
+ private boolean isDiscarding() {
+ return discardingSuppressing || isLanguageSpecificDiscarding();
+ }
+
+ private void processCPDSuppression(final GenericToken currentToken) {
+ // Check if a comment is altering the suppression state
+ GenericToken comment = currentToken.getPreviousComment();
+ while (comment != null) {
+ if (comment.getImage().contains("CPD-OFF")) {
+ discardingSuppressing = true;
+ break;
+ }
+ if (comment.getImage().contains("CPD-ON")) {
+ discardingSuppressing = false;
+ break;
+ }
+ comment = comment.getPreviousComment();
+ }
+ }
+
+ /**
+ * Extension point for subclasses to indicate tokens are to be filtered.
+ *
+ * @return True if tokens should be filtered, false otherwise
+ */
+ protected boolean isLanguageSpecificDiscarding() {
+ return false;
+ }
+
+ /**
+ * Extension point for subclasses to analyze all tokens (before filtering)
+ * and update internal status to decide on custom discard rules.
+ *
+ * @param currentToken The token to be analyzed
+ * @see #isLanguageSpecificDiscarding()
+ */
+ protected void analyzeToken(final GenericToken currentToken) {
+ // noop
+ }
+
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/cpd/token/TokenFilter.java b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/token/TokenFilter.java
new file mode 100644
index 00000000000..965db0cbfdd
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/cpd/token/TokenFilter.java
@@ -0,0 +1,19 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.cpd.token;
+
+import net.sourceforge.pmd.lang.ast.GenericToken;
+
+/**
+ * Defines filter to be applied to the token stream during CPD analysis
+ */
+public interface TokenFilter {
+
+ /**
+ * Retrieves the next token to pass the filter
+ * @return The next token to pass the filter, or null if the end of the stream was reached
+ */
+ GenericToken getNextToken();
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/dcd/ClassLoaderUtil.java b/pmd-core/src/main/java/net/sourceforge/pmd/dcd/ClassLoaderUtil.java
index 21204cb355c..9534861216e 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/dcd/ClassLoaderUtil.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/dcd/ClassLoaderUtil.java
@@ -12,7 +12,7 @@
* ClassLoader utilities. Useful for extracting additional details from a class
* hierarchy beyond the basic standard Java Reflection APIs.
*/
-public class ClassLoaderUtil {
+public final class ClassLoaderUtil {
public static final String CLINIT = "<clinit>";
@@ -56,8 +56,8 @@ private static Field myGetField(Class<?> type, String name) throws NoSuchFieldEx
for (Class<?> superInterface : type.getInterfaces()) {
try {
return myGetField(superInterface, name);
- } catch (NoSuchFieldException e2) {
- // Okay
+ } catch (NoSuchFieldException ignored) {
+ // Ignored, we'll try the super class next
}
}
// Try the super classes
@@ -99,8 +99,8 @@ private static Method myGetMethod(Class<?> type, String name, Class<?>... parame
// + type.getSuperclass());
return myGetMethod(type.getSuperclass(), name, parameterTypes);
}
- } catch (NoSuchMethodException e2) {
- // Okay
+ } catch (NoSuchMethodException ignored) {
+ // Ignored, we'll try the interfaces next
}
// Try the super interfaces
for (Class<?> superInterface : type.getInterfaces()) {
@@ -108,8 +108,8 @@ private static Method myGetMethod(Class<?> type, String name, Class<?>... parame
// System.out.println("Checking super interface: "
// + superInterface);
return myGetMethod(superInterface, name, parameterTypes);
- } catch (NoSuchMethodException e3) {
- // Okay
+ } catch (NoSuchMethodException ignored) {
+ // Ignored, fall through to the last line, were we throw
}
}
throw new NoSuchMethodException(type.getName() + '.' + getMethodSignature(name, parameterTypes));
@@ -153,7 +153,8 @@ public static boolean isOverridenMethod(Class<?> clazz, Method method, boolean c
clazz.getDeclaredMethod(method.getName(), method.getParameterTypes());
return true;
}
- } catch (NoSuchMethodException e) {
+ } catch (NoSuchMethodException ignored) {
+ // Ignored, checking super class and interfaces next
}
// Check super class
if (clazz.getSuperclass() != null) {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/dcd/DCD.java b/pmd-core/src/main/java/net/sourceforge/pmd/dcd/DCD.java
index eddc9a266e5..a4a0de4a8d6 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/dcd/DCD.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/dcd/DCD.java
@@ -46,7 +46,7 @@
*
* @author Ryan Gustafson <ryan.gustafson@gmail.com>
*/
-public class DCD {
+public final class DCD {
//
// TODO Implement the direct users, indirect users, and dead code
// candidate sets. Use the pmd.util.filter.Filter APIs. Need to come up
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/dcd/asm/TypeSignatureVisitor.java b/pmd-core/src/main/java/net/sourceforge/pmd/dcd/asm/TypeSignatureVisitor.java
index 1d34c106a87..0d95e544c67 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/dcd/asm/TypeSignatureVisitor.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/dcd/asm/TypeSignatureVisitor.java
@@ -94,7 +94,7 @@ public Class<?>[] getMethodParameterTypes() {
throw new RuntimeException();
}
if (parameterTypes != null) {
- return parameterTypes.toArray(new Class<?>[parameterTypes.size()]);
+ return parameterTypes.toArray(new Class<?>[0]);
} else {
return null;
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/dcd/graph/ConstructorNode.java b/pmd-core/src/main/java/net/sourceforge/pmd/dcd/graph/ConstructorNode.java
index 7dd9c2badad..59df0b43919 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/dcd/graph/ConstructorNode.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/dcd/graph/ConstructorNode.java
@@ -15,7 +15,6 @@
/**
* Represents a Class Constructor in a UsageGraph.
*/
-@SuppressWarnings("PMD.OverrideBothEqualsAndHashcode")
public class ConstructorNode extends MemberNode<ConstructorNode, Constructor<?>> {
private WeakReference<Constructor<?>> constructorReference;
@@ -80,21 +79,4 @@ public int compareTo(ConstructorNode that) {
}
return cmp;
}
-
- @Override
- public boolean equals(Object obj) {
- if (obj instanceof ConstructorNode) {
- ConstructorNode that = (ConstructorNode) obj;
- return super.equals(that);
- }
- return false;
- }
-
- /* (non-Javadoc)
- * @see net.sourceforge.pmd.dcd.graph.MemberNode#hashCode()
- */
- @Override
- public int hashCode() {
- return super.hashCode();
- }
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/dcd/graph/FieldNode.java b/pmd-core/src/main/java/net/sourceforge/pmd/dcd/graph/FieldNode.java
index 1944e4baf61..ef03a917a50 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/dcd/graph/FieldNode.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/dcd/graph/FieldNode.java
@@ -12,7 +12,6 @@
/**
* Represents a Class Field in a UsageGraph.
*/
-@SuppressWarnings("PMD.OverrideBothEqualsAndHashcode")
public class FieldNode extends MemberNode<FieldNode, Field> {
private WeakReference<Field> fieldReference;
@@ -36,21 +35,4 @@ public Field getMember() {
public int compareTo(FieldNode that) {
return this.name.compareTo(that.name);
}
-
- @Override
- public boolean equals(Object obj) {
- if (obj instanceof FieldNode) {
- FieldNode that = (FieldNode) obj;
- return super.equals(that);
- }
- return false;
- }
-
- /* (non-Javadoc)
- * @see net.sourceforge.pmd.dcd.graph.MemberNode#hashCode()
- */
- @Override
- public int hashCode() {
- return super.hashCode();
- }
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/dcd/graph/MemberNode.java b/pmd-core/src/main/java/net/sourceforge/pmd/dcd/graph/MemberNode.java
index 8f85abe9917..31dc259f140 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/dcd/graph/MemberNode.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/dcd/graph/MemberNode.java
@@ -24,8 +24,6 @@ public abstract class MemberNode<S extends MemberNode<S, T>, T extends Member>
private List<MemberNode> users;
- private Object decoration;
-
public MemberNode(ClassNode classNode, String name, String desc) {
this.classNode = classNode;
this.name = name;
@@ -81,7 +79,7 @@ public List<MemberNode> getUsers() {
@Override
public String toString() {
- return name + " " + desc;
+ return name + ' ' + desc;
}
public String toStringLong() {
@@ -89,6 +87,7 @@ public String toStringLong() {
}
@SuppressWarnings("PMD.SuspiciousEqualsMethodName")
+ @Deprecated // To be removed with PMD 7.0.0
public boolean equals(S that) {
return equals(that.name, that.desc);
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/dcd/graph/MethodNode.java b/pmd-core/src/main/java/net/sourceforge/pmd/dcd/graph/MethodNode.java
index 8559bb762c5..86e7e0587a8 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/dcd/graph/MethodNode.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/dcd/graph/MethodNode.java
@@ -15,7 +15,6 @@
/**
* Represents a Class Method in a UsageGraph.
*/
-@SuppressWarnings("PMD.OverrideBothEqualsAndHashcode")
public class MethodNode extends MemberNode<MethodNode, Method> {
private WeakReference<Method> methodReference;
@@ -58,21 +57,4 @@ public int compareTo(MethodNode that) {
}
return cmp;
}
-
- @Override
- public boolean equals(Object obj) {
- if (obj instanceof MethodNode) {
- MethodNode that = (MethodNode) obj;
- return super.equals(that);
- }
- return false;
- }
-
- /* (non-Javadoc)
- * @see net.sourceforge.pmd.dcd.graph.MemberNode#hashCode()
- */
- @Override
- public int hashCode() {
- return super.hashCode();
- }
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/dcd/graph/UsageGraphBuilder.java b/pmd-core/src/main/java/net/sourceforge/pmd/dcd/graph/UsageGraphBuilder.java
index 954e7acee03..2af82d3c2fa 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/dcd/graph/UsageGraphBuilder.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/dcd/graph/UsageGraphBuilder.java
@@ -10,7 +10,6 @@
import java.util.Arrays;
import java.util.List;
-import org.apache.commons.io.IOUtils;
import org.objectweb.asm.AnnotationVisitor;
import org.objectweb.asm.Attribute;
import org.objectweb.asm.ClassReader;
@@ -52,13 +51,10 @@ public void index(String name) {
if (classFilter.filter(className)) {
if (!usageGraph.isClass(className)) {
usageGraph.defineClass(className);
- InputStream inputStream = this.getClass().getClassLoader()
- .getResourceAsStream(classResourceName + ".class");
- ClassReader classReader = new ClassReader(inputStream);
- try {
+ try (InputStream inputStream = this.getClass().getClassLoader()
+ .getResourceAsStream(classResourceName + ".class")) {
+ ClassReader classReader = new ClassReader(inputStream);
classReader.accept(getNewClassVisitor(), 0);
- } finally {
- IOUtils.closeQuietly(inputStream);
}
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/document/DeleteDocumentOperation.java b/pmd-core/src/main/java/net/sourceforge/pmd/document/DeleteDocumentOperation.java
new file mode 100644
index 00000000000..006bdb13763
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/document/DeleteDocumentOperation.java
@@ -0,0 +1,17 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.document;
+
+public class DeleteDocumentOperation extends DocumentOperation {
+
+ public DeleteDocumentOperation(final int beginLine, final int endLine, final int beginColumn, final int endColumn) {
+ super(beginLine, endLine, beginColumn, endColumn);
+ }
+
+ @Override
+ public void apply(final Document document) {
+ document.delete(getRegionByLine());
+ }
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/document/Document.java b/pmd-core/src/main/java/net/sourceforge/pmd/document/Document.java
new file mode 100644
index 00000000000..01b26bd03ce
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/document/Document.java
@@ -0,0 +1,35 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.document;
+
+/**
+ * Represents a file which contains programming code that will be fixed.
+ */
+public interface Document {
+
+ /**
+ * Insert a text at a line at the position/column specified. If there is any text to the right of the insertion,
+ * that text is shifted by the length of the text to insert, which means that it is not replaced.
+ * @param beginLine the line in which to insert the text
+ * @param beginColumn the position in the line in which to insert the text
+ * @param textToInsert the text to be added
+ */
+ void insert(int beginLine, int beginColumn, String textToInsert);
+
+ /**
+ * Replace a specific region in the document which contains text by another text, which not necessarily is the same
+ * length as the region's one.
+ * @param regionByOffset the region in which a text will be inserted to replace the current document's contents
+ * @param textToReplace the text to insert
+ */
+ void replace(RegionByLine regionByOffset, String textToReplace);
+
+ /**
+ * Delete a region in the document, removing all text which contains it. If there is any text to the right of this
+ * region, it will be shifted to the left by the length of the region to delete.
+ * @param regionByOffset the region in which to erase all the text
+ */
+ void delete(RegionByLine regionByOffset);
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/document/DocumentFile.java b/pmd-core/src/main/java/net/sourceforge/pmd/document/DocumentFile.java
new file mode 100644
index 00000000000..1aba2c795b2
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/document/DocumentFile.java
@@ -0,0 +1,170 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.document;
+
+import static java.util.Objects.requireNonNull;
+
+import java.io.BufferedReader;
+import java.io.Closeable;
+import java.io.File;
+import java.io.IOException;
+import java.io.Writer;
+import java.nio.charset.Charset;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.StandardCopyOption;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Scanner;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+/**
+ * Implementation that handles a Document as a file in the filesystem and receives operations in a sorted manner
+ * (i.e. the regions are sorted). This improves the efficiency of reading the file by only scanning it once while
+ * operations are applied, until an instance of this document is closed.
+ */
+public class DocumentFile implements Document, Closeable {
+
+ private static final Logger LOG = Logger.getLogger(DocumentFile.class.getName());
+
+ private List<Integer> lineToOffset = new ArrayList<>();
+
+ private final Path filePath;
+ private final BufferedReader reader;
+ private int currentPosition = 0;
+
+ private final Path temporaryPath = Files.createTempFile("pmd-", ".tmp");
+ private final Writer writer;
+
+ public DocumentFile(final File file, final Charset charset) throws IOException {
+ reader = Files.newBufferedReader(requireNonNull(file).toPath(), requireNonNull(charset));
+ writer = Files.newBufferedWriter(temporaryPath, charset);
+ this.filePath = file.toPath();
+ mapLinesToOffsets();
+ }
+
+ private void mapLinesToOffsets() throws IOException {
+ try (Scanner scanner = new Scanner(filePath)) {
+ int currentGlobalOffset = 0;
+
+ while (scanner.hasNextLine()) {
+ lineToOffset.add(currentGlobalOffset);
+ currentGlobalOffset += getLineLengthWithLineSeparator(scanner);
+ }
+ }
+ }
+
+ /**
+ * Sums the line length without the line separation and the characters which matched the line separation pattern
+ * @param scanner the scanner from which to read the line's length
+ * @return the length of the line with the line separator.
+ */
+ private int getLineLengthWithLineSeparator(final Scanner scanner) {
+ int lineLength = scanner.nextLine().length();
+ final String lineSeparationMatch = scanner.match().group(1);
+
+ if (lineSeparationMatch != null) {
+ lineLength += lineSeparationMatch.length();
+ }
+
+ return lineLength;
+ }
+
+ @Override
+ public void insert(int beginLine, int beginColumn, final String textToInsert) {
+ try {
+ tryToInsertIntoFile(beginLine, beginColumn, textToInsert);
+ } catch (final IOException e) {
+ LOG.log(Level.WARNING, "An exception occurred when inserting into file " + filePath);
+ }
+ }
+
+ private void tryToInsertIntoFile(int beginLine, int beginColumn, final String textToInsert) throws IOException {
+ final int offset = mapToOffset(beginLine, beginColumn);
+ writeUntilOffsetReached(offset);
+ writer.write(textToInsert);
+ }
+
+ private int mapToOffset(final int line, final int column) {
+ return lineToOffset.get(line) + column;
+ }
+
+ /**
+ * Write characters between the current offset until the next offset to be read
+ * @param nextOffsetToRead the position in which the reader will stop reading
+ * @throws IOException if an I/O error occurs
+ */
+ private void writeUntilOffsetReached(final int nextOffsetToRead) throws IOException {
+ if (nextOffsetToRead < currentPosition) {
+ throw new IllegalStateException();
+ }
+ final char[] bufferToCopy = new char[nextOffsetToRead - currentPosition];
+ reader.read(bufferToCopy);
+ writer.write(bufferToCopy);
+ currentPosition = nextOffsetToRead;
+ }
+
+ @Override
+ public void replace(final RegionByLine regionByLine, final String textToReplace) {
+ try {
+ tryToReplaceInFile(mapToRegionByOffset(regionByLine), textToReplace);
+ } catch (final IOException e) {
+ LOG.log(Level.WARNING, "An exception occurred when replacing in file " + filePath.toAbsolutePath());
+ }
+ }
+
+ private RegionByOffset mapToRegionByOffset(final RegionByLine regionByLine) {
+ final int startOffset = mapToOffset(regionByLine.getBeginLine(), regionByLine.getBeginColumn());
+ final int endOffset = mapToOffset(regionByLine.getEndLine(), regionByLine.getEndColumn());
+
+ return new RegionByOffsetImp(startOffset, endOffset - startOffset);
+ }
+
+ private void tryToReplaceInFile(final RegionByOffset regionByOffset, final String textToReplace) throws IOException {
+ writeUntilOffsetReached(regionByOffset.getOffset());
+ reader.skip(regionByOffset.getLength());
+ currentPosition = regionByOffset.getOffsetAfterEnding();
+ writer.write(textToReplace);
+ }
+
+ @Override
+ public void delete(final RegionByLine regionByOffset) {
+ try {
+ tryToDeleteFromFile(mapToRegionByOffset(regionByOffset));
+ } catch (final IOException e) {
+ LOG.log(Level.WARNING, "An exception occurred when deleting from file " + filePath.toAbsolutePath());
+ }
+ }
+
+ private void tryToDeleteFromFile(final RegionByOffset regionByOffset) throws IOException {
+ writeUntilOffsetReached(regionByOffset.getOffset());
+ reader.skip(regionByOffset.getLength());
+ currentPosition = regionByOffset.getOffsetAfterEnding();
+ }
+
+ @Override
+ public void close() throws IOException {
+ if (reader.ready()) {
+ writeUntilEOF();
+ }
+ reader.close();
+ writer.close();
+
+ Files.move(temporaryPath, filePath, StandardCopyOption.REPLACE_EXISTING);
+ }
+
+ private void writeUntilEOF() throws IOException {
+ String line;
+
+ while ((line = reader.readLine()) != null) {
+ writer.write(line);
+ }
+ }
+
+ /* package-private */ List<Integer> getLineToOffset() {
+ return lineToOffset;
+ }
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/document/DocumentOperation.java b/pmd-core/src/main/java/net/sourceforge/pmd/document/DocumentOperation.java
new file mode 100644
index 00000000000..2f5a7893462
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/document/DocumentOperation.java
@@ -0,0 +1,31 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.document;
+
+/**
+ * Represents an operation in a document which will be managed by
+ * {@link DocumentOperationsApplierForNonOverlappingRegions}.
+ */
+public abstract class DocumentOperation {
+
+ /**
+ * The region to which this operations belongs
+ */
+ private final RegionByLine regionByLine;
+
+ public DocumentOperation(final int beginLine, final int endLine, final int beginColumn, final int endColumn) {
+ regionByLine = new RegionByLineImp(beginLine, endLine, beginColumn, endColumn);
+ }
+
+ /**
+ * Apply this operation to the specified document
+ * @param document the document to which apply the operation
+ */
+ public abstract void apply(Document document);
+
+ public RegionByLine getRegionByLine() {
+ return regionByLine;
+ }
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/document/DocumentOperationsApplierForNonOverlappingRegions.java b/pmd-core/src/main/java/net/sourceforge/pmd/document/DocumentOperationsApplierForNonOverlappingRegions.java
new file mode 100644
index 00000000000..2e747ece062
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/document/DocumentOperationsApplierForNonOverlappingRegions.java
@@ -0,0 +1,102 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.document;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Comparator;
+import java.util.List;
+import java.util.Objects;
+
+public class DocumentOperationsApplierForNonOverlappingRegions {
+
+ private static final Comparator<DocumentOperation> COMPARATOR = new DocumentOperationNonOverlappingRegionsComparator();
+
+ private final Document document;
+ private final List<DocumentOperation> operations;
+
+ private boolean applied;
+
+ public DocumentOperationsApplierForNonOverlappingRegions(final Document document) {
+ this.document = Objects.requireNonNull(document);
+ operations = new ArrayList<>();
+ applied = false;
+ }
+
+ public void addDocumentOperation(DocumentOperation documentOperation) {
+ assertOperationsHaveNotBeenApplied();
+
+ final int index = getIndexForDocumentOperation(Objects.requireNonNull(documentOperation));
+ operations.add(index, documentOperation);
+ }
+
+ private void assertOperationsHaveNotBeenApplied() {
+ if (applied) {
+ throw new IllegalStateException("Document operations have already been applied to the document");
+ }
+ }
+
+ private int getIndexForDocumentOperation(final DocumentOperation documentOperation) {
+ int potentialIndex = Collections.binarySearch(operations, documentOperation, COMPARATOR);
+
+ if (potentialIndex < 0) {
+ return ~potentialIndex;
+ }
+
+ final int lastIndex = operations.size() - 1;
+ while (potentialIndex < lastIndex && areSiblingsEqual(potentialIndex)) {
+ potentialIndex++;
+ }
+ return potentialIndex + 1;
+ }
+
+ private boolean areSiblingsEqual(final int index) {
+ return COMPARATOR.compare(operations.get(index), operations.get(index + 1)) == 0;
+ }
+
+ public void apply() {
+ assertOperationsHaveNotBeenApplied();
+ applied = true;
+
+ for (final DocumentOperation operation : operations) {
+ operation.apply(document);
+ }
+ }
+
+ private static class DocumentOperationNonOverlappingRegionsComparator implements Comparator<DocumentOperation> {
+
+ @Override
+ public int compare(final DocumentOperation o1, final DocumentOperation o2) {
+ final RegionByLine r1 = Objects.requireNonNull(o1).getRegionByLine();
+ final RegionByLine r2 = Objects.requireNonNull(o2).getRegionByLine();
+
+ final int comparison;
+ if (operationsStartAtTheSameOffsetAndHaveZeroLength(r1, r2)) {
+ comparison = 0;
+ } else if (doesFirstRegionEndBeforeSecondRegionBegins(r1, r2)) {
+ comparison = -1;
+ } else if (doesFirstRegionEndBeforeSecondRegionBegins(r2, r1)) {
+ comparison = 1;
+ } else {
+ throw new IllegalArgumentException("Regions between document operations overlap, " + r1.toString() + "\n" + r2.toString());
+ }
+ return comparison;
+ }
+
+ private boolean operationsStartAtTheSameOffsetAndHaveZeroLength(final RegionByLine r1, final RegionByLine r2) {
+ return r1.getBeginLine() == r2.getBeginLine() && r1.getBeginColumn() == r2.getBeginColumn()
+ && r1.getBeginLine() == r1.getEndLine() && r1.getBeginColumn() == r1.getEndColumn();
+ }
+
+ private boolean doesFirstRegionEndBeforeSecondRegionBegins(final RegionByLine r1, final RegionByLine r2) {
+ if (r1.getEndLine() < r2.getBeginLine()) {
+ return true;
+ } else if (r1.getEndLine() == r2.getBeginLine()) {
+ return r1.getEndColumn() <= r2.getBeginColumn();
+ }
+ return false;
+ }
+ }
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/document/InsertDocumentOperation.java b/pmd-core/src/main/java/net/sourceforge/pmd/document/InsertDocumentOperation.java
new file mode 100644
index 00000000000..6982abbf407
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/document/InsertDocumentOperation.java
@@ -0,0 +1,26 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.document;
+
+import static java.util.Objects.requireNonNull;
+
+/**
+ * Represents an insert operation in a {@link Document}.
+ */
+public class InsertDocumentOperation extends DocumentOperation {
+
+ private final String textToInsert;
+
+ public InsertDocumentOperation(final int beginLine, final int beginColumn, final String textToInsert) {
+ super(beginLine, beginLine, beginColumn, beginColumn);
+ this.textToInsert = requireNonNull(textToInsert);
+ }
+
+ @Override
+ public void apply(final Document document) {
+ final RegionByLine regionByLine = getRegionByLine();
+ document.insert(regionByLine.getBeginLine(), regionByLine.getBeginColumn(), textToInsert);
+ }
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/document/RegionByLine.java b/pmd-core/src/main/java/net/sourceforge/pmd/document/RegionByLine.java
new file mode 100644
index 00000000000..f421255806d
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/document/RegionByLine.java
@@ -0,0 +1,19 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.document;
+
+/**
+ * Represents a region in a {@link Document} with the tuple (beginLine, endLine, beginColumn, endColumn).
+ */
+public interface RegionByLine {
+
+ int getBeginLine();
+
+ int getEndLine();
+
+ int getBeginColumn();
+
+ int getEndColumn();
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/document/RegionByLineImp.java b/pmd-core/src/main/java/net/sourceforge/pmd/document/RegionByLineImp.java
new file mode 100644
index 00000000000..2f9f002a639
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/document/RegionByLineImp.java
@@ -0,0 +1,68 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.document;
+
+/**
+ * Immutable implementation of the {@link RegionByLine} interface.
+ */
+public class RegionByLineImp implements RegionByLine {
+
+ private final int beginLine;
+ private final int endLine;
+ private final int beginColumn;
+ private final int endColumn;
+
+ public RegionByLineImp(final int beginLine, final int endLine, final int beginColumn, final int endColumn) {
+ this.beginLine = requireNonNegative(beginLine);
+ this.endLine = requireNonNegative(endLine);
+ this.beginColumn = requireNonNegative(beginColumn);
+ this.endColumn = requireNonNegative(endColumn);
+
+ requireLinesCorrectlyOrdered();
+ }
+
+ private void requireLinesCorrectlyOrdered() {
+ if (beginLine > endLine) {
+ throw new IllegalArgumentException("endLine must be equal or greater than beginLine");
+ }
+ }
+
+ private static int requireNonNegative(final int value) {
+ if (value < 0) {
+ throw new IllegalArgumentException("parameter must be non-negative");
+ }
+ return value;
+ }
+
+ @Override
+ public int getBeginLine() {
+ return beginLine;
+ }
+
+ @Override
+ public int getEndLine() {
+ return endLine;
+ }
+
+ @Override
+ public int getBeginColumn() {
+ return beginColumn;
+ }
+
+ @Override
+ public int getEndColumn() {
+ return endColumn;
+ }
+
+ @Override
+ public String toString() {
+ return "RegionByLineImp{"
+ + "beginLine=" + beginLine
+ + ", endLine=" + endLine
+ + ", beginColumn=" + beginColumn
+ + ", endColumn=" + endColumn
+ + '}';
+ }
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/document/RegionByOffset.java b/pmd-core/src/main/java/net/sourceforge/pmd/document/RegionByOffset.java
new file mode 100644
index 00000000000..57c73c2d4e0
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/document/RegionByOffset.java
@@ -0,0 +1,17 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.document;
+
+/**
+ * Represents a region in a {@link Document} with the tuple (offset, length).
+ */
+public interface RegionByOffset {
+
+ int getOffset();
+
+ int getLength();
+
+ int getOffsetAfterEnding();
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/document/RegionByOffsetImp.java b/pmd-core/src/main/java/net/sourceforge/pmd/document/RegionByOffsetImp.java
new file mode 100644
index 00000000000..1fd8c8ea4e0
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/document/RegionByOffsetImp.java
@@ -0,0 +1,42 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.document;
+
+/**
+ * Immutable implementation of the {@link RegionByOffset} interface.
+ */
+public class RegionByOffsetImp implements RegionByOffset {
+ private final int offset;
+ private final int length;
+ private final int offsetAfterEnding;
+
+ public RegionByOffsetImp(final int offset, final int length) {
+ this.offset = requireNonNegative(offset);
+ this.length = requireNonNegative(length);
+ offsetAfterEnding = offset + length;
+ }
+
+ private static int requireNonNegative(final int value) {
+ if (value < 0) {
+ throw new IllegalArgumentException();
+ }
+ return value;
+ }
+
+ @Override
+ public int getOffset() {
+ return offset;
+ }
+
+ @Override
+ public int getLength() {
+ return length;
+ }
+
+ @Override
+ public int getOffsetAfterEnding() {
+ return offsetAfterEnding;
+ }
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/document/ReplaceDocumentOperation.java b/pmd-core/src/main/java/net/sourceforge/pmd/document/ReplaceDocumentOperation.java
new file mode 100644
index 00000000000..b7fe5b594ae
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/document/ReplaceDocumentOperation.java
@@ -0,0 +1,22 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.document;
+
+import static java.util.Objects.requireNonNull;
+
+public class ReplaceDocumentOperation extends DocumentOperation {
+
+ private final String textToReplace;
+
+ public ReplaceDocumentOperation(final int beginLine, final int endLine, final int beginColumn, final int endColumn, final String textToReplace) {
+ super(beginLine, endLine, beginColumn, endColumn);
+ this.textToReplace = requireNonNull(textToReplace);
+ }
+
+ @Override
+ public void apply(final Document document) {
+ document.replace(getRegionByLine(), textToReplace);
+ }
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/AbstractLanguageVersionHandler.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/AbstractLanguageVersionHandler.java
index 948f2c7cb9f..400be33c401 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/AbstractLanguageVersionHandler.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/AbstractLanguageVersionHandler.java
@@ -51,15 +51,22 @@ public VisitorStarter getTypeResolutionFacade(ClassLoader classLoader) {
}
@Override
- public VisitorStarter getMetricsVisitorFacade() {
+ public VisitorStarter getDumpFacade(final Writer writer, final String prefix, final boolean recurse) {
return VisitorStarter.DUMMY;
}
@Override
- public VisitorStarter getDumpFacade(final Writer writer, final String prefix, final boolean recurse) {
+ public VisitorStarter getMultifileFacade() {
+ return VisitorStarter.DUMMY;
+ }
+
+
+ @Override
+ public VisitorStarter getQualifiedNameResolutionFacade(ClassLoader classLoader) {
return VisitorStarter.DUMMY;
}
+
@Override
public DFAGraphRule getDFAGraphRule() {
return null;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/BaseLanguageModule.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/BaseLanguageModule.java
index 8b7827c2470..d02b956ddae 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/BaseLanguageModule.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/BaseLanguageModule.java
@@ -99,7 +99,7 @@ public LanguageVersion getDefaultVersion() {
@Override
public String toString() {
- return "LanguageModule:" + name + "(" + this.getClass().getSimpleName() + ")";
+ return "LanguageModule:" + name + '(' + this.getClass().getSimpleName() + ')';
}
@Override
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/LanguageFilenameFilter.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/LanguageFilenameFilter.java
index 7a7ca021699..6635ac66633 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/LanguageFilenameFilter.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/LanguageFilenameFilter.java
@@ -8,6 +8,7 @@
import java.io.FilenameFilter;
import java.util.Collections;
import java.util.List;
+import java.util.Locale;
import java.util.Set;
/**
@@ -52,7 +53,7 @@ public boolean accept(File dir, String name) {
return false;
}
- String extension = name.substring(1 + lastDotIndex).toUpperCase();
+ String extension = name.substring(1 + lastDotIndex).toUpperCase(Locale.ROOT);
for (Language language : languages) {
for (String ext : language.getExtensions()) {
if (extension.equalsIgnoreCase(ext)) {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/LanguageRegistry.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/LanguageRegistry.java
index 593cf65aed8..029953ae15f 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/LanguageRegistry.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/LanguageRegistry.java
@@ -14,6 +14,8 @@
import java.util.Map;
import java.util.ServiceLoader;
+import org.apache.commons.lang3.StringUtils;
+
/**
* Created by christoferdutz on 20.09.14.
*/
@@ -25,7 +27,8 @@ public final class LanguageRegistry {
private LanguageRegistry() {
List<Language> languagesList = new ArrayList<>();
- ServiceLoader<Language> languageLoader = ServiceLoader.load(Language.class);
+ // Use current class' classloader instead of the threads context classloader, see https://github.com/pmd/pmd/issues/1377
+ ServiceLoader<Language> languageLoader = ServiceLoader.load(Language.class, getClass().getClassLoader());
Iterator<Language> iterator = languageLoader.iterator();
while (iterator.hasNext()) {
try {
@@ -90,7 +93,7 @@ public static LanguageVersion findLanguageVersionByTerseName(String terseNameAnd
String version;
String terseName;
if (terseNameAndVersion.contains(" ")) {
- version = terseNameAndVersion.substring(terseNameAndVersion.lastIndexOf(' ') + 1);
+ version = StringUtils.trimToNull(terseNameAndVersion.substring(terseNameAndVersion.lastIndexOf(' ') + 1));
terseName = terseNameAndVersion.substring(0, terseNameAndVersion.lastIndexOf(' '));
} else {
version = null;
@@ -120,9 +123,7 @@ public static List<Language> findByExtension(String extension) {
public static List<LanguageVersion> findAllVersions() {
List<LanguageVersion> versions = new ArrayList<>();
for (Language language : getLanguages()) {
- for (LanguageVersion languageVersion : language.getVersions()) {
- versions.add(languageVersion);
- }
+ versions.addAll(language.getVersions());
}
return versions;
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/LanguageVersionHandler.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/LanguageVersionHandler.java
index 238e711a665..8a536a56165 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/LanguageVersionHandler.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/LanguageVersionHandler.java
@@ -79,21 +79,33 @@ public interface LanguageVersionHandler {
VisitorStarter getTypeResolutionFacade(ClassLoader classLoader);
/**
- * Get the Metrics Framework visitor.
+ * Get the DumpFacade.
*
+ * @param writer
+ * The writer to dump to.
* @return VisitorStarter
*/
- VisitorStarter getMetricsVisitorFacade();
+ VisitorStarter getDumpFacade(Writer writer, String prefix, boolean recurse);
/**
- * Get the DumpFacade.
+ * Gets the visitor that performs multifile data gathering.
*
- * @param writer
- * The writer to dump to.
- * @return VisitorStarter
+ * @return The visitor starter
*/
- VisitorStarter getDumpFacade(Writer writer, String prefix, boolean recurse);
+ VisitorStarter getMultifileFacade();
+
+
+ /**
+ * Gets the visitor that populates the qualified names of the
+ * nodes.
+ *
+ * @param classLoader The classloader to use to resolve the types of type qualified names
+ *
+ * @return The visitor starter
+ */
+ VisitorStarter getQualifiedNameResolutionFacade(ClassLoader classLoader);
+
DFAGraphRule getDFAGraphRule();
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/TokenManager.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/TokenManager.java
index 6673d13a68e..e0e67c78cc1 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/TokenManager.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/TokenManager.java
@@ -8,6 +8,7 @@
* Common interface for interacting with parser Token Managers.
*/
public interface TokenManager {
+ // TODO : Change the return to GenericToken in 7.0.0 - maybe even use generics TokenManager<T extends GenericToken>
Object getNextToken();
void setFileName(String fileName);
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/XPathHandler.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/XPathHandler.java
index c6407e1a207..95728185d74 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/XPathHandler.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/XPathHandler.java
@@ -6,6 +6,7 @@
import org.jaxen.Navigator;
+import net.sourceforge.pmd.annotation.InternalApi;
import net.sourceforge.pmd.lang.xpath.Initializer;
import net.sf.saxon.sxpath.IndependentContext;
@@ -14,15 +15,19 @@
* Interface for performing Language specific XPath handling, such as
* initialization and navigation.
*/
+@InternalApi
+@Deprecated
public interface XPathHandler {
XPathHandler DUMMY = new XPathHandler() {
@Override
public void initialize() {
+ // empty handler - does nothing
}
@Override
public void initialize(IndependentContext context) {
+ // empty handler - does nothing
}
@Override
@@ -46,6 +51,9 @@ public Navigator getNavigator() {
/**
* Get a Jaxen Navigator for this Language. May return <code>null</code> if
* there is no Jaxen Navigation for this language.
+ *
+ * @deprecated Support for Jaxen will be removed come 7.0.0
*/
+ @Deprecated
Navigator getNavigator();
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/antlr/AntlrTokenManager.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/antlr/AntlrTokenManager.java
new file mode 100644
index 00000000000..0bf95b33362
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/antlr/AntlrTokenManager.java
@@ -0,0 +1,87 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.antlr;
+
+import org.antlr.v4.runtime.BaseErrorListener;
+import org.antlr.v4.runtime.Lexer;
+import org.antlr.v4.runtime.RecognitionException;
+import org.antlr.v4.runtime.Recognizer;
+
+import net.sourceforge.pmd.cpd.token.AntlrToken;
+import net.sourceforge.pmd.lang.TokenManager;
+
+/**
+ * Generic token manager implementation for all Antlr lexers.
+ */
+public class AntlrTokenManager implements TokenManager {
+ private final Lexer lexer;
+ private String fileName;
+ private AntlrToken previousToken;
+
+ /**
+ * Constructor
+ *
+ * @param lexer The lexer
+ * @param fileName The file name
+ */
+ public AntlrTokenManager(final Lexer lexer, final String fileName) {
+ this.lexer = lexer;
+ this.fileName = fileName;
+ resetListeners();
+ }
+
+ @Override
+ public Object getNextToken() {
+ final AntlrToken previousComment = previousToken != null && previousToken.isHidden() ? previousToken : null;
+ final AntlrToken currentToken = new AntlrToken(lexer.nextToken(), previousComment);
+ previousToken = currentToken;
+
+ return currentToken;
+ }
+
+ @Override
+ public void setFileName(String fileName) {
+ this.fileName = fileName;
+ }
+
+ public String getFileName() {
+ return fileName;
+ }
+
+ private void resetListeners() {
+ lexer.removeErrorListeners();
+ lexer.addErrorListener(new ErrorHandler());
+ }
+
+ private static class ErrorHandler extends BaseErrorListener {
+
+ @Override
+ public void syntaxError(final Recognizer<?, ?> recognizer, final Object offendingSymbol, final int line,
+ final int charPositionInLine, final String msg, final RecognitionException ex) {
+ throw new ANTLRSyntaxError(msg, line, charPositionInLine, ex);
+ }
+ }
+
+ public static class ANTLRSyntaxError extends RuntimeException {
+ private static final long serialVersionUID = 1L;
+ private final int line;
+ private final int column;
+
+ /* default */ ANTLRSyntaxError(final String msg, final int line, final int column,
+ final RecognitionException cause) {
+ super(msg, cause);
+ this.line = line;
+ this.column = column;
+ }
+
+ public int getLine() {
+ return line;
+ }
+
+ public int getColumn() {
+ return column;
+ }
+ }
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/AbstractNode.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/AbstractNode.java
index f7bbd8e178d..e1985d4d5bc 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/AbstractNode.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/AbstractNode.java
@@ -7,22 +7,33 @@
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
-
+import java.util.Objects;
+import java.util.logging.Logger;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
+import org.apache.commons.lang3.ArrayUtils;
import org.jaxen.BaseXPath;
import org.jaxen.JaxenException;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
+import net.sourceforge.pmd.PMDVersion;
import net.sourceforge.pmd.lang.ast.xpath.Attribute;
+import net.sourceforge.pmd.lang.ast.xpath.AttributeAxisIterator;
import net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator;
import net.sourceforge.pmd.lang.dfa.DataFlowNode;
+
+/**
+ * Base class for all implementations of the Node interface.
+ */
public abstract class AbstractNode implements Node {
+ private static final Logger LOG = Logger.getLogger(AbstractNode.class.getName());
+
+
protected Node parent;
protected Node[] children;
protected int childIndex;
@@ -113,13 +124,6 @@ public int jjtGetId() {
return id;
}
- /**
- * Subclasses should implement this method to return a name usable with
- * XPathRule for evaluating Element Names.
- */
- @Override
- public abstract String toString();
-
@Override
public String getImage() {
return image;
@@ -132,7 +136,7 @@ public void setImage(String image) {
@Override
public boolean hasImageEqualTo(String image) {
- return this.getImage() != null && this.getImage().equals(image);
+ return Objects.equals(this.getImage(), image);
}
@Override
@@ -218,7 +222,7 @@ public <T> T getFirstParentOfType(Class<T> parentType) {
while (parentNode != null && !parentType.isInstance(parentNode)) {
parentNode = parentNode.jjtGetParent();
}
- return (T) parentNode;
+ return parentType.cast(parentNode);
}
@@ -228,21 +232,41 @@ public <T> List<T> getParentsOfType(Class<T> parentType) {
Node parentNode = jjtGetParent();
while (parentNode != null) {
if (parentType.isInstance(parentNode)) {
- parents.add((T) parentNode);
+ parents.add(parentType.cast(parentNode));
}
parentNode = parentNode.jjtGetParent();
}
return parents;
}
+ @SafeVarargs
+ @Override
+ public final <T> T getFirstParentOfAnyType(Class<? extends T>... parentTypes) {
+ Node parentNode = jjtGetParent();
+ while (parentNode != null) {
+ for (Class<? extends T> c : parentTypes) {
+ if (c.isInstance(parentNode)) {
+ return c.cast(parentNode);
+ }
+ }
+ parentNode = parentNode.jjtGetParent();
+ }
+ return null;
+ }
@Override
public <T> List<T> findDescendantsOfType(Class<T> targetType) {
List<T> list = new ArrayList<>();
- findDescendantsOfType(this, targetType, list, true);
+ findDescendantsOfType(this, targetType, list, false);
return list;
}
+ // TODO : Add to Node interface in 7.0.0
+ public <T> List<T> findDescendantsOfType(final Class<T> targetType, final boolean crossBoundaries) {
+ final List<T> list = new ArrayList<>();
+ findDescendantsOfType(this, targetType, list, crossBoundaries);
+ return list;
+ }
@Override
public <T> void findDescendantsOfType(Class<T> targetType, List<T> results, boolean crossBoundaries) {
@@ -252,18 +276,15 @@ public <T> void findDescendantsOfType(Class<T> targetType, List<T> results, bool
private static <T> void findDescendantsOfType(Node node, Class<T> targetType, List<T> results,
boolean crossFindBoundaries) {
- if (!crossFindBoundaries && node.isFindBoundary()) {
- return;
- }
-
- int n = node.jjtGetNumChildren();
- for (int i = 0; i < n; i++) {
+ for (int i = 0; i < node.jjtGetNumChildren(); i++) {
Node child = node.jjtGetChild(i);
- if (child.getClass() == targetType) {
- results.add((T) child);
+ if (targetType.isAssignableFrom(child.getClass())) {
+ results.add(targetType.cast(child));
}
- findDescendantsOfType(child, targetType, results, crossFindBoundaries);
+ if (crossFindBoundaries || !child.isFindBoundary()) {
+ findDescendantsOfType(child, targetType, results, crossFindBoundaries);
+ }
}
}
@@ -271,11 +292,10 @@ private static <T> void findDescendantsOfType(Node node, Class<T> targetType, Li
@Override
public <T> List<T> findChildrenOfType(Class<T> targetType) {
List<T> list = new ArrayList<>();
- int n = jjtGetNumChildren();
- for (int i = 0; i < n; i++) {
+ for (int i = 0; i < jjtGetNumChildren(); i++) {
Node child = jjtGetChild(i);
if (targetType.isInstance(child)) {
- list.add((T) child);
+ list.add(targetType.cast(child));
}
}
return list;
@@ -332,23 +352,26 @@ public <T> T getFirstChildOfType(Class<T> childType) {
int n = jjtGetNumChildren();
for (int i = 0; i < n; i++) {
Node child = jjtGetChild(i);
- if (child.getClass() == childType) {
- return (T) child;
+ if (childType.isInstance(child)) {
+ return childType.cast(child);
}
}
return null;
}
- private static <T> T getFirstDescendantOfType(Class<T> descendantType, Node node) {
- int n = node.jjtGetNumChildren();
+
+ private static <T> T getFirstDescendantOfType(final Class<T> descendantType, final Node node) {
+ final int n = node.jjtGetNumChildren();
for (int i = 0; i < n; i++) {
Node n1 = node.jjtGetChild(i);
- if (n1.getClass() == descendantType) {
- return (T) n1;
+ if (descendantType.isAssignableFrom(n1.getClass())) {
+ return descendantType.cast(n1);
}
- T n2 = getFirstDescendantOfType(descendantType, n1);
- if (n2 != null) {
- return n2;
+ if (!n1.isFindBoundary()) {
+ final T n2 = getFirstDescendantOfType(descendantType, n1);
+ if (n2 != null) {
+ return n2;
+ }
}
}
return null;
@@ -360,12 +383,31 @@ public final <T> boolean hasDescendantOfType(Class<T> type) {
return getFirstDescendantOfType(type) != null;
}
+
/**
+ * Returns true if this node has a descendant of any type among the provided types.
+ *
+ * @param types Types to test
*
- * @param types
- * @return boolean
+ * @deprecated Use {@link #hasDescendantOfAnyType(Class[])}
*/
+ @Deprecated
public final boolean hasDecendantOfAnyType(Class<?>... types) {
+ return hasDescendantOfAnyType(types);
+ }
+
+
+ /**
+ * Returns true if this node has a descendant of any type among the provided types.
+ *
+ * @param types Types to test
+ */
+ public final boolean hasDescendantOfAnyType(Class<?>... types) {
+ // TODO consider implementing that with a single traversal!
+ // hasDescendantOfType could then be a special case of this one
+ // But to really share implementations, getFirstDescendantOfType's
+ // internal helper could have to give up some type safety to rely
+ // instead on a getFirstDescendantOfAnyType, then cast to the correct type
for (Class<?> type : types) {
if (hasDescendantOfType(type)) {
return true;
@@ -418,4 +460,66 @@ public GenericToken jjtGetLastToken() {
public void jjtSetLastToken(GenericToken token) {
this.lastToken = token;
}
+
+ @Override
+ public void remove() {
+ // Detach current node of its parent, if any
+ final Node parent = jjtGetParent();
+ if (parent != null) {
+ parent.removeChildAtIndex(jjtGetChildIndex());
+ jjtSetParent(null);
+ }
+
+ // TODO [autofix]: Notify action for handling text edition
+ }
+
+ @Override
+ public void removeChildAtIndex(final int childIndex) {
+ if (0 <= childIndex && childIndex < jjtGetNumChildren()) {
+ // Remove the child at the given index
+ children = ArrayUtils.remove(children, childIndex);
+ // Update the remaining & left-shifted children indexes
+ for (int i = childIndex; i < jjtGetNumChildren(); i++) {
+ jjtGetChild(i).jjtSetChildIndex(i);
+ }
+ }
+ }
+
+
+ /**
+ * {@inheritDoc}
+ *
+ * <p>This default implementation adds compatibility with the previous
+ * way to get the xpath node name, which used {@link Object#toString()}.
+ *
+ * <p>Please override it. It may be removed in a future major version.
+ */
+ @Override
+ // @Deprecated // FUTURE 7.0.0 make abstract
+ public String getXPathNodeName() {
+ LOG.warning("getXPathNodeName should be overriden in classes derived from AbstractNode. "
+ + "The implementation is provided for compatibility with existing implementors,"
+ + "but could be declared abstract as soon as release " + PMDVersion.getNextMajorRelease()
+ + ".");
+ return toString();
+ }
+
+
+ /**
+ *
+ *
+ * @deprecated The equivalence between toString and a node's name could be broken as soon as release 7.0.0.
+ * Use getXPathNodeName for that purpose. The use for debugging purposes is not deprecated.
+ */
+ @Deprecated
+ @Override
+ public String toString() {
+ return getXPathNodeName();
+ }
+
+
+ @Override
+ public Iterator<Attribute> getXPathAttributesIterator() {
+ return new AttributeAxisIterator(this);
+ }
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/GenericToken.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/GenericToken.java
index 8750e01ae4a..18798da8688 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/GenericToken.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/GenericToken.java
@@ -4,6 +4,51 @@
package net.sourceforge.pmd.lang.ast;
-public class GenericToken {
+/**
+ * Represents a language-independent token such as constants, values language reserved keywords, or comments.
+ */
+public interface GenericToken {
+
+ /**
+ * Obtain the next generic token according to the input stream which generated the instance of this token.
+ * @return the next generic token if it exists; null if it does not exist
+ */
+ GenericToken getNext();
+
+ /**
+ * Obtain a comment-type token which, according to the input stream which generated the instance of this token,
+ * precedes this instance token and succeeds the previous generic token (if there is any).
+ * @return the comment-type token if it exists; null if it does not exist
+ */
+ GenericToken getPreviousComment();
+
+ /**
+ * Gets the token's text.
+ * @return the token's text
+ */
+ String getImage();
+
+ /**
+ * Gets the line where the token's region begins
+ * @return a non-negative integer containing the begin line
+ */
+ int getBeginLine();
+
+ /**
+ * Gets the line where the token's region ends
+ * @return a non-negative integer containing the end line
+ */
+ int getEndLine();
+
+ /**
+ * Gets the column offset from the start of the begin line where the token's region begins
+ * @return a non-negative integer containing the begin column
+ */
+ int getBeginColumn();
+ /**
+ * Gets the column offset from the start of the end line where the token's region ends
+ * @return a non-negative integer containing the begin column
+ */
+ int getEndColumn();
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/Node.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/Node.java
index 1461eba2d2e..dfac6c1d078 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/Node.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/Node.java
@@ -5,11 +5,13 @@
package net.sourceforge.pmd.lang.ast;
+import java.util.Iterator;
import java.util.List;
import org.jaxen.JaxenException;
import org.w3c.dom.Document;
+import net.sourceforge.pmd.lang.ast.xpath.Attribute;
import net.sourceforge.pmd.lang.dfa.DataFlowNode;
/**
@@ -84,16 +86,27 @@ public interface Node {
Node jjtGetChild(int index);
/**
- * Return the number of children the node has.
+ * Returns the number of children the node has.
*/
int jjtGetNumChildren();
int jjtGetId();
+
+ /**
+ * Returns a string token, usually filled-in by the parser, which describes some textual
+ * characteristic of this node. This is usually an identifier, but you should check that
+ * using the Designer. On most nodes though, this method returns {@code null}.
+ */
String getImage();
void setImage(String image);
+ /**
+ * Returns true if this node's image is equal to the given string.
+ *
+ * @param image The image to check
+ */
boolean hasImageEqualTo(String image);
int getBeginLine();
@@ -108,11 +121,19 @@ public interface Node {
void setDataFlowNode(DataFlowNode dataFlowNode);
+
+ /**
+ * Returns true if this node is considered a boundary by traversal methods.
+ * Traversal methods such as {@link #getFirstDescendantOfType(Class)} don't
+ * look past such boundaries by default, which is usually the expected thing
+ * to do. For example, in Java, lambdas and nested classes are considered
+ * find boundaries.
+ */
boolean isFindBoundary();
/**
- * Returns the n-th parent or null if there are not {@code n} ancestors
+ * Returns the n-th parent or null if there are less than {@code n} ancestors.
*
* @param n how many ancestors to iterate over.
*
@@ -137,7 +158,8 @@ public interface Node {
/**
* Traverses up the tree to find all of the parent instances of type
- * parentType or one of its subclasses.
+ * parentType or one of its subclasses. The nodes are ordered
+ * deepest-first.
*
* @param parentType Class literal of the type you want to find
* @param <T> The type you want to find
@@ -146,6 +168,18 @@ public interface Node {
*/
<T> List<T> getParentsOfType(Class<T> parentType);
+
+ /**
+ * Gets the first parent that's an instance of any of the given types.
+ *
+ * @param parentTypes Types to look for
+ * @param <T> Most specific common type of the parameters
+ *
+ * @return The first parent with a matching type. Returns null if there
+ * is no such parent
+ */
+ <T> T getFirstParentOfAnyType(Class<? extends T>... parentTypes);
+
/**
* Traverses the children to find all the instances of type childType or
* one of its subclasses.
@@ -162,7 +196,7 @@ public interface Node {
/**
* Traverses down the tree to find all the descendant instances of type
- * descendantType.
+ * descendantType without crossing find boundaries.
*
* @param targetType
* class which you want to find.
@@ -199,7 +233,7 @@ public interface Node {
/**
* Traverses down the tree to find the first descendant instance of type
- * descendantType.
+ * descendantType without crossing find boundaries.
*
* @param descendantType
* class which you want to find.
@@ -209,7 +243,7 @@ public interface Node {
<T> T getFirstDescendantOfType(Class<T> descendantType);
/**
- * Finds if this node contains a descendant of the given type.
+ * Finds if this node contains a descendant of the given type without crossing find boundaries.
*
* @param type
* the node type to search
@@ -255,12 +289,12 @@ public interface Node {
/**
* Set the user data associated with this node.
- * <p>
- * PMD itself will never set user data onto a node. Nor should any Rule
+ *
+ * <p>PMD itself will never set user data onto a node. Nor should any Rule
* implementation, as the AST nodes are shared between concurrently
* executing Rules (i.e. it is <strong>not</strong> thread-safe).
- * <p>
- * This API is most useful for external applications looking to leverage
+ *
+ * <p>This API is most useful for external applications looking to leverage
* PMD's robust support for AST structures, in which case application
* specific annotations on the AST nodes can be quite useful.
*
@@ -268,4 +302,36 @@ public interface Node {
* The data to set on this node.
*/
void setUserData(Object userData);
+
+ /**
+ * Remove the current node from its parent.
+ */
+ void remove();
+
+ /**
+ * This method tells the node to remove the child node at the given index from the node's list of
+ * children, if any; if not, no changes are done.
+ *
+ * @param childIndex
+ * The index of the child to be removed
+ */
+ void removeChildAtIndex(int childIndex);
+
+
+ /**
+ * Gets the name of the node that is used to match it with XPath queries.
+ *
+ * @return The XPath node name
+ */
+ String getXPathNodeName();
+
+
+ /**
+ * Returns an iterator enumerating all the attributes that are available
+ * from XPath for this node.
+ *
+ * @return An attribute iterator for this node
+ */
+ Iterator<Attribute> getXPathAttributesIterator();
+
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/QualifiedName.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/QualifiedName.java
index 2f46a186134..69d5f386ab8 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/QualifiedName.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/QualifiedName.java
@@ -5,9 +5,11 @@
package net.sourceforge.pmd.lang.ast;
/**
- * Basic interface for qualified names. That's used in the metrics framework to refer unambiguously to operations or
- * classes. Language specific pmd modules should have at most one implementation of this interface, to allow safe
- * downcasting from QualifiedName to e.g. JavaQualifiedName.
+ * Basic interface for qualified names usable in the metrics framework.
+ * Qualified names identify unambiguously operations and classes across
+ * the analysed project. Language specific pmd modules should have at
+ * most one implementation of this interface, to allow safe downcasting
+ * from QualifiedName to e.g. JavaQualifiedName.
*
* @author Clément Fournier
*/
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/AbstractASTXPathHandler.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/AbstractASTXPathHandler.java
index 4c9fad1fdf7..f4c1e8ddbe9 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/AbstractASTXPathHandler.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/AbstractASTXPathHandler.java
@@ -6,11 +6,15 @@
import org.jaxen.Navigator;
+import net.sourceforge.pmd.annotation.InternalApi;
import net.sourceforge.pmd.lang.Language;
import net.sourceforge.pmd.lang.XPathHandler;
import net.sf.saxon.sxpath.IndependentContext;
+
+@Deprecated
+@InternalApi
public abstract class AbstractASTXPathHandler implements XPathHandler {
@Override
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/Attribute.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/Attribute.java
index 07a0eaa3ccc..6f57f00dabe 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/Attribute.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/Attribute.java
@@ -6,27 +6,43 @@
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ConcurrentMap;
+import java.util.logging.Level;
+import java.util.logging.Logger;
import net.sourceforge.pmd.lang.ast.Node;
/**
+ * Represents an XPath attribute of a specific node.
+ * Attributes know their name, the node they wrap,
+ * and have access to their value.
+ *
* @author daniels
*/
public class Attribute {
+
+ private static final Logger LOG = Logger.getLogger(Attribute.class.getName());
+ private static final ConcurrentMap<String, Boolean> DETECTED_DEPRECATED_ATTRIBUTES = new ConcurrentHashMap<>();
+
private static final Object[] EMPTY_OBJ_ARRAY = new Object[0];
+
private Node parent;
private String name;
private Method method;
private Object value;
private String stringValue;
+ /** Creates a new attribute belonging to the given node using its accessor. */
public Attribute(Node parent, String name, Method m) {
this.parent = parent;
this.name = name;
this.method = m;
}
+
+ /** Creates a new attribute belonging to the given node using its string value. */
public Attribute(Node parent, String name, String value) {
this.parent = parent;
this.name = name;
@@ -34,17 +50,33 @@ public Attribute(Node parent, String name, String value) {
this.stringValue = value;
}
+
+ public String getName() {
+ return name;
+ }
+
+
+ public Node getParent() {
+ return parent;
+ }
+
public Object getValue() {
if (value != null) {
return value;
}
+
+ if (method.isAnnotationPresent(Deprecated.class) && LOG.isLoggable(Level.WARNING)
+ && DETECTED_DEPRECATED_ATTRIBUTES.putIfAbsent(getLoggableAttributeName(), Boolean.TRUE) == null) {
+ // this message needs to be kept in sync with PMDCoverageTest
+ LOG.warning("Use of deprecated attribute '" + getLoggableAttributeName() + "' in XPath query");
+ }
+
// this lazy loading reduces calls to Method.invoke() by about 90%
try {
- return method.invoke(parent, EMPTY_OBJ_ARRAY);
- } catch (IllegalAccessException iae) {
+ value = method.invoke(parent, EMPTY_OBJ_ARRAY);
+ return value;
+ } catch (IllegalAccessException | InvocationTargetException iae) {
iae.printStackTrace();
- } catch (InvocationTargetException ite) {
- ite.printStackTrace();
}
return null;
}
@@ -57,24 +89,16 @@ public String getStringValue() {
if (this.value == null) {
v = getValue();
}
- if (v == null) {
- stringValue = "";
- } else {
- stringValue = String.valueOf(v);
- }
+ stringValue = v == null ? "" : String.valueOf(v);
return stringValue;
}
- public String getName() {
- return name;
- }
-
- public Node getParent() {
- return parent;
+ private String getLoggableAttributeName() {
+ return parent.getXPathNodeName() + "/@" + name;
}
@Override
public String toString() {
- return name + ":" + getValue() + ":" + parent;
+ return name + ':' + getValue() + ':' + parent;
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/AttributeAxisIterator.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/AttributeAxisIterator.java
index c6e05d20aea..75807ecd716 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/AttributeAxisIterator.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/AttributeAxisIterator.java
@@ -6,55 +6,54 @@
import java.lang.reflect.Method;
import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
+import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
+import net.sourceforge.pmd.annotation.InternalApi;
import net.sourceforge.pmd.lang.ast.Node;
-public class AttributeAxisIterator implements Iterator<Attribute> {
-
- private static class MethodWrapper {
- public Method method;
- public String name;
- MethodWrapper(Method m) {
- this.method = m;
- this.name = truncateMethodName(m.getName());
- }
+/**
+ * Explores an AST node reflectively to iterate over its XPath
+ * attributes. This is the default way the attributes of a node
+ * are made accessible to XPath rules, and defines an important
+ * piece of PMD's XPath support.
+ *
+ * @deprecated Use {@link Node#getXPathAttributesIterator()}
+ */
+@Deprecated
+@InternalApi
+public class AttributeAxisIterator implements Iterator<Attribute> {
- private String truncateMethodName(String n) {
- // about 70% of the methods start with 'get', so this case goes
- // first
- if (n.startsWith("get")) {
- return n.substring("get".length());
- }
- if (n.startsWith("is")) {
- return n.substring("is".length());
- }
- if (n.startsWith("has")) {
- return n.substring("has".length());
- }
- if (n.startsWith("uses")) {
- return n.substring("uses".length());
- }
+ /** Caches the precomputed attribute accessors of a given class. */
+ private static final ConcurrentMap<Class<?>, MethodWrapper[]> METHOD_CACHE = new ConcurrentHashMap<>();
- return n;
- }
- }
+ /* Constants used to determine which methods are accessors */
+ private static final Set<Class<?>> CONSIDERED_RETURN_TYPES
+ = new HashSet<>(Arrays.<Class<?>>asList(Integer.TYPE, Boolean.TYPE, Double.TYPE, String.class, Long.TYPE, Character.TYPE, Float.TYPE));
+ private static final Set<String> FILTERED_OUT_NAMES
+ = new HashSet<>(Arrays.asList("toString", "getClass", "getXPathNodeName", "getTypeNameNode", "hashCode", "getImportedNameNode", "getScope"));
+ /* Iteration variables */
private Attribute currObj;
private MethodWrapper[] methodWrappers;
private int position;
private Node node;
- private static ConcurrentMap<Class<?>, MethodWrapper[]> methodCache =
- new ConcurrentHashMap<Class<?>, MethodWrapper[]>();
+ /**
+ * Creates a new iterator that enumerates the attributes of the given node.
+ * Note: if you want to access the attributes of a node, don't use this directly,
+ * use instead the overridable {@link Node#getXPathAttributesIterator()}.
+ */
public AttributeAxisIterator(Node contextNode) {
this.node = contextNode;
- if (!methodCache.containsKey(contextNode.getClass())) {
+ if (!METHOD_CACHE.containsKey(contextNode.getClass())) {
Method[] preFilter = contextNode.getClass().getMethods();
List<MethodWrapper> postFilter = new ArrayList<>();
for (Method element : preFilter) {
@@ -62,17 +61,35 @@ public AttributeAxisIterator(Node contextNode) {
postFilter.add(new MethodWrapper(element));
}
}
- methodCache.putIfAbsent(contextNode.getClass(), postFilter.toArray(new MethodWrapper[postFilter.size()]));
+ METHOD_CACHE.putIfAbsent(contextNode.getClass(), postFilter.toArray(new MethodWrapper[0]));
}
- this.methodWrappers = methodCache.get(contextNode.getClass());
+ this.methodWrappers = METHOD_CACHE.get(contextNode.getClass());
this.position = 0;
this.currObj = getNextAttribute();
}
+
+ /**
+ * Returns whether the given method is an attribute accessor,
+ * in which case a corresponding Attribute will be added to
+ * the iterator.
+ *
+ * @param method The method to test
+ */
+ protected boolean isAttributeAccessor(Method method) {
+ String methodName = method.getName();
+
+ return CONSIDERED_RETURN_TYPES.contains(method.getReturnType())
+ && method.getParameterTypes().length == 0
+ && !methodName.startsWith("jjt")
+ && !FILTERED_OUT_NAMES.contains(methodName);
+ }
+
+
@Override
public Attribute next() {
- if (currObj == null) {
+ if (!hasNext()) {
throw new IndexOutOfBoundsException();
}
Attribute ret = currObj;
@@ -80,16 +97,19 @@ public Attribute next() {
return ret;
}
+
@Override
public boolean hasNext() {
return currObj != null;
}
+
@Override
public void remove() {
throw new UnsupportedOperationException();
}
+
private Attribute getNextAttribute() {
if (methodWrappers == null || position == methodWrappers.length) {
return null;
@@ -98,17 +118,45 @@ private Attribute getNextAttribute() {
return new Attribute(node, m.name, m.method);
}
- protected boolean isAttributeAccessor(Method method) {
- String methodName = method.getName();
- boolean deprecated = method.getAnnotation(Deprecated.class) != null;
-
- return !deprecated
- && (Integer.TYPE == method.getReturnType() || Boolean.TYPE == method.getReturnType()
- || Double.TYPE == method.getReturnType() || String.class == method.getReturnType())
- && method.getParameterTypes().length == 0 && Void.TYPE != method.getReturnType()
- && !methodName.startsWith("jjt") && !"toString".equals(methodName) && !"getScope".equals(methodName)
- && !"getClass".equals(methodName) && !"getTypeNameNode".equals(methodName)
- && !"getImportedNameNode".equals(methodName) && !"hashCode".equals(methodName);
+ /**
+ * Associates an attribute accessor with the XPath-accessible
+ * name of the attribute. This is used to avoid recomputing
+ * the name of the attribute for each attribute (it's only done
+ * once and put inside the {@link #METHOD_CACHE}).
+ */
+ private static class MethodWrapper {
+ public Method method;
+ public String name;
+
+
+ MethodWrapper(Method m) {
+ this.method = m;
+ this.name = truncateMethodName(m.getName());
+ }
+
+
+ /**
+ * This method produces the actual XPath name of an attribute
+ * from the name of its accessor.
+ */
+ private String truncateMethodName(String n) {
+ // about 70% of the methods start with 'get', so this case goes
+ // first
+ if (n.startsWith("get")) {
+ return n.substring("get".length());
+ }
+ if (n.startsWith("is")) {
+ return n.substring("is".length());
+ }
+ if (n.startsWith("has")) {
+ return n.substring("has".length());
+ }
+ if (n.startsWith("uses")) {
+ return n.substring("uses".length());
+ }
+
+ return n;
+ }
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/AttributeNode.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/AttributeNode.java
index f34343f1336..6fead638864 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/AttributeNode.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/AttributeNode.java
@@ -6,11 +6,16 @@
import java.util.Iterator;
+
/**
* This interface can be used by an AST node to indicate it can directly provide
* access to it's attributes, versus having them be determined via
* introspection.
+ *
+ * @deprecated See {@link net.sourceforge.pmd.lang.ast.Node#getXPathAttributesIterator()}.
+ * Will be removed in 7.0.0
*/
+@Deprecated
public interface AttributeNode {
Iterator<Attribute> getAttributeIterator();
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/DefaultASTXPathHandler.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/DefaultASTXPathHandler.java
new file mode 100644
index 00000000000..974d426e807
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/DefaultASTXPathHandler.java
@@ -0,0 +1,24 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.lang.ast.xpath;
+
+import net.sourceforge.pmd.annotation.InternalApi;
+
+import net.sf.saxon.sxpath.IndependentContext;
+
+
+@Deprecated
+@InternalApi
+public class DefaultASTXPathHandler extends AbstractASTXPathHandler {
+ @Override
+ public void initialize() {
+ // override if needed
+ }
+
+ @Override
+ public void initialize(IndependentContext context) {
+ // override if needed
+ }
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/DocumentNavigator.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/DocumentNavigator.java
index 3adf8ea3e5a..4f90c2cac71 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/DocumentNavigator.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/DocumentNavigator.java
@@ -11,12 +11,15 @@
import org.jaxen.XPath;
import org.jaxen.util.SingleObjectIterator;
+import net.sourceforge.pmd.annotation.InternalApi;
import net.sourceforge.pmd.lang.ast.Node;
import net.sourceforge.pmd.lang.ast.RootNode;
/**
* @author daniels
*/
+@Deprecated
+@InternalApi
public class DocumentNavigator extends DefaultNavigator {
private static final Iterator<Node> EMPTY_ITERATOR = new ArrayList<Node>().iterator();
@@ -48,7 +51,7 @@ public String getCommentStringValue(Object arg0) {
@Override
public String getElementName(Object node) {
- return node.toString();
+ return ((Node) node).getXPathNodeName();
}
@Override
@@ -135,11 +138,7 @@ public Object getParentNode(Object arg0) {
@Override
public Iterator<Attribute> getAttributeAxisIterator(Object arg0) {
- if (arg0 instanceof AttributeNode) {
- return ((AttributeNode) arg0).getAttributeIterator();
- } else {
- return new AttributeAxisIterator((Node) arg0);
- }
+ return ((Node) arg0).getXPathAttributesIterator();
}
/**
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/NodeIterator.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/NodeIterator.java
index 7f1cb1867ac..c442baa8edf 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/NodeIterator.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/NodeIterator.java
@@ -7,16 +7,22 @@
import java.util.Iterator;
import java.util.NoSuchElementException;
+import net.sourceforge.pmd.annotation.InternalApi;
import net.sourceforge.pmd.lang.ast.Node;
/**
+ * Base class for node iterators used to implement XPath axis
+ * iterators for Jaxen.
+ *
* @author daniels
*/
+@Deprecated
+@InternalApi
public abstract class NodeIterator implements Iterator<Node> {
private Node node;
- public NodeIterator(Node contextNode) {
+ protected NodeIterator(Node contextNode) {
this.node = getFirstNode(contextNode);
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/saxon/AbstractNodeInfo.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/saxon/AbstractNodeInfo.java
index 3c33db0368e..1e7c8e0825f 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/saxon/AbstractNodeInfo.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/saxon/AbstractNodeInfo.java
@@ -4,6 +4,8 @@
package net.sourceforge.pmd.lang.ast.xpath.saxon;
+import net.sourceforge.pmd.annotation.InternalApi;
+
import net.sf.saxon.Configuration;
import net.sf.saxon.event.Receiver;
import net.sf.saxon.om.Axis;
@@ -27,82 +29,54 @@
* useful implementations, such as {@link #iterateAxis(byte, NodeTest)} and
* {@link #isSameNodeInfo(NodeInfo)}.
*/
+@Deprecated
+@InternalApi
public class AbstractNodeInfo implements VirtualNode, SiblingCountingNode {
- /**
- * {@inheritDoc}
- */
@Override
public String getSystemId() {
throw createUnsupportedOperationException("Source.getSystemId()");
}
- /**
- * {@inheritDoc}
- */
@Override
public void setSystemId(String systemId) {
throw createUnsupportedOperationException("Source.setSystemId(String)");
}
- /**
- * {@inheritDoc}
- */
@Override
public String getStringValue() {
throw createUnsupportedOperationException("ValueRepresentation.getStringValue()");
}
- /**
- * {@inheritDoc}
- */
@Override
public CharSequence getStringValueCS() {
throw createUnsupportedOperationException("ValueRepresentation.getStringValueCS()");
}
- /**
- * {@inheritDoc}
- */
@Override
public SequenceIterator getTypedValue() throws XPathException {
throw createUnsupportedOperationException("Item.getTypedValue()");
}
- /**
- * {@inheritDoc}
- */
@Override
public Object getUnderlyingNode() {
throw createUnsupportedOperationException("VirtualNode.getUnderlyingNode()");
}
- /**
- * {@inheritDoc}
- */
@Override
public int getSiblingPosition() {
throw createUnsupportedOperationException("SiblingCountingNode.getSiblingPosition()");
}
- /**
- * {@inheritDoc}
- */
@Override
public Value atomize() throws XPathException {
throw createUnsupportedOperationException("NodeInfo.atomize()");
}
- /**
- * {@inheritDoc}
- */
@Override
public int compareOrder(NodeInfo other) {
throw createUnsupportedOperationException("NodeInfo.compareOrder(NodeInfo)");
}
- /**
- * {@inheritDoc}
- */
@Override
public void copy(Receiver receiver, int whichNamespaces, boolean copyAnnotations, int locationId)
throws XPathException {
@@ -135,57 +109,36 @@ public int hashCode() {
}
}
- /**
- * {@inheritDoc}
- */
@Override
public void generateId(FastStringBuffer buffer) {
throw createUnsupportedOperationException("NodeInfo.generateId(FastStringBuffer)");
}
- /**
- * {@inheritDoc}
- */
@Override
public String getAttributeValue(int fingerprint) {
throw createUnsupportedOperationException("NodeInfo.getAttributeValue(int)");
}
- /**
- * {@inheritDoc}
- */
@Override
public String getBaseURI() {
throw createUnsupportedOperationException("NodeInfo.getBaseURI()");
}
- /**
- * {@inheritDoc}
- */
@Override
public int getColumnNumber() {
throw createUnsupportedOperationException("NodeInfo.getColumnNumber()");
}
- /**
- * {@inheritDoc}
- */
@Override
public Configuration getConfiguration() {
throw createUnsupportedOperationException("NodeInfo.getConfiguration()");
}
- /**
- * {@inheritDoc}
- */
@Override
public int[] getDeclaredNamespaces(int[] buffer) {
throw createUnsupportedOperationException("NodeInfo.getDeclaredNamespaces(int[])");
}
- /**
- * {@inheritDoc}
- */
@Override
public String getDisplayName() {
throw createUnsupportedOperationException("NodeInfo.getDisplayName()");
@@ -201,129 +154,81 @@ public int getDocumentNumber() {
return 0;
}
- /**
- * {@inheritDoc}
- */
@Override
public DocumentInfo getDocumentRoot() {
throw createUnsupportedOperationException("NodeInfo.getDocumentRoot()");
}
- /**
- * {@inheritDoc}
- */
@Override
public int getFingerprint() {
throw createUnsupportedOperationException("NodeInfo.getFingerprint()");
}
- /**
- * {@inheritDoc}
- */
@Override
public int getLineNumber() {
throw createUnsupportedOperationException("NodeInfo.getLineNumber()");
}
- /**
- * {@inheritDoc}
- */
@Override
public String getLocalPart() {
throw createUnsupportedOperationException("NodeInfo.getLocalPart()");
}
- /**
- * {@inheritDoc}
- */
@Override
public int getNameCode() {
throw createUnsupportedOperationException("NodeInfo.getNameCode()");
}
- /**
- * {@inheritDoc}
- */
@Override
public NamePool getNamePool() {
throw createUnsupportedOperationException("NodeInfo.getNamePool()");
}
- /**
- * {@inheritDoc}
- */
@Override
public int getNodeKind() {
throw createUnsupportedOperationException("NodeInfo.getNodeKind()");
}
- /**
- * {@inheritDoc}
- */
@Override
public NodeInfo getParent() {
throw createUnsupportedOperationException("NodeInfo.getParent()");
}
- /**
- * {@inheritDoc}
- */
@Override
public String getPrefix() {
throw createUnsupportedOperationException("NodeInfo.getPrefix()");
}
- /**
- * {@inheritDoc}
- */
@Override
public NodeInfo getRoot() {
throw createUnsupportedOperationException("NodeInfo.getRoot()");
}
- /**
- * {@inheritDoc}
- */
@Override
public int getTypeAnnotation() {
throw createUnsupportedOperationException("NodeInfo.getTypeAnnotation()");
}
- /**
- * {@inheritDoc}
- */
@Override
public String getURI() {
throw createUnsupportedOperationException("NodeInfo.getURI()");
}
- /**
- * {@inheritDoc}
- */
@Override
public boolean hasChildNodes() {
throw createUnsupportedOperationException("NodeInfo.hasChildNodes()");
}
- /**
- * {@inheritDoc}
- */
@Override
public boolean isId() {
throw createUnsupportedOperationException("NodeInfo.isId()");
}
- /**
- * {@inheritDoc}
- */
@Override
public boolean isIdref() {
throw createUnsupportedOperationException("NodeInfo.isIdref()");
}
- /**
- * {@inheritDoc}
- */
@Override
public boolean isNilled() {
throw createUnsupportedOperationException("NodeInfo.isNilled()");
@@ -340,9 +245,6 @@ public boolean isSameNodeInfo(NodeInfo other) {
return this.equals(other);
}
- /**
- * {@inheritDoc}
- */
@Override
public AxisIterator iterateAxis(byte axisNumber) {
throw createUnsupportedOperationException(
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/saxon/AttributeAxisIterator.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/saxon/AttributeAxisIterator.java
index b56cc1ac0d8..9a0e23baf16 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/saxon/AttributeAxisIterator.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/saxon/AttributeAxisIterator.java
@@ -4,18 +4,24 @@
package net.sourceforge.pmd.lang.ast.xpath.saxon;
+import java.util.Iterator;
+
+import net.sourceforge.pmd.annotation.InternalApi;
import net.sourceforge.pmd.lang.ast.xpath.Attribute;
import net.sf.saxon.om.Navigator;
import net.sf.saxon.om.SequenceIterator;
/**
- * This is an Attribute axis iterator.
+ * An adapter over our {@link net.sourceforge.pmd.lang.ast.xpath.AttributeAxisIterator}
+ * for the Saxon model.
*/
+@Deprecated
+@InternalApi
public class AttributeAxisIterator extends Navigator.BaseEnumeration {
protected final ElementNode startNodeInfo;
- protected final net.sourceforge.pmd.lang.ast.xpath.AttributeAxisIterator iterator;
+ protected final Iterator<Attribute> iterator;
/**
* Create an iterator over the Attribute axis for the given ElementNode.
@@ -24,20 +30,14 @@ public class AttributeAxisIterator extends Navigator.BaseEnumeration {
*/
public AttributeAxisIterator(ElementNode startNodeInfo) {
this.startNodeInfo = startNodeInfo;
- this.iterator = new net.sourceforge.pmd.lang.ast.xpath.AttributeAxisIterator(startNodeInfo.node);
+ this.iterator = startNodeInfo.node.getXPathAttributesIterator();
}
- /**
- * {@inheritDoc}
- */
@Override
public SequenceIterator getAnother() {
return new AttributeAxisIterator(startNodeInfo);
}
- /**
- * {@inheritDoc}
- */
@Override
public void advance() {
if (this.iterator.hasNext()) {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/saxon/AttributeNode.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/saxon/AttributeNode.java
index 8b859f1c384..fc36cf6b243 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/saxon/AttributeNode.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/saxon/AttributeNode.java
@@ -4,26 +4,34 @@
package net.sourceforge.pmd.lang.ast.xpath.saxon;
+import net.sourceforge.pmd.annotation.InternalApi;
import net.sourceforge.pmd.lang.ast.xpath.Attribute;
+import net.sourceforge.pmd.lang.rule.xpath.SaxonXPathRuleQuery;
import net.sf.saxon.om.NodeInfo;
import net.sf.saxon.om.SequenceIterator;
import net.sf.saxon.trans.XPathException;
import net.sf.saxon.type.Type;
-import net.sf.saxon.value.BooleanValue;
-import net.sf.saxon.value.EmptySequence;
-import net.sf.saxon.value.Int64Value;
-import net.sf.saxon.value.StringValue;
import net.sf.saxon.value.Value;
/**
* A Saxon OM Attribute node for an AST Node Attribute.
+ * Belongs to an {@link ElementNode}, and wraps an
+ * {@link Attribute}.
*/
+@Deprecated
+@InternalApi
public class AttributeNode extends AbstractNodeInfo {
protected final Attribute attribute;
protected final int id;
protected Value value;
+
+ /**
+ * Creates a new AttributeNode from a PMD Attribute.
+ *
+ * @param id The index within the attribute order
+ */
public AttributeNode(Attribute attribute, int id) {
this.attribute = attribute;
this.id = id;
@@ -45,23 +53,9 @@ public String getURI() {
}
@Override
- public Value atomize() throws XPathException {
+ public Value atomize() {
if (value == null) {
- Object v = attribute.getValue();
- // TODO Need to handle the full range of types, is there something
- // Saxon can do to help?
- if (v instanceof String) {
- value = new StringValue((String) v);
- } else if (v instanceof Boolean) {
- value = BooleanValue.get(((Boolean) v).booleanValue());
- } else if (v instanceof Integer) {
- value = Int64Value.makeIntegerValue((Integer) v);
- } else if (v == null) {
- value = EmptySequence.getInstance();
- } else {
- throw new RuntimeException(
- "Unable to create ValueRepresentaton for attribute value: " + v + " of type " + v.getClass());
- }
+ value = SaxonXPathRuleQuery.getAtomicRepresentation(attribute.getValue());
}
return value;
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/saxon/DocumentNode.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/saxon/DocumentNode.java
index a98308857b5..f91718c8164 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/saxon/DocumentNode.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/saxon/DocumentNode.java
@@ -8,6 +8,7 @@
import java.util.Iterator;
import java.util.Map;
+import net.sourceforge.pmd.annotation.InternalApi;
import net.sourceforge.pmd.lang.ast.Node;
import net.sf.saxon.om.Axis;
@@ -21,6 +22,8 @@
/**
* A Saxon OM Document node for an AST Node.
*/
+@Deprecated
+@InternalApi
public class DocumentNode extends AbstractNodeInfo implements DocumentInfo {
/**
@@ -46,25 +49,16 @@ public DocumentNode(Node node) {
this.rootNode = new ElementNode(this, new IdGenerator(), null, node, -1);
}
- /**
- * {@inheritDoc}
- */
@Override
public String[] getUnparsedEntity(String name) {
throw createUnsupportedOperationException("DocumentInfo.getUnparsedEntity(String)");
}
- /**
- * {@inheritDoc}
- */
@Override
public Iterator getUnparsedEntityNames() {
throw createUnsupportedOperationException("DocumentInfo.getUnparsedEntityNames()");
}
- /**
- * {@inheritDoc}
- */
@Override
public NodeInfo selectID(String id) {
throw createUnsupportedOperationException("DocumentInfo.selectID(String)");
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/saxon/ElementNode.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/saxon/ElementNode.java
index dc407538a13..60960f4f4b9 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/saxon/ElementNode.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/saxon/ElementNode.java
@@ -4,6 +4,7 @@
package net.sourceforge.pmd.lang.ast.xpath.saxon;
+import net.sourceforge.pmd.annotation.InternalApi;
import net.sourceforge.pmd.lang.ast.Node;
import net.sf.saxon.om.Axis;
@@ -19,6 +20,8 @@
/**
* A Saxon OM Element type node for an AST Node.
*/
+@Deprecated
+@InternalApi
public class ElementNode extends AbstractNodeInfo {
protected final DocumentNode document;
@@ -83,7 +86,7 @@ public DocumentInfo getDocumentRoot() {
@Override
public String getLocalPart() {
- return node.toString();
+ return node.getXPathNodeName();
}
@Override
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/saxon/IdGenerator.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/saxon/IdGenerator.java
index a0147294211..afb0886811d 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/saxon/IdGenerator.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/xpath/saxon/IdGenerator.java
@@ -4,9 +4,14 @@
package net.sourceforge.pmd.lang.ast.xpath.saxon;
+import net.sourceforge.pmd.annotation.InternalApi;
+
+
/**
* This class is used to generate unique IDs for nodes.
*/
+@Deprecated
+@InternalApi
public class IdGenerator {
private int id;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/StackObject.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/StackObject.java
index 78605c7f957..271e8984fb5 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/StackObject.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/StackObject.java
@@ -24,7 +24,6 @@ public NodeType getType() {
@Override
public String toString() {
- return ("StackObject: type=" + type + ", node=" + node.toString());
-
+ return "StackObject: type=" + type + ", node=" + node.toString();
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/VariableAccess.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/VariableAccess.java
index dca5da4676a..26761385301 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/VariableAccess.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/VariableAccess.java
@@ -51,13 +51,13 @@ public String getVariableName() {
@Override
public String toString() {
if (isDefinition()) {
- return "Definition(" + variableName + ")";
+ return "Definition(" + variableName + ')';
}
if (isReference()) {
- return "Reference(" + variableName + ")";
+ return "Reference(" + variableName + ')';
}
if (isUndefinition()) {
- return "Undefinition(" + variableName + ")";
+ return "Undefinition(" + variableName + ')';
}
throw new RuntimeException("Access type was never set");
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/pathfinder/CurrentPath.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/pathfinder/CurrentPath.java
index e23e3c20823..86827e2ff09 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/pathfinder/CurrentPath.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/pathfinder/CurrentPath.java
@@ -68,7 +68,7 @@ public DataFlowNode getDoBranchNodeFromFirstDoStatement() {
}
public boolean isEndNode() {
- return this.getLast().getChildren().size() == 0;
+ return this.getLast().getChildren().isEmpty();
// return inode instanceof StartOrEndDataFlowNode;
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/AbstractReportNode.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/AbstractReportNode.java
index 0c22b3d49bc..bcf88664053 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/AbstractReportNode.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/AbstractReportNode.java
@@ -7,6 +7,7 @@
import java.util.ArrayList;
import java.util.List;
+@Deprecated // will be removed with PMD 7.0.0 without replacement. See net.sourceforge.pmd.lang.dfa.report.ReportTree for details.
public abstract class AbstractReportNode {
private List<AbstractReportNode> childNodes = new ArrayList<>();
private AbstractReportNode parentNode = null;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/ClassNode.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/ClassNode.java
index 747be9e52ae..eb6ec4d5881 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/ClassNode.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/ClassNode.java
@@ -4,6 +4,7 @@
package net.sourceforge.pmd.lang.dfa.report;
+@Deprecated // will be removed with PMD 7.0.0 without replacement. See net.sourceforge.pmd.lang.dfa.report.ReportTree for details.
public class ClassNode extends AbstractReportNode {
private String className;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/PackageNode.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/PackageNode.java
index 24d2e9ac5ae..8ba7c1ba4c8 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/PackageNode.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/PackageNode.java
@@ -4,6 +4,7 @@
package net.sourceforge.pmd.lang.dfa.report;
+@Deprecated // will be removed with PMD 7.0.0 without replacement. See net.sourceforge.pmd.lang.dfa.report.ReportTree for details.
public class PackageNode extends AbstractReportNode {
private String packageName;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/ReportHTMLPrintVisitor.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/ReportHTMLPrintVisitor.java
index a7d664eb7ea..61ab8eb4ee4 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/ReportHTMLPrintVisitor.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/ReportHTMLPrintVisitor.java
@@ -9,7 +9,6 @@
import java.io.FileWriter;
import java.io.IOException;
-import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.StringUtils;
import net.sourceforge.pmd.PMD;
@@ -25,6 +24,7 @@
*
* @author raik
*/
+@Deprecated // will be removed with PMD 7.0.0 without replacement. See net.sourceforge.pmd.lang.dfa.report.ReportTree for details.
public class ReportHTMLPrintVisitor extends ReportVisitor {
@SuppressWarnings("PMD.AvoidStringBufferField")
@@ -44,9 +44,9 @@ public ReportHTMLPrintVisitor(String baseDir) {
* Writes the buffer to file.
*/
private void write(String filename, StringBuilder buf) throws IOException {
- BufferedWriter bw = new BufferedWriter(new FileWriter(new File(baseDir + FILE_SEPARATOR + filename)));
- bw.write(buf.toString(), 0, buf.length());
- IOUtils.closeQuietly(bw);
+ try (BufferedWriter bw = new BufferedWriter(new FileWriter(new File(baseDir + FILE_SEPARATOR + filename)))) {
+ bw.write(buf.toString(), 0, buf.length());
+ }
}
/**
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/ReportTree.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/ReportTree.java
index 18d58771d19..988a29e21dc 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/ReportTree.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/ReportTree.java
@@ -8,6 +8,14 @@
import net.sourceforge.pmd.RuleViolation;
+/**
+ *
+ * @deprecated This class will be removed with PMD 7.0.0 without replacement.
+ * It is very specific for Java as it tries to recreate the package hierarchy
+ * of the analyzed classes and put the found violations in there.
+ * So it is of limited use for any other language.
+ */
+@Deprecated // will be removed with PMD 7.0.0 without replacement
public class ReportTree implements Iterable<RuleViolation> {
private PackageNode rootNode = new PackageNode("");
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/ReportVisitor.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/ReportVisitor.java
index 6c9adf413b7..0794187d13d 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/ReportVisitor.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/ReportVisitor.java
@@ -4,6 +4,7 @@
package net.sourceforge.pmd.lang.dfa.report;
+@Deprecated // will be removed with PMD 7.0.0 without replacement. See net.sourceforge.pmd.lang.dfa.report.ReportTree for details.
public abstract class ReportVisitor {
public void visit(AbstractReportNode node) {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/ViolationNode.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/ViolationNode.java
index 184d7d701cc..4b0c7cb6830 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/ViolationNode.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/dfa/report/ViolationNode.java
@@ -6,6 +6,7 @@
import net.sourceforge.pmd.RuleViolation;
+@Deprecated // will be removed with PMD 7.0.0 without replacement. See net.sourceforge.pmd.lang.dfa.report.ReportTree for details.
public class ViolationNode extends AbstractReportNode {
private RuleViolation ruleViolation;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/metrics/BasicProjectMemoizer.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/metrics/BasicProjectMemoizer.java
index c6d9ff7dcff..e5b6a7463dc 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/metrics/BasicProjectMemoizer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/metrics/BasicProjectMemoizer.java
@@ -4,8 +4,8 @@
package net.sourceforge.pmd.lang.metrics;
-import java.util.HashMap;
import java.util.Map;
+import java.util.WeakHashMap;
import net.sourceforge.pmd.lang.ast.QualifiableNode;
import net.sourceforge.pmd.lang.ast.QualifiedName;
@@ -14,17 +14,22 @@
* Simple implementation of a project memoizer. Memoizers are accessible in constant time, provided the QualifiedName's
* hashCode is well distributed.
*
+ * <p>This implementation takes care of recollecting irrelevant memoizers by storing them in {@link WeakHashMap}.
+ *
* @param <T> Type of type declaration nodes of the language
* @param <O> Type of operation declaration nodes of the language
*
* @author Clément Fournier
* @since 6.0.0
*/
-public abstract class BasicProjectMemoizer<T extends QualifiableNode, O extends QualifiableNode> implements
- ProjectMemoizer<T, O> {
+public abstract class BasicProjectMemoizer<T extends QualifiableNode, O extends QualifiableNode>
+ implements ProjectMemoizer<T, O> {
+
+ private Map<QualifiedName, MetricMemoizer<T>> classes = new WeakHashMap<>();
+ private Map<QualifiedName, MetricMemoizer<O>> operations = new WeakHashMap<>();
- private Map<QualifiedName, MetricMemoizer<T>> classes = new HashMap<>();
- private Map<QualifiedName, MetricMemoizer<O>> operations = new HashMap<>();
+ private final Object classesSynchronizer = new Object();
+ private final Object operationsSynchronizer = new Object();
/** Clears all memoizers. Used for tests. */
public void reset() {
@@ -33,26 +38,26 @@ public void reset() {
}
- @Override
- public void addClassMemoizer(QualifiedName qname) {
- classes.put(qname, new BasicMetricMemoizer<T>());
- }
-
-
- @Override
- public void addOperationMemoizer(QualifiedName qname) {
- operations.put(qname, new BasicMetricMemoizer<O>());
- }
-
-
@Override
public MetricMemoizer<O> getOperationMemoizer(QualifiedName qname) {
+ synchronized (operationsSynchronizer) {
+ if (!operations.containsKey(qname)) {
+ operations.put(qname, new BasicMetricMemoizer<O>());
+ }
+ }
+
return operations.get(qname);
}
@Override
public MetricMemoizer<T> getClassMemoizer(QualifiedName qname) {
+ synchronized (classesSynchronizer) {
+ if (!classes.containsKey(qname)) {
+ classes.put(qname, new BasicMetricMemoizer<T>());
+ }
+ }
+
return classes.get(qname);
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/metrics/MetricKeyUtil.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/metrics/MetricKeyUtil.java
index d5391b3ae0d..1abceb534de 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/metrics/MetricKeyUtil.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/metrics/MetricKeyUtil.java
@@ -14,7 +14,7 @@
* @author Clément Fournier
* @since 6.0.0
*/
-public class MetricKeyUtil {
+public final class MetricKeyUtil {
private MetricKeyUtil() {
@@ -22,7 +22,7 @@ private MetricKeyUtil() {
/**
- * Creates a new metric key holding a metric which can be computed on a class.
+ * Creates a new metric key from its metric and name.
*
* @param name The name of the metric
* @param metric The metric to use
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/metrics/MetricOptions.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/metrics/MetricOptions.java
index 536a7db0232..033fb2c3611 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/metrics/MetricOptions.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/metrics/MetricOptions.java
@@ -158,7 +158,7 @@ void addAll(Collection<? extends MetricOption> options) {
MetricOptions build() {
- if (opts.size() == 0) {
+ if (opts.isEmpty()) {
return emptyOptions();
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/metrics/ParameterizedMetricKey.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/metrics/ParameterizedMetricKey.java
index f916a07af57..e0a8dbb7997 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/metrics/ParameterizedMetricKey.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/metrics/ParameterizedMetricKey.java
@@ -63,6 +63,7 @@ public int hashCode() {
*
* @return An instance of parameterized metric key corresponding to the parameters
*/
+ @SuppressWarnings("PMD.SingletonClassReturningNewInstance")
public static <N extends Node> ParameterizedMetricKey<N> getInstance(MetricKey<N> key, MetricOptions options) {
ParameterizedMetricKey<N> tmp = new ParameterizedMetricKey<>(key, options);
if (!POOL.containsKey(tmp)) {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/metrics/ProjectMemoizer.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/metrics/ProjectMemoizer.java
index 51d4c76b552..04651b2a326 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/metrics/ProjectMemoizer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/metrics/ProjectMemoizer.java
@@ -11,6 +11,9 @@
* Object storing the memoizers of the analysed project. This object should ideally be kept separate from the
* SignatureMatcher if there is one. A base implementation is available, see {@link BasicProjectMemoizer}.
*
+ * <p>Memoizers need not be all kept, in fact, only those who refer to operations or classes defined in
+ * the analysed file are still relevant.
+ *
* @param <T> Type of type declaration nodes of the language
* @param <O> Type of operation declaration nodes of the language
*
@@ -38,21 +41,4 @@ public interface ProjectMemoizer<T extends QualifiableNode, O extends Qualifiabl
*/
MetricMemoizer<T> getClassMemoizer(QualifiedName qname);
-
- /**
- * Adds a memoizer for the class identified by this qualified name.
- *
- * @param qname The qualified name of the class
- */
- void addClassMemoizer(QualifiedName qname);
-
-
- /**
- * Adds a memoizer for the operation identified by this qualified name.
- *
- * @param qname The qualified name of the operations
- */
- void addOperationMemoizer(QualifiedName qname);
-
-
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/AbstractDelegateRule.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/AbstractDelegateRule.java
index e6ad0e95fd4..062f3756d48 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/AbstractDelegateRule.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/AbstractDelegateRule.java
@@ -21,7 +21,11 @@
/**
* Base class for Rule implementations which delegate to another Rule instance.
+ *
+ * @deprecated This is only relevant to {@link RuleReference}, but prevents sharing the implementation
+ * of {@link net.sourceforge.pmd.properties.AbstractPropertySource}. Will be removed in 7.0.0
*/
+@Deprecated
public abstract class AbstractDelegateRule implements Rule {
private Rule rule;
@@ -30,6 +34,13 @@ public Rule getRule() {
return rule;
}
+
+ /**
+ * @deprecated This will be removed in 7.0.0
+ * I mark it specially deprecated because it's inherited by rule reference,
+ * even though a RuleReference has no business setting its rule after construction
+ */
+ @Deprecated
public void setRule(Rule rule) {
this.rule = rule;
}
@@ -213,6 +224,10 @@ public <V> void setProperty(MultiValuePropertyDescriptor<V> propertyDescriptor,
rule.setProperty(propertyDescriptor, values);
}
+ @Override
+ public boolean isPropertyOverridden(PropertyDescriptor<?> propertyDescriptor) {
+ return rule.isPropertyOverridden(propertyDescriptor);
+ }
@Override
public Map<PropertyDescriptor<?>, Object> getPropertiesByPropertyDescriptor() {
@@ -220,38 +235,80 @@ public Map<PropertyDescriptor<?>, Object> getPropertiesByPropertyDescriptor() {
}
@Override
+ @Deprecated // To be removed in PMD 7.0.0
public void setUsesDFA() {
- rule.setUsesDFA();
+ rule.setDfa(true);
}
@Override
+ public void setDfa(boolean isDfa) {
+ rule.setDfa(isDfa);
+ }
+
+ @Override
+ @Deprecated // To be removed in PMD 7.0.0
public boolean usesDFA() {
- return rule.usesDFA();
+ return rule.isDfa();
+ }
+
+ @Override
+ public boolean isDfa() {
+ return rule.isDfa();
}
@Override
+ @Deprecated // To be removed in PMD 7.0.0
public void setUsesTypeResolution() {
- rule.setUsesTypeResolution();
+ rule.setTypeResolution(true);
+ }
+
+ @Override
+ public void setTypeResolution(boolean usingTypeResolution) {
+ rule.setTypeResolution(usingTypeResolution);
}
@Override
+ @Deprecated // To be removed in PMD 7.0.0
public boolean usesTypeResolution() {
- return rule.usesTypeResolution();
+ return rule.isTypeResolution();
+ }
+
+ @Override
+ public boolean isTypeResolution() {
+ return rule.isTypeResolution();
+ }
+
+ @Override
+ @Deprecated // To be removed in PMD 7.0.0
+ public void setUsesMultifile() {
+ rule.setMultifile(true);
}
@Override
- public void setUsesMetrics() {
- rule.setUsesMetrics();
+ public void setMultifile(boolean multifile) {
+ rule.setMultifile(multifile);
}
@Override
- public boolean usesMetrics() {
- return rule.usesMetrics();
+ @Deprecated // To be removed in PMD 7.0.0
+ public boolean usesMultifile() {
+ return rule.isMultifile();
}
@Override
+ public boolean isMultifile() {
+ return rule.isMultifile();
+ }
+
+ @Override
+ @Deprecated // To be removed in PMD 7.0.0
public boolean usesRuleChain() {
- return rule.usesRuleChain();
+ return rule.isRuleChain();
+ }
+
+ @Override
+ public boolean isRuleChain() {
+ return rule.isRuleChain();
}
@Override
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/AbstractRule.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/AbstractRule.java
index 7b06b9bcd30..c2614de7106 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/AbstractRule.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/AbstractRule.java
@@ -40,7 +40,7 @@ public abstract class AbstractRule extends AbstractPropertySource implements Rul
private RulePriority priority = RulePriority.LOW;
private boolean usesDFA;
private boolean usesTypeResolution;
- private boolean usesMetrics;
+ private boolean usesMultifile;
private List<String> ruleChainVisits = new ArrayList<>();
public AbstractRule() {
@@ -48,6 +48,15 @@ public AbstractRule() {
definePropertyDescriptor(Rule.VIOLATION_SUPPRESS_XPATH_DESCRIPTOR);
}
+ @Override
+ protected String getPropertySourceType() {
+ return "rule";
+ }
+
+ /**
+ * @deprecated Use {@link #deepCopy()} to create verbatim copies of rules.
+ */
+ @Deprecated
public void deepCopyValuesTo(AbstractRule otherRule) {
otherRule.language = language;
otherRule.minimumLanguageVersion = minimumLanguageVersion;
@@ -62,11 +71,11 @@ public void deepCopyValuesTo(AbstractRule otherRule) {
otherRule.examples = copyExamples();
otherRule.externalInfoUrl = externalInfoUrl;
otherRule.priority = priority;
- otherRule.propertyDescriptors = copyPropertyDescriptors();
+ otherRule.propertyDescriptors = new ArrayList<>(getPropertyDescriptors());
otherRule.propertyValuesByDescriptor = copyPropertyValues();
otherRule.usesDFA = usesDFA;
otherRule.usesTypeResolution = usesTypeResolution;
- otherRule.usesMetrics = usesMetrics;
+ otherRule.usesMultifile = usesMultifile;
otherRule.ruleChainVisits = copyRuleChainVisits();
}
@@ -78,17 +87,11 @@ private List<String> copyRuleChainVisits() {
return new ArrayList<>(ruleChainVisits);
}
- /**
- * @see Rule#getLanguage()
- */
@Override
public Language getLanguage() {
return language;
}
- /**
- * @see Rule#setLanguage(net.sourceforge.pmd.lang.Language)
- */
@Override
public void setLanguage(Language language) {
if (this.language != null && this instanceof ImmutableLanguage && !this.language.equals(language)) {
@@ -98,194 +101,122 @@ public void setLanguage(Language language) {
this.language = language;
}
- /**
- * @see Rule#getMinimumLanguageVersion()
- */
@Override
public LanguageVersion getMinimumLanguageVersion() {
return minimumLanguageVersion;
}
- /**
- * @see Rule#setMinimumLanguageVersion(net.sourceforge.pmd.lang.LanguageVersion)
- */
@Override
public void setMinimumLanguageVersion(LanguageVersion minimumLanguageVersion) {
this.minimumLanguageVersion = minimumLanguageVersion;
}
- /**
- * @see Rule#getMaximumLanguageVersion()
- */
@Override
public LanguageVersion getMaximumLanguageVersion() {
return maximumLanguageVersion;
}
- /**
- * @see Rule#setMaximumLanguageVersion(net.sourceforge.pmd.lang.LanguageVersion)
- */
@Override
public void setMaximumLanguageVersion(LanguageVersion maximumLanguageVersion) {
this.maximumLanguageVersion = maximumLanguageVersion;
}
- /**
- * @see Rule#isDeprecated()
- */
@Override
public boolean isDeprecated() {
return deprecated;
}
- /**
- * @see Rule#setDeprecated(boolean)
- */
@Override
public void setDeprecated(boolean deprecated) {
this.deprecated = deprecated;
}
- /**
- * @see Rule#getName()
- */
@Override
public String getName() {
return name;
}
- /**
- * @see Rule#setName(String)
- */
@Override
public void setName(String name) {
this.name = name;
}
- /**
- * @see Rule#getSince()
- */
@Override
public String getSince() {
return since;
}
- /**
- * @see Rule#setSince(String)
- */
@Override
public void setSince(String since) {
this.since = since;
}
- /**
- * @see Rule#getRuleClass()
- */
@Override
public String getRuleClass() {
return ruleClass;
}
- /**
- * @see Rule#setRuleClass(String)
- */
@Override
public void setRuleClass(String ruleClass) {
this.ruleClass = ruleClass;
}
- /**
- * @see Rule#getRuleSetName()
- */
@Override
public String getRuleSetName() {
return ruleSetName;
}
- /**
- * @see Rule#setRuleSetName(String)
- */
@Override
public void setRuleSetName(String ruleSetName) {
this.ruleSetName = ruleSetName;
}
- /**
- * @see Rule#getMessage()
- */
@Override
public String getMessage() {
return message;
}
- /**
- * @see Rule#setMessage(String)
- */
@Override
public void setMessage(String message) {
this.message = message;
}
- /**
- * @see Rule#getDescription()
- */
@Override
public String getDescription() {
return description;
}
- /**
- * @see Rule#setDescription(String)
- */
@Override
public void setDescription(String description) {
this.description = description;
}
- /**
- * @see Rule#getExamples()
- */
@Override
public List<String> getExamples() {
// TODO Needs to be externally immutable
return examples;
}
- /**
- * @see Rule#addExample(String)
- */
@Override
public void addExample(String example) {
examples.add(example);
}
- /**
- * @see Rule#getExternalInfoUrl()
- */
@Override
public String getExternalInfoUrl() {
return externalInfoUrl;
}
- /**
- * @see Rule#setExternalInfoUrl(String)
- */
@Override
public void setExternalInfoUrl(String externalInfoUrl) {
this.externalInfoUrl = externalInfoUrl;
}
- /**
- * @see Rule#getPriority()
- */
@Override
public RulePriority getPriority() {
return priority;
}
- /**
- * @see Rule#setPriority(RulePriority)
- */
@Override
public void setPriority(RulePriority priority) {
this.priority = priority;
@@ -302,74 +233,88 @@ public ParserOptions getParserOptions() {
return new ParserOptions();
}
- /**
- * @see Rule#setUsesDFA()
- */
@Override
+ @Deprecated // To be removed in PMD 7.0.0
public void setUsesDFA() {
- usesDFA = true;
+ setDfa(true);
+ }
+
+ @Override
+ public void setDfa(boolean isDfa) {
+ usesDFA = isDfa;
}
- /**
- * @see Rule#usesDFA()
- */
@Override
+ @Deprecated // To be removed in PMD 7.0.0
public boolean usesDFA() {
+ return isDfa();
+ }
+
+ @Override
+ public boolean isDfa() {
return usesDFA;
}
- /**
- * @see Rule#setUsesTypeResolution()
- */
@Override
+ @Deprecated // To be removed in PMD 7.0.0
public void setUsesTypeResolution() {
- usesTypeResolution = true;
+ setTypeResolution(true);
+ }
+
+ @Override
+ public void setTypeResolution(boolean usingTypeResolution) {
+ usesTypeResolution = usingTypeResolution;
}
- /**
- * @see Rule#usesTypeResolution()
- */
@Override
+ @Deprecated // To be removed in PMD 7.0.0
public boolean usesTypeResolution() {
+ return isTypeResolution();
+ }
+
+ @Override
+ public boolean isTypeResolution() {
return usesTypeResolution;
}
- /**
- * @see Rule#setUsesMetrics()
- */
@Override
- public void setUsesMetrics() {
- usesMetrics = true;
+ @Deprecated // To be removed in PMD 7.0.0
+ public void setUsesMultifile() {
+ setMultifile(true);
}
- /**
- * @see Rule#usesMetrics()
- */
@Override
- public boolean usesMetrics() {
- return usesMetrics;
+ public void setMultifile(boolean multifile) {
+ usesMultifile = multifile;
}
+ @Override
+ @Deprecated // To be removed in PMD 7.0.0
+ public boolean usesMultifile() {
+ return isMultifile();
+ }
- /**
- * @see Rule#usesRuleChain()
- */
@Override
+ public boolean isMultifile() {
+ return usesMultifile;
+ }
+
+ @Override
+ @Deprecated // To be removed in PMD 7.0.0
public boolean usesRuleChain() {
+ return isRuleChain();
+ }
+
+ @Override
+ public boolean isRuleChain() {
return !getRuleChainVisits().isEmpty();
}
- /**
- * @see Rule#getRuleChainVisits()
- */
@Override
public List<String> getRuleChainVisits() {
return ruleChainVisits;
}
- /**
- * @see Rule#addRuleChainVisit(Class)
- */
@Override
public void addRuleChainVisit(Class<? extends Node> nodeClass) {
if (!nodeClass.getSimpleName().startsWith("AST")) {
@@ -378,9 +323,6 @@ public void addRuleChainVisit(Class<? extends Node> nodeClass) {
addRuleChainVisit(nodeClass.getSimpleName().substring("AST".length()));
}
- /**
- * @see Rule#addRuleChainVisit(String)
- */
@Override
public void addRuleChainVisit(String astNodeName) {
if (!ruleChainVisits.contains(astNodeName)) {
@@ -388,17 +330,11 @@ public void addRuleChainVisit(String astNodeName) {
}
}
- /**
- * @see Rule#start(RuleContext)
- */
@Override
public void start(RuleContext ctx) {
// Override as needed
}
- /**
- * @see Rule#end(RuleContext)
- */
@Override
public void end(RuleContext ctx) {
// Override as needed
@@ -494,9 +430,6 @@ public boolean equals(Object o) {
return equality;
}
- /**
- * @see #equals(Object)
- */
@Override
public int hashCode() {
Object propertyValues = getPropertiesByPropertyDescriptor();
@@ -510,8 +443,9 @@ public Rule deepCopy() {
Rule rule = null;
try {
rule = getClass().newInstance();
- } catch (InstantiationException | IllegalAccessException e) {
+ } catch (InstantiationException | IllegalAccessException ignored) {
// Can't happen... we already have an instance
+ throw new RuntimeException(ignored); // in case it happens anyway, something is really wrong...
}
rule.setName(getName());
rule.setLanguage(getLanguage());
@@ -521,22 +455,17 @@ public Rule deepCopy() {
rule.setMessage(getMessage());
rule.setRuleSetName(getRuleSetName());
rule.setExternalInfoUrl(getExternalInfoUrl());
- if (usesDFA()) {
- rule.setUsesDFA();
- }
- if (usesTypeResolution()) {
- rule.setUsesTypeResolution();
- }
- if (usesMetrics()) {
- rule.setUsesMetrics();
- }
+ rule.setDfa(isDfa());
+ rule.setTypeResolution(isTypeResolution());
+ rule.setMultifile(isMultifile());
rule.setDescription(getDescription());
for (final String example : getExamples()) {
rule.addExample(example);
}
rule.setPriority(getPriority());
for (final PropertyDescriptor<?> prop : getPropertyDescriptors()) {
- if (!rule.hasDescriptor(prop)) {
+ // define the descriptor only if it doesn't yet exist
+ if (rule.getPropertyDescriptor(prop.name()) == null) {
rule.definePropertyDescriptor(prop); // Property descriptors are immutable, and can be freely shared
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/AbstractRuleChainVisitor.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/AbstractRuleChainVisitor.java
index 176e1f7c351..bb3c5fb3d81 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/AbstractRuleChainVisitor.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/AbstractRuleChainVisitor.java
@@ -12,12 +12,16 @@
import java.util.List;
import java.util.Map;
import java.util.Set;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+import net.sourceforge.pmd.Report;
import net.sourceforge.pmd.Rule;
import net.sourceforge.pmd.RuleContext;
import net.sourceforge.pmd.RuleSet;
-import net.sourceforge.pmd.benchmark.Benchmark;
-import net.sourceforge.pmd.benchmark.Benchmarker;
+import net.sourceforge.pmd.benchmark.TimeTracker;
+import net.sourceforge.pmd.benchmark.TimedOperation;
+import net.sourceforge.pmd.benchmark.TimedOperationCategory;
import net.sourceforge.pmd.lang.ast.Node;
/**
@@ -26,6 +30,8 @@
* expressed interest in.
*/
public abstract class AbstractRuleChainVisitor implements RuleChainVisitor {
+ private static final Logger LOG = Logger.getLogger(AbstractRuleChainVisitor.class.getName());
+
/**
* These are all the rules participating in the RuleChain, grouped by
* RuleSet.
@@ -59,41 +65,52 @@ public void visitAll(List<Node> nodes, RuleContext ctx) {
// Perform a visitation of the AST to index nodes which need visiting by
// type
- long start = System.nanoTime();
- indexNodes(nodes, ctx);
- long end = System.nanoTime();
- Benchmarker.mark(Benchmark.RuleChainVisit, end - start, 1);
+ try (TimedOperation to = TimeTracker.startOperation(TimedOperationCategory.RULECHAIN_VISIT)) {
+ indexNodes(nodes, ctx);
+ }
// For each RuleSet, only if this source file applies
- for (Map.Entry<RuleSet, List<Rule>> entry : ruleSetRules.entrySet()) {
- RuleSet ruleSet = entry.getKey();
- if (!ruleSet.applies(ctx.getSourceCodeFile())) {
- continue;
- }
-
- // For each rule, allow it to visit the nodes it desires
- start = System.nanoTime();
- for (Rule rule : entry.getValue()) {
- int visits = 0;
- if (!RuleSet.applies(rule, ctx.getLanguageVersion())) {
+ try (TimedOperation to = TimeTracker.startOperation(TimedOperationCategory.RULECHAIN_RULE)) {
+ for (Map.Entry<RuleSet, List<Rule>> entry : ruleSetRules.entrySet()) {
+ RuleSet ruleSet = entry.getKey();
+ if (!ruleSet.applies(ctx.getSourceCodeFile())) {
continue;
}
- final List<String> nodeNames = rule.getRuleChainVisits();
- for (int j = 0; j < nodeNames.size(); j++) {
- List<Node> ns = nodeNameToNodes.get(nodeNames.get(j));
- for (Node node : ns) {
- // Visit with underlying Rule, not the RuleReference
- Rule actualRule = rule;
- while (actualRule instanceof RuleReference) {
- actualRule = ((RuleReference) actualRule).getRule();
+
+ // For each rule, allow it to visit the nodes it desires
+ for (Rule rule : entry.getValue()) {
+ int visits = 0;
+ if (!RuleSet.applies(rule, ctx.getLanguageVersion())) {
+ continue;
+ }
+ try (TimedOperation rcto = TimeTracker.startOperation(TimedOperationCategory.RULECHAIN_RULE, rule.getName())) {
+ final List<String> nodeNames = rule.getRuleChainVisits();
+ for (int j = 0; j < nodeNames.size(); j++) {
+ List<Node> ns = nodeNameToNodes.get(nodeNames.get(j));
+ for (Node node : ns) {
+ // Visit with underlying Rule, not the RuleReference
+ Rule actualRule = rule;
+ while (actualRule instanceof RuleReference) {
+ actualRule = ((RuleReference) actualRule).getRule();
+ }
+ visit(actualRule, node, ctx);
+ }
+ visits += ns.size();
+ }
+ rcto.close(visits);
+ } catch (RuntimeException e) {
+ if (ctx.isIgnoreExceptions()) {
+ ctx.getReport().addError(new Report.ProcessingError(e, ctx.getSourceCodeFilename()));
+
+ if (LOG.isLoggable(Level.WARNING)) {
+ LOG.log(Level.WARNING, "Exception applying rule " + rule.getName() + " on file "
+ + ctx.getSourceCodeFilename() + ", continuing with next rule", e);
+ }
+ } else {
+ throw e;
}
- visit(actualRule, node, ctx);
}
- visits += ns.size();
}
- end = System.nanoTime();
- Benchmarker.mark(Benchmark.RuleChainRule, rule.getName(), end - start, visits);
- start = end;
}
}
}
@@ -112,7 +129,7 @@ public void visitAll(List<Node> nodes, RuleContext ctx) {
* Index a single node for visitation by rules.
*/
protected void indexNode(Node node) {
- List<Node> nodes = nodeNameToNodes.get(node.toString());
+ List<Node> nodes = nodeNameToNodes.get(node.getXPathNodeName());
if (nodes != null) {
nodes.add(node);
}
@@ -138,7 +155,7 @@ protected void initialize() {
Map.Entry<RuleSet, List<Rule>> entry = entryIterator.next();
for (Iterator<Rule> ruleIterator = entry.getValue().iterator(); ruleIterator.hasNext();) {
Rule rule = ruleIterator.next();
- if (rule.usesRuleChain()) {
+ if (rule.isRuleChain()) {
visitedNodes.addAll(rule.getRuleChainVisits());
} else {
// Drop rules which do not participate in the rule chain.
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/ImportWrapper.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/ImportWrapper.java
index adee83c7936..69b7e2e2297 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/ImportWrapper.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/ImportWrapper.java
@@ -6,6 +6,7 @@
import java.lang.reflect.Field;
import java.lang.reflect.Method;
+import java.lang.reflect.Modifier;
import java.util.HashSet;
import java.util.Set;
@@ -35,6 +36,18 @@ public ImportWrapper(String fullname, String name, Node node, Class<?> type, boo
for (Field f : type.getFields()) {
allDemands.add(f.getName());
}
+ // also consider static fields, that are not public
+ for (Field f : type.getDeclaredFields()) {
+ if (Modifier.isStatic(f.getModifiers())) {
+ allDemands.add(f.getName());
+ }
+ }
+ // and methods, too
+ for (Method m : type.getDeclaredMethods()) {
+ if (Modifier.isStatic(m.getModifiers())) {
+ allDemands.add(m.getName());
+ }
+ }
}
}
@@ -101,6 +114,6 @@ public boolean isStaticOnDemand() {
@Override
public String toString() {
- return "Import[name=" + name + ",fullname=" + fullname + ",static*=" + isStaticDemand + "]";
+ return "Import[name=" + name + ",fullname=" + fullname + ",static*=" + isStaticDemand + ']';
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/MockRule.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/MockRule.java
index f363ba3e037..8c0e15ea9d3 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/MockRule.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/MockRule.java
@@ -23,7 +23,7 @@ public class MockRule extends AbstractRule {
public MockRule() {
super();
setLanguage(LanguageRegistry.getLanguage("Dummy"));
- definePropertyDescriptor(new IntegerProperty("testIntProperty", "testIntProperty", 0, 100, 1, 0));
+ definePropertyDescriptor(IntegerProperty.named("testIntProperty").desc("testIntProperty").range(0, 100).defaultValue(1).uiOrder(0).build());
}
public MockRule(String name, String description, String message, String ruleSetName, RulePriority priority) {
@@ -41,5 +41,6 @@ public MockRule(String name, String description, String message, String ruleSetN
@Override
public void apply(List<? extends Node> nodes, RuleContext ctx) {
+ // the mock rule does nothing. Usually you would start here to analyze the AST.
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/RuleReference.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/RuleReference.java
index e387ce154fc..15b2609f41e 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/RuleReference.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/RuleReference.java
@@ -5,12 +5,12 @@
package net.sourceforge.pmd.lang.rule;
import java.util.ArrayList;
-import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
+import java.util.Objects;
import net.sourceforge.pmd.Rule;
import net.sourceforge.pmd.RulePriority;
@@ -43,25 +43,59 @@ public class RuleReference extends AbstractDelegateRule {
private RulePriority priority;
private RuleSetReference ruleSetReference;
- private static final List<PropertyDescriptor<?>> EMPTY_DESCRIPTORS = Collections.emptyList();
+ /**
+ * @deprecated to be removed with PMD 7.0.0. when creating a rule reference, always
+ * provide the rule and the ruleset, see the constructor RuleReference(Rule, RuleSetReference)
+ */
+ @Deprecated
public RuleReference() {
+ // default constructor
}
+ /**
+ * Create a new reference to the given rule.
+ *
+ * @param theRule the referenced rule
+ * @param theRuleSetReference the rule set, where the rule is defined
+ */
public RuleReference(Rule theRule, RuleSetReference theRuleSetReference) {
setRule(theRule);
ruleSetReference = theRuleSetReference;
}
+
+ /** copy constructor */
+ private RuleReference(RuleReference ref) {
+
+ this.language = ref.language;
+ this.minimumLanguageVersion = ref.minimumLanguageVersion;
+ this.maximumLanguageVersion = ref.maximumLanguageVersion;
+ this.deprecated = ref.deprecated;
+ this.name = ref.name;
+ this.propertyDescriptors = ref.propertyDescriptors;
+ this.propertyValues = ref.propertyValues == null ? null : new HashMap<>(ref.propertyValues);
+ this.message = ref.message;
+ this.description = ref.description;
+ this.examples = ref.examples == null ? null : new ArrayList<>(ref.examples);
+ this.externalInfoUrl = ref.externalInfoUrl;
+ this.priority = ref.priority;
+ this.ruleSetReference = ref.ruleSetReference;
+
+ this.setRule(ref.getRule().deepCopy());
+ }
+
public Language getOverriddenLanguage() {
return language;
}
+ // FIXME should we really allow overriding the language of a rule?
+ // I don't see any case where this wouldn't just make the rule fail during execution
@Override
public void setLanguage(Language language) {
// Only override if different than current value, or if already
// overridden.
- if (!isSame(language, super.getLanguage()) || this.language != null) {
+ if (!Objects.equals(language, super.getLanguage()) || this.language != null) {
this.language = language;
super.setLanguage(language);
}
@@ -75,7 +109,7 @@ public LanguageVersion getOverriddenMinimumLanguageVersion() {
public void setMinimumLanguageVersion(LanguageVersion minimumLanguageVersion) {
// Only override if different than current value, or if already
// overridden.
- if (!isSame(minimumLanguageVersion, super.getMinimumLanguageVersion()) || this.minimumLanguageVersion != null) {
+ if (!Objects.equals(minimumLanguageVersion, super.getMinimumLanguageVersion()) || this.minimumLanguageVersion != null) {
this.minimumLanguageVersion = minimumLanguageVersion;
super.setMinimumLanguageVersion(minimumLanguageVersion);
}
@@ -89,7 +123,7 @@ public LanguageVersion getOverriddenMaximumLanguageVersion() {
public void setMaximumLanguageVersion(LanguageVersion maximumLanguageVersion) {
// Only override if different than current value, or if already
// overridden.
- if (!isSame(maximumLanguageVersion, super.getMaximumLanguageVersion()) || this.maximumLanguageVersion != null) {
+ if (!Objects.equals(maximumLanguageVersion, super.getMaximumLanguageVersion()) || this.maximumLanguageVersion != null) {
this.maximumLanguageVersion = maximumLanguageVersion;
super.setMaximumLanguageVersion(maximumLanguageVersion);
}
@@ -101,7 +135,7 @@ public Boolean isOverriddenDeprecated() {
@Override
public boolean isDeprecated() {
- return deprecated != null && deprecated.booleanValue();
+ return deprecated != null && deprecated;
}
@Override
@@ -170,6 +204,10 @@ public List<String> getOverriddenExamples() {
@Override
public void addExample(String example) {
+ // TODO Intuitively, if some examples are overridden (even with empty value), then
+ // I think we should discard the previous ones. If the rule needs new examples,
+ // then the previous ones are not relevant.
+
// TODO Meaningful override of examples is hard, because they are merely
// a list of strings. How does one indicate override of a particular
// value? Via index? Rule.setExample(int, String)? But the XML format
@@ -220,9 +258,11 @@ public void setPriority(RulePriority priority) {
}
}
- public List<PropertyDescriptor<?>> getOverriddenPropertyDescriptors() {
- return propertyDescriptors == null ? EMPTY_DESCRIPTORS : propertyDescriptors;
+ @Override
+ public List<PropertyDescriptor<?>> getOverriddenPropertyDescriptors() {
+ return propertyDescriptors == null ? Collections.<PropertyDescriptor<?>>emptyList()
+ : new ArrayList<>(propertyDescriptors);
}
@Override
@@ -237,14 +277,16 @@ public void definePropertyDescriptor(PropertyDescriptor<?> propertyDescriptor) t
propertyDescriptors.add(propertyDescriptor);
}
+
+ @Override
public Map<PropertyDescriptor<?>, Object> getOverriddenPropertiesByPropertyDescriptor() {
- return propertyValues;
+ return propertyValues == null ? new HashMap<PropertyDescriptor<?>, Object>() : new HashMap<>(propertyValues);
}
@Override
public <T> void setProperty(PropertyDescriptor<T> propertyDescriptor, T value) {
// Only override if different than current value.
- if (!isSame(super.getProperty(propertyDescriptor), value)) {
+ if (!Objects.equals(super.getProperty(propertyDescriptor), value)) {
if (propertyValues == null) {
propertyValues = new HashMap<>();
}
@@ -254,14 +296,15 @@ public <T> void setProperty(PropertyDescriptor<T> propertyDescriptor, T value) {
}
-
-
-
-
public RuleSetReference getRuleSetReference() {
return ruleSetReference;
}
+
+ /**
+ * @deprecated There's no use in setting the ruleset reference after construction
+ */
+ @Deprecated
public void setRuleSetReference(RuleSetReference ruleSetReference) {
this.ruleSetReference = ruleSetReference;
}
@@ -270,19 +313,6 @@ private static boolean isSame(String s1, String s2) {
return StringUtil.isSame(s1, s2, true, false, true);
}
- @SuppressWarnings("PMD.CompareObjectsWithEquals")
- private static boolean isSame(Object o1, Object o2) {
- if (o1 instanceof Object[] && o2 instanceof Object[]) {
- return isSame((Object[]) o1, (Object[]) o2);
- }
- return o1 == o2 || o1 != null && o2 != null && o1.equals(o2);
- }
-
- @SuppressWarnings("PMD.UnusedNullCheckInEquals")
- // TODO: fix UnusedNullCheckInEquals rule for Arrays
- private static boolean isSame(Object[] a1, Object[] a2) {
- return a1 == a2 || a1 != null && a2 != null && Arrays.equals(a1, a2);
- }
private static boolean contains(Collection<String> collection, String s1) {
for (String s2 : collection) {
@@ -299,11 +329,21 @@ public boolean hasDescriptor(PropertyDescriptor<?> descriptor) {
|| super.hasDescriptor(descriptor);
}
+ /**
+ * @deprecated Use {@link #isPropertyOverridden(PropertyDescriptor)} instead
+ */
+ @Deprecated
public boolean hasOverriddenProperty(PropertyDescriptor<?> descriptor) {
+ return isPropertyOverridden(descriptor);
+ }
+
+ @Override
+ public boolean isPropertyOverridden(PropertyDescriptor<?> descriptor) {
return propertyValues != null && propertyValues.containsKey(descriptor);
}
@Override
+ @Deprecated
public boolean usesDefaultValues() {
List<PropertyDescriptor<?>> descriptors = getOverriddenPropertyDescriptors();
@@ -312,19 +352,16 @@ public boolean usesDefaultValues() {
}
for (PropertyDescriptor<?> desc : descriptors) {
- if (!isSame(desc.defaultValue(), getProperty(desc))) {
+ if (!Objects.equals(desc.defaultValue(), getProperty(desc))) {
return false;
}
}
- if (!getRule().usesDefaultValues()) {
- return false;
- }
-
- return true;
+ return getRule().usesDefaultValues();
}
@Override
+ @Deprecated
public void useDefaultValueFor(PropertyDescriptor<?> desc) {
// not sure if we should go all the way through to the real thing?
@@ -343,28 +380,6 @@ public void useDefaultValueFor(PropertyDescriptor<?> desc) {
@Override
public Rule deepCopy() {
- RuleReference rule = null;
- try {
- rule = getClass().newInstance();
- } catch (InstantiationException | IllegalAccessException e) {
- // Can't happen... we already have an instance
- }
- rule.setRule(this.getRule().deepCopy());
-
- rule.language = language;
- rule.minimumLanguageVersion = minimumLanguageVersion;
- rule.maximumLanguageVersion = maximumLanguageVersion;
- rule.deprecated = deprecated;
- rule.name = name;
- rule.propertyDescriptors = propertyDescriptors;
- rule.propertyValues = propertyValues == null ? null : new HashMap<>(propertyValues);
- rule.message = message;
- rule.description = description;
- rule.examples = examples == null ? null : new ArrayList<>(examples);
- rule.externalInfoUrl = externalInfoUrl;
- rule.priority = priority;
- rule.ruleSetReference = ruleSetReference;
-
- return rule;
+ return new RuleReference(this);
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java
index a2d4852f70e..f990dfab74a 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/XPathRule.java
@@ -21,17 +21,20 @@
import net.sourceforge.pmd.lang.rule.xpath.SaxonXPathRuleQuery;
import net.sourceforge.pmd.lang.rule.xpath.XPathRuleQuery;
import net.sourceforge.pmd.properties.EnumeratedProperty;
-import net.sourceforge.pmd.properties.PropertySource;
import net.sourceforge.pmd.properties.StringProperty;
/**
* Rule that tries to match an XPath expression against a DOM view of an AST.
*
- * <p>This rule needs a "xpath" property value in order to function.
+ * <p>This rule needs a "xpath" property value in order to function.</p>
*/
public class XPathRule extends AbstractRule {
- public static final StringProperty XPATH_DESCRIPTOR = new StringProperty("xpath", "XPath expression", "", 1.0f);
+ public static final StringProperty XPATH_DESCRIPTOR = StringProperty.named("xpath")
+ .desc("XPath expression")
+ .defaultValue("")
+ .uiOrder(1.0f)
+ .build();
private static final Map<String, String> XPATH_VERSIONS;
@@ -43,29 +46,45 @@ public class XPathRule extends AbstractRule {
XPATH_VERSIONS = Collections.unmodifiableMap(tmp);
}
+ public static final EnumeratedProperty<String> VERSION_DESCRIPTOR = EnumeratedProperty.<String>named("version")
+ .desc("XPath specification version")
+ .mappings(XPATH_VERSIONS)
+ .defaultValue(XPATH_1_0)
+ .type(String.class)
+ .uiOrder(2.0f)
+ .build();
-
- public static final EnumeratedProperty<String> VERSION_DESCRIPTOR
- = new EnumeratedProperty<>("version",
- "XPath specification version", XPATH_VERSIONS, XPATH_1_0, String.class, 2.0f);
-
+ /**
+ * This is initialized only once when calling {@link #evaluate(Node, RuleContext)} or {@link #getRuleChainVisits()}.
+ */
private XPathRuleQuery xpathRuleQuery;
+ /**
+ * Creates a new XPathRule without the corresponding XPath query.
+ */
public XPathRule() {
definePropertyDescriptor(XPATH_DESCRIPTOR);
definePropertyDescriptor(VERSION_DESCRIPTOR);
}
- public XPathRule(String xPath) {
+ /**
+ * Creates a new XPathRule and associates the XPath query.
+ */
+ public XPathRule(final String xPath) {
this();
setXPath(xPath);
}
- public void setXPath(String xPath) {
+ /**
+ * Sets the XPath to query against the desired nodes in {@link #apply(List, RuleContext)}.
+ *
+ * @param xPath the XPath query
+ */
+ public void setXPath(final String xPath) {
setProperty(XPathRule.XPATH_DESCRIPTOR, xPath);
}
- public void setVersion(String version) {
+ public void setVersion(final String version) {
setProperty(XPathRule.VERSION_DESCRIPTOR, version);
}
@@ -80,28 +99,55 @@ public void apply(List<? extends Node> nodes, RuleContext ctx) {
}
/**
- * Evaluate the XPath query with the AST node. All matches are reported as
- * violations.
+ * Evaluate the XPath query with the AST node. All matches are reported as violations.
*
- * @param node
- * The Node that to be checked.
- * @param data
- * The RuleContext.
+ * @param node The Node that to be checked.
+ * @param data The RuleContext.
*/
- public void evaluate(Node node, RuleContext data) {
- init();
- List<Node> nodes = xpathRuleQuery.evaluate(node, data);
- if (nodes != null) {
- for (Node n : nodes) {
- addViolation(data, n, n.getImage());
- }
+ public void evaluate(final Node node, final RuleContext data) {
+ if (xPathRuleQueryNeedsInitialization()) {
+ initXPathRuleQuery();
}
+ List<Node> nodesWithViolation = xpathRuleQuery.evaluate(node, data);
+ for (Node nodeWithViolation : nodesWithViolation) {
+ addViolation(data, nodeWithViolation, nodeWithViolation.getImage());
+ }
+ }
+
+ /**
+ * Initializes {@link #xpathRuleQuery} iff {@link #xPathRuleQueryNeedsInitialization()} is true. To select the
+ * engine in which the query will be run it looks at the XPath version.
+ */
+ private void initXPathRuleQuery() {
+ String xpath = getProperty(XPATH_DESCRIPTOR);
+ String version = getProperty(VERSION_DESCRIPTOR);
+
+ initRuleQueryBasedOnVersion(version);
+
+ xpathRuleQuery.setXPath(xpath);
+ xpathRuleQuery.setVersion(version);
+ xpathRuleQuery.setProperties(getPropertiesByPropertyDescriptor());
+ }
+
+ /**
+ * Checks if the {@link #xpathRuleQuery} is null and therefore requires initialization.
+ *
+ * @return true if {@link #xpathRuleQuery} is null
+ */
+ private boolean xPathRuleQueryNeedsInitialization() {
+ return xpathRuleQuery == null;
+ }
+
+ private void initRuleQueryBasedOnVersion(final String version) {
+ xpathRuleQuery = XPATH_1_0.equals(version) ? new JaxenXPathRuleQuery() : new SaxonXPathRuleQuery();
}
@Override
public List<String> getRuleChainVisits() {
- if (init()) {
+ if (xPathRuleQueryNeedsInitialization()) {
+ initXPathRuleQuery();
+
for (String nodeName : xpathRuleQuery.getRuleChainVisits()) {
super.addRuleChainVisit(nodeName);
}
@@ -109,32 +155,12 @@ public List<String> getRuleChainVisits() {
return super.getRuleChainVisits();
}
- private boolean init() {
- if (xpathRuleQuery == null) {
- String xpath = getProperty(XPATH_DESCRIPTOR);
- String version = getProperty(VERSION_DESCRIPTOR);
- if (XPATH_1_0.equals(version)) {
- xpathRuleQuery = new JaxenXPathRuleQuery();
- } else {
- xpathRuleQuery = new SaxonXPathRuleQuery();
- }
- xpathRuleQuery.setXPath(xpath);
- xpathRuleQuery.setVersion(version);
- xpathRuleQuery.setProperties(this.getPropertiesByPropertyDescriptor());
- return true;
- }
- return false;
- }
-
- public boolean hasXPathExpression() {
- return StringUtils.isNotBlank(getProperty(XPATH_DESCRIPTOR));
- }
-
- /**
- * @see PropertySource#dysfunctionReason()
- */
@Override
public String dysfunctionReason() {
return hasXPathExpression() ? null : "Missing xPath expression";
}
+
+ private boolean hasXPathExpression() {
+ return StringUtils.isNotBlank(getProperty(XPATH_DESCRIPTOR));
+ }
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/AbstractXPathRuleQuery.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/AbstractXPathRuleQuery.java
index ef39feeaac2..69c6d0afdf3 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/AbstractXPathRuleQuery.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/AbstractXPathRuleQuery.java
@@ -37,17 +37,11 @@ public abstract class AbstractXPathRuleQuery implements XPathRuleQuery {
*/
protected final List<String> ruleChainVisits = new ArrayList<>();
- /**
- * {@inheritDoc}
- */
@Override
- public void setXPath(String xpath) {
+ public void setXPath(final String xpath) {
this.xpath = xpath;
}
- /**
- * {@inheritDoc}
- */
@Override
public void setVersion(String version) throws UnsupportedOperationException {
if (!isSupportedVersion(version)) {
@@ -68,25 +62,16 @@ public void setVersion(String version) throws UnsupportedOperationException {
*/
protected abstract boolean isSupportedVersion(String version);
- /**
- * {@inheritDoc}
- */
@Override
public void setProperties(Map<PropertyDescriptor<?>, Object> properties) {
this.properties = properties;
}
- /**
- * {@inheritDoc}
- */
@Override
public List<String> getRuleChainVisits() {
return ruleChainVisits;
}
- /**
- * {@inheritDoc}
- */
@Override
public abstract List<Node> evaluate(Node node, RuleContext data);
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/JaxenXPathRuleQuery.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/JaxenXPathRuleQuery.java
index 1faf9470426..1badb00042f 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/JaxenXPathRuleQuery.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/JaxenXPathRuleQuery.java
@@ -8,7 +8,6 @@
import java.util.ArrayList;
import java.util.Deque;
import java.util.HashMap;
-import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
@@ -52,117 +51,133 @@ private enum InitializationStatus {
private static final String AST_ROOT = "_AST_ROOT_";
- /**
- * {@inheritDoc}
- */
@Override
public boolean isSupportedVersion(String version) {
return XPATH_1_0.equals(version);
}
- /**
- * {@inheritDoc}
- */
@Override
- @SuppressWarnings("unchecked")
- public List<Node> evaluate(Node node, RuleContext data) {
- List<Node> results = new ArrayList<>();
+ public List<Node> evaluate(final Node node, final RuleContext data) {
+ final List<Node> results = new ArrayList<>();
+
try {
- initializeXPathExpression(
- data.getLanguageVersion().getLanguageVersionHandler().getXPathHandler().getNavigator());
- List<XPath> xpaths = nodeNameToXPaths.get(node.toString());
- if (xpaths == null) {
- xpaths = nodeNameToXPaths.get(AST_ROOT);
- }
- for (XPath xpath : xpaths) {
- List<Node> nodes = xpath.selectNodes(node);
- results.addAll(nodes);
+ initializeExpressionIfStatusIsNoneOrPartial(data.getLanguageVersion().getLanguageVersionHandler().getXPathHandler().getNavigator());
+
+ List<XPath> xPaths = getXPathsForNodeOrDefault(node.getXPathNodeName());
+ for (XPath xpath : xPaths) {
+ @SuppressWarnings("unchecked")
+ final List<Node> matchedNodes = xpath.selectNodes(node);
+ results.addAll(matchedNodes);
}
- } catch (JaxenException ex) {
- throw new RuntimeException(ex);
+ } catch (final JaxenException e) {
+ throw new RuntimeException(e);
}
return results;
}
/**
- * {@inheritDoc}
+ * Get the XPath queries associated with the node name. If there are none, the XPath queries for the {@link #AST_ROOT}
+ * are obtained.
+ *
+ * @param nodeName the id of the node
+ * @return the list of XPath queries that match the node name
*/
+ private List<XPath> getXPathsForNodeOrDefault(final String nodeName) {
+ List<XPath> xPaths = nodeNameToXPaths.get(nodeName);
+ if (xPaths == null) {
+ xPaths = nodeNameToXPaths.get(AST_ROOT);
+ }
+ return xPaths;
+ }
+
@Override
public List<String> getRuleChainVisits() {
try {
// No Navigator available in this context
- initializeXPathExpression(null);
+ initializeExpressionIfStatusIsNoneOrPartial(null);
return super.getRuleChainVisits();
- } catch (JaxenException ex) {
+ } catch (final JaxenException ex) {
throw new RuntimeException(ex);
}
}
+ /**
+ *
+ * @param navigator the navigator which is required to be non-null if the {@link #initializationStatus} is PARTIAL.
+ * @throws JaxenException
+ */
@SuppressWarnings("unchecked")
- private void initializeXPathExpression(Navigator navigator) throws JaxenException {
+ private void initializeExpressionIfStatusIsNoneOrPartial(final Navigator navigator) throws JaxenException {
if (initializationStatus == InitializationStatus.FULL) {
return;
- } else if (initializationStatus == InitializationStatus.PARTIAL && navigator == null) {
- if (LOG.isLoggable(Level.SEVERE)) {
- LOG.severe("XPathRule is not initialized because no navigator was provided. "
- + "Please make sure to implement getXPathHandler in the handler of the language. "
- + "See also AbstractLanguageVersionHandler.");
- }
+ }
+ if (initializationStatus == InitializationStatus.PARTIAL && navigator == null) {
+ LOG.severe("XPathRule is not initialized because no navigator was provided. "
+ + "Please make sure to implement getXPathHandler in the handler of the language. "
+ + "See also AbstractLanguageVersionHandler.");
return;
}
+ initializeXPathExpression(navigator);
+ }
+
+ private void initializeXPathExpression(final Navigator navigator) throws JaxenException {
+ /*
+ Attempt to use the RuleChain with this XPath query.
- //
- // Attempt to use the RuleChain with this XPath query. To do so, the
- // queries
- // should generally look like //TypeA or //TypeA | //TypeB. We will look
- // at the
- // parsed XPath AST using the Jaxen APIs to make this determination.
- // If the query is not exactly what we are looking for, do not use the
- // RuleChain.
- //
+ To do so, the queries should generally look like //TypeA or //TypeA | //TypeB. We will look at the parsed XPath
+ AST using the Jaxen APIs to make this determination.
+
+ If the query is not exactly what we are looking for, do not use the
+ RuleChain.
+ */
nodeNameToXPaths = new HashMap<>();
- BaseXPath originalXPath = createXPath(xpath, navigator);
- indexXPath(originalXPath, AST_ROOT);
+ final BaseXPath originalXPath = createXPath(xpath, navigator);
+ addQueryToNode(originalXPath, AST_ROOT);
boolean useRuleChain = true;
- Deque<Expr> pending = new ArrayDeque<>();
+ final Deque<Expr> pending = new ArrayDeque<>();
pending.push(originalXPath.getRootExpr());
while (!pending.isEmpty()) {
- Expr node = pending.pop();
+ final Expr node = pending.pop();
// Need to prove we can handle this part of the query
boolean valid = false;
// Must be a LocationPath... that is something like //Type
if (node instanceof LocationPath) {
- LocationPath locationPath = (LocationPath) node;
+ final LocationPath locationPath = (LocationPath) node;
if (locationPath.isAbsolute()) {
// Should be at least two steps
- List<Step> steps = locationPath.getSteps();
+ @SuppressWarnings("unchecked")
+ final List<Step> steps = locationPath.getSteps();
+
if (steps.size() >= 2) {
- Step step1 = steps.get(0);
- Step step2 = steps.get(1);
+ final Step step1 = steps.get(0);
+ final Step step2 = steps.get(1);
// First step should be an AllNodeStep using the
// descendant or self axis
if (step1 instanceof AllNodeStep
- && ((AllNodeStep) step1).getAxis() == Axis.DESCENDANT_OR_SELF) {
+ && step1.getAxis() == Axis.DESCENDANT_OR_SELF) {
// Second step should be a NameStep using the child
// axis.
- if (step2 instanceof NameStep && ((NameStep) step2).getAxis() == Axis.CHILD) {
+ if (step2 instanceof NameStep && step2.getAxis() == Axis.CHILD) {
// Construct a new expression that is
// appropriate for RuleChain use
- XPathFactory xpathFactory = new DefaultXPathFactory();
+ final XPathFactory xpathFactory = new DefaultXPathFactory();
// Instead of an absolute location path, we'll
// be using a relative path
- LocationPath relativeLocationPath = xpathFactory.createRelativeLocationPath();
+ final LocationPath relativeLocationPath = xpathFactory.createRelativeLocationPath();
// The first step will be along the self axis
- Step allNodeStep = xpathFactory.createAllNodeStep(Axis.SELF);
+ final Step allNodeStep = xpathFactory.createAllNodeStep(Axis.SELF);
// Retain all predicates from the original name
// step
- for (Iterator<Predicate> i = step2.getPredicates().iterator(); i.hasNext();) {
- allNodeStep.addPredicate(i.next());
+ @SuppressWarnings("unchecked")
+ final List<Predicate> predicates = step2.getPredicates();
+
+ for (Predicate predicate : predicates) {
+ allNodeStep.addPredicate(predicate);
}
relativeLocationPath.addStep(allNodeStep);
@@ -172,8 +187,8 @@ private void initializeXPathExpression(Navigator navigator) throws JaxenExceptio
relativeLocationPath.addStep(steps.get(i));
}
- BaseXPath xpath = createXPath(relativeLocationPath.getText(), navigator);
- indexXPath(xpath, ((NameStep) step2).getLocalName());
+ final BaseXPath xpath = createXPath(relativeLocationPath.getText(), navigator);
+ addQueryToNode(xpath, ((NameStep) step2).getLocalName());
valid = true;
}
}
@@ -200,9 +215,9 @@ private void initializeXPathExpression(Navigator navigator) throws JaxenExceptio
} else {
// Use original XPath if we cannot use the RuleChain
nodeNameToXPaths.clear();
- indexXPath(originalXPath, AST_ROOT);
+ addQueryToNode(originalXPath, AST_ROOT);
if (LOG.isLoggable(Level.FINE)) {
- LOG.log(Level.FINE, "Unable to use RuleChain for for XPath: " + xpath);
+ LOG.log(Level.FINE, "Unable to use RuleChain for XPath: " + xpath);
}
}
@@ -213,27 +228,32 @@ private void initializeXPathExpression(Navigator navigator) throws JaxenExceptio
} else {
this.initializationStatus = InitializationStatus.FULL;
}
-
}
- private void indexXPath(XPath xpath, String nodeName) {
- List<XPath> xpaths = nodeNameToXPaths.get(nodeName);
- if (xpaths == null) {
- xpaths = new ArrayList<>();
- nodeNameToXPaths.put(nodeName, xpaths);
+ /**
+ * Relates an XPath query to a node by adding the query to the {@link #nodeNameToXPaths}.
+ *
+ * @param xPath the query to do over a node
+ * @param nodeName the node on which to do the query
+ */
+ private void addQueryToNode(final XPath xPath, final String nodeName) {
+ List<XPath> xPathsForNode = nodeNameToXPaths.get(nodeName);
+ if (xPathsForNode == null) {
+ xPathsForNode = new ArrayList<>();
+ nodeNameToXPaths.put(nodeName, xPathsForNode);
}
- xpaths.add(xpath);
+ xPathsForNode.add(xPath);
}
- private BaseXPath createXPath(String xpathQueryString, Navigator navigator) throws JaxenException {
+ private BaseXPath createXPath(final String xpathQueryString, final Navigator navigator) throws JaxenException {
+ final BaseXPath xpath = new BaseXPath(xpathQueryString, navigator);
- BaseXPath xpath = new BaseXPath(xpathQueryString, navigator);
if (properties.size() > 1) {
- SimpleVariableContext vc = new SimpleVariableContext();
+ final SimpleVariableContext vc = new SimpleVariableContext();
for (Entry<PropertyDescriptor<?>, Object> e : properties.entrySet()) {
- String propName = e.getKey().name();
+ final String propName = e.getKey().name();
if (!"xpath".equals(propName)) {
- Object value = e.getValue();
+ final Object value = e.getValue();
vc.setVariableValue(propName, value != null ? value.toString() : null);
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/SaxonXPathRuleQuery.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/SaxonXPathRuleQuery.java
index 042ead7aa08..ddbe17615b7 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/SaxonXPathRuleQuery.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/SaxonXPathRuleQuery.java
@@ -8,18 +8,16 @@
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
+import java.util.regex.Pattern;
import net.sourceforge.pmd.RuleContext;
import net.sourceforge.pmd.lang.ast.Node;
import net.sourceforge.pmd.lang.ast.xpath.saxon.DocumentNode;
import net.sourceforge.pmd.lang.ast.xpath.saxon.ElementNode;
import net.sourceforge.pmd.lang.xpath.Initializer;
-import net.sourceforge.pmd.properties.BooleanProperty;
-import net.sourceforge.pmd.properties.EnumeratedProperty;
-import net.sourceforge.pmd.properties.IntegerProperty;
import net.sourceforge.pmd.properties.PropertyDescriptor;
-import net.sourceforge.pmd.properties.StringProperty;
+import net.sf.saxon.om.Item;
import net.sf.saxon.om.ValueRepresentation;
import net.sf.saxon.sxpath.AbstractStaticContext;
import net.sf.saxon.sxpath.IndependentContext;
@@ -29,108 +27,131 @@
import net.sf.saxon.sxpath.XPathStaticContext;
import net.sf.saxon.sxpath.XPathVariable;
import net.sf.saxon.trans.XPathException;
+import net.sf.saxon.value.AtomicValue;
+import net.sf.saxon.value.BigIntegerValue;
import net.sf.saxon.value.BooleanValue;
+import net.sf.saxon.value.DoubleValue;
+import net.sf.saxon.value.EmptySequence;
+import net.sf.saxon.value.FloatValue;
import net.sf.saxon.value.Int64Value;
+import net.sf.saxon.value.SequenceExtent;
import net.sf.saxon.value.StringValue;
+import net.sf.saxon.value.UntypedAtomicValue;
/**
* This is a Saxon based XPathRule query.
*/
public class SaxonXPathRuleQuery extends AbstractXPathRuleQuery {
- // Mapping from Node name to applicable XPath queries
- private XPathExpression xpathExpression;
- private List<XPathVariable> xpathVariables;
-
private static final int MAX_CACHE_SIZE = 20;
private static final Map<Node, DocumentNode> CACHE = new LinkedHashMap<Node, DocumentNode>(MAX_CACHE_SIZE) {
private static final long serialVersionUID = -7653916493967142443L;
+ @Override
protected boolean removeEldestEntry(final Map.Entry<Node, DocumentNode> eldest) {
return size() > MAX_CACHE_SIZE;
}
};
/**
- * {@inheritDoc}
+ * Representation of an XPath query, created at {@link #initializeXPathExpression()} using {@link #xpath}.
+ */
+ private XPathExpression xpathExpression;
+
+ /**
+ * Holds the static context later used to match the variables in the dynamic context in
+ * {@link #createDynamicContext(ElementNode)}. Created at {@link #initializeXPathExpression()}
+ * using the properties descriptors in {@link #properties}.
*/
+ private List<XPathVariable> xpathVariables;
+
@Override
public boolean isSupportedVersion(String version) {
return XPATH_1_0_COMPATIBILITY.equals(version) || XPATH_2_0.equals(version);
}
- /**
- * {@inheritDoc}
- */
@Override
@SuppressWarnings("unchecked")
- public List<Node> evaluate(Node node, RuleContext data) {
+ public List<Node> evaluate(final Node node, final RuleContext data) {
initializeXPathExpression();
- List<Node> results = new ArrayList<>();
try {
- // Get the DocumentNode for the AST
- DocumentNode documentNode = getDocumentNode(node);
-
- // Get the corresponding ElementNode for this node.
- ElementNode rootElementNode = documentNode.nodeToElementNode.get(node);
-
- // Create a dynamic context for this node
- XPathDynamicContext xpathDynamicContext = xpathExpression.createDynamicContext(rootElementNode);
-
- // Set variable values on the dynamic context
- for (XPathVariable xpathVariable : xpathVariables) {
- String name = xpathVariable.getVariableQName().getLocalName();
- for (Map.Entry<PropertyDescriptor<?>, Object> entry : super.properties.entrySet()) {
- if (name.equals(entry.getKey().name())) {
- PropertyDescriptor<?> propertyDescriptor = entry.getKey();
- Object value = entry.getValue();
- ValueRepresentation valueRepresentation;
-
- // TODO Need to handle null values?
- // TODO Need to handle more PropertyDescriptors, is
- // there an easy factory in Saxon we can use for this?
- if (propertyDescriptor instanceof StringProperty) {
- valueRepresentation = new StringValue((String) value);
- } else if (propertyDescriptor instanceof BooleanProperty) {
- valueRepresentation = BooleanValue.get((Boolean) value);
- } else if (propertyDescriptor instanceof IntegerProperty) {
- valueRepresentation = Int64Value.makeIntegerValue((Integer) value);
- } else if (propertyDescriptor instanceof EnumeratedProperty) {
- if (value instanceof String) {
- valueRepresentation = new StringValue((String) value);
- } else {
- throw new RuntimeException(
- "Unable to create ValueRepresentaton for non-String EnumeratedProperty value: "
- + value);
- }
- } else {
- throw new RuntimeException("Unable to create ValueRepresentaton for PropertyDescriptor: "
- + propertyDescriptor);
- }
- xpathDynamicContext.setVariable(xpathVariable, valueRepresentation);
- }
- }
- }
+ final DocumentNode documentNode = getDocumentNodeForRootNode(node);
- List<ElementNode> nodes = xpathExpression.evaluate(xpathDynamicContext);
- for (ElementNode elementNode : nodes) {
+ // Map AST Node -> Saxon Node
+ final ElementNode rootElementNode = documentNode.nodeToElementNode.get(node);
+
+ final XPathDynamicContext xpathDynamicContext = createDynamicContext(rootElementNode);
+ final List<ElementNode> nodes = xpathExpression.evaluate(xpathDynamicContext);
+
+ /*
+ Map List of Saxon Nodes -> List of AST Nodes, which were detected to match the XPath expression
+ (i.e. violation found)
+ */
+ final List<Node> results = new ArrayList<>();
+ for (final ElementNode elementNode : nodes) {
results.add((Node) elementNode.getUnderlyingNode());
}
- } catch (XPathException e) {
+ return results;
+ } catch (final XPathException e) {
throw new RuntimeException(super.xpath + " had problem: " + e.getMessage(), e);
}
- return results;
}
- private DocumentNode getDocumentNode(Node node) {
- // Get the root AST node
- Node root = node;
- while (root.jjtGetParent() != null) {
- root = root.jjtGetParent();
+ /**
+ * Attempt to create a dynamic context on which to evaluate the {@link #xpathExpression}.
+ *
+ * @param elementNode the node on which to create the context; generally this node is the root node of the Saxon
+ * Tree
+ * @return the dynamic context on which to run the query
+ * @throws XPathException if the supplied value does not conform to the required type of the
+ * variable, when setting up the dynamic context; or if the supplied value contains a node that does not belong to
+ * this Configuration (or another Configuration that shares the same namePool)
+ */
+ private XPathDynamicContext createDynamicContext(final ElementNode elementNode) throws XPathException {
+ final XPathDynamicContext dynamicContext = xpathExpression.createDynamicContext(elementNode);
+
+ // Set variable values on the dynamic context
+ for (final XPathVariable xpathVariable : xpathVariables) {
+ final String variableName = xpathVariable.getVariableQName().getLocalName();
+ for (final Map.Entry<PropertyDescriptor<?>, Object> entry : super.properties.entrySet()) {
+ if (variableName.equals(entry.getKey().name())) {
+ final ValueRepresentation valueRepresentation = getRepresentation(entry.getKey(), entry.getValue());
+ dynamicContext.setVariable(xpathVariable, valueRepresentation);
+ }
+ }
}
+ return dynamicContext;
+ }
+
+
+ private ValueRepresentation getRepresentation(final PropertyDescriptor<?> descriptor, final Object value) {
+ if (descriptor.isMultiValue()) {
+ final List<?> val = (List<?>) value;
+ if (val.isEmpty()) {
+ return EmptySequence.getInstance();
+ }
+ final Item[] converted = new Item[val.size()];
+ for (int i = 0; i < val.size(); i++) {
+ converted[i] = getAtomicRepresentation(val.get(i));
+ }
+ return new SequenceExtent(converted);
+ } else {
+ return getAtomicRepresentation(value);
+ }
+ }
+
+ /**
+ * Gets the DocumentNode representation for the whole AST in which the node is, that is, if the node is not the root
+ * of the AST, then the AST is traversed all the way up until the root node is found. If the DocumentNode was
+ * cached because this method was previously called, then a new DocumentNode will not be instanced.
+ *
+ * @param node the node from which the root node will be looked for.
+ * @return the DocumentNode representing the whole AST
+ */
+ private DocumentNode getDocumentNodeForRootNode(final Node node) {
+ final Node root = getRootNode(node);
- // Cache DocumentNode trees, so that different XPath queries can re-use them.
DocumentNode documentNode;
synchronized (CACHE) {
documentNode = CACHE.get(root);
@@ -142,13 +163,30 @@ private DocumentNode getDocumentNode(Node node) {
return documentNode;
}
+ /**
+ * Traverse the AST until the root node is found.
+ *
+ * @param node the node from where to start traversing the tree
+ * @return the root node
+ */
+ private Node getRootNode(final Node node) {
+ Node root = node;
+ while (root.jjtGetParent() != null) {
+ root = root.jjtGetParent();
+ }
+ return root;
+ }
+
+ /**
+ * Initialize the {@link #xpathExpression} and the {@link #xpathVariables}.
+ */
private void initializeXPathExpression() {
if (xpathExpression != null) {
return;
}
try {
- XPathEvaluator xpathEvaluator = new XPathEvaluator();
- XPathStaticContext xpathStaticContext = xpathEvaluator.getStaticContext();
+ final XPathEvaluator xpathEvaluator = new XPathEvaluator();
+ final XPathStaticContext xpathStaticContext = xpathEvaluator.getStaticContext();
// Enable XPath 1.0 compatibility
if (XPATH_1_0_COMPATIBILITY.equals(version)) {
@@ -158,14 +196,16 @@ private void initializeXPathExpression() {
// Register PMD functions
Initializer.initialize((IndependentContext) xpathStaticContext);
- // Create XPathVariables for later use. It is a Saxon quirk that
- // XPathVariables must be defined on the static context, and
- // reused later to associate an actual value on the dynamic context.
+ /*
+ Create XPathVariables for later use. It is a Saxon quirk that XPathVariables must be defined on the
+ static context, and reused later to associate an actual value on the dynamic context creation, in
+ createDynamicContext(ElementNode).
+ */
xpathVariables = new ArrayList<>();
- for (PropertyDescriptor<?> propertyDescriptor : super.properties.keySet()) {
- String name = propertyDescriptor.name();
+ for (final PropertyDescriptor<?> propertyDescriptor : super.properties.keySet()) {
+ final String name = propertyDescriptor.name();
if (!"xpath".equals(name)) {
- XPathVariable xpathVariable = xpathStaticContext.declareVariable(null, name);
+ final XPathVariable xpathVariable = xpathStaticContext.declareVariable(null, name);
xpathVariables.add(xpathVariable);
}
}
@@ -174,8 +214,48 @@ private void initializeXPathExpression() {
// an approach which used Jaxen's stuff, but that only works for
// 1.0 compatibility mode. Rather do it right instead of kludging.
xpathExpression = xpathEvaluator.createExpression(super.xpath);
- } catch (XPathException e) {
+ } catch (final XPathException e) {
throw new RuntimeException(e);
}
}
+
+
+ /**
+ * Gets the Saxon representation of the parameter, if its type corresponds
+ * to an XPath 2.0 atomic datatype.
+ *
+ * @param value The value to convert
+ *
+ * @return The converted AtomicValue
+ */
+ public static AtomicValue getAtomicRepresentation(final Object value) {
+
+ /*
+ FUTURE When supported, we should consider refactor this implementation to use Pattern Matching
+ (see http://openjdk.java.net/jeps/305) so that it looks clearer.
+ */
+ if (value == null) {
+ return UntypedAtomicValue.ZERO_LENGTH_UNTYPED;
+
+ } else if (value instanceof String) {
+ return new StringValue((String) value);
+ } else if (value instanceof Boolean) {
+ return BooleanValue.get((Boolean) value);
+ } else if (value instanceof Integer) {
+ return Int64Value.makeIntegerValue((Integer) value);
+ } else if (value instanceof Long) {
+ return new BigIntegerValue((Long) value);
+ } else if (value instanceof Double) {
+ return new DoubleValue((Double) value);
+ } else if (value instanceof Character) {
+ return new StringValue(value.toString());
+ } else if (value instanceof Float) {
+ return new FloatValue((Float) value);
+ } else if (value instanceof Pattern) {
+ return new StringValue(String.valueOf(value));
+ } else {
+ // We could maybe use UntypedAtomicValue
+ throw new RuntimeException("Unable to create ValueRepresentation for value of type: " + value.getClass());
+ }
+ }
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/XPathRuleQuery.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/XPathRuleQuery.java
index 6a2109cdfe5..dedd90deab9 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/XPathRuleQuery.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/xpath/XPathRuleQuery.java
@@ -14,12 +14,14 @@
/**
* This interface captures the logic needed by XPathRule to implement an XPath
* based query on an AST Node.
+ *
* <p>
* Implementations of this class do not need to be thread-safe, but they will be
* reused to query against different AST Nodes. Therefore, internal state should
* be maintained in a fashion consistent with reuse. Further, implementations
* are recommended to manage internal state that is invariant over AST Nodes in
* a fashion which facilities high performance (e.g. caching).
+ * </p>
*/
public interface XPathRuleQuery {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/xpath/Initializer.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/xpath/Initializer.java
index bb69fd43f88..c73ef828a7b 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/xpath/Initializer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/xpath/Initializer.java
@@ -4,6 +4,7 @@
package net.sourceforge.pmd.lang.xpath;
+import net.sourceforge.pmd.annotation.InternalApi;
import net.sourceforge.pmd.lang.Language;
import net.sourceforge.pmd.lang.LanguageRegistry;
import net.sourceforge.pmd.lang.LanguageVersion;
@@ -16,8 +17,12 @@
* initialization. For example, initializing custom Jaxen Functions.
* Initialization should be performed before any XPath related operations are
* performed.
+ *
+ * @deprecated Is internal API
*/
-public class Initializer {
+@InternalApi
+@Deprecated
+public final class Initializer {
private Initializer() { }
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/xpath/MatchesFunction.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/xpath/MatchesFunction.java
index 67493ca9c50..252ed9bdece 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/xpath/MatchesFunction.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/xpath/MatchesFunction.java
@@ -14,9 +14,12 @@
import org.jaxen.SimpleFunctionContext;
import org.jaxen.XPathFunctionContext;
+import net.sourceforge.pmd.annotation.InternalApi;
import net.sourceforge.pmd.lang.ast.xpath.Attribute;
// FIXME Can this function be extended to work on non-AST attributes?
+@InternalApi
+@Deprecated
public class MatchesFunction implements Function {
public static void registerSelfInSimpleContext() {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/xpath/PMDFunctions.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/xpath/PMDFunctions.java
index 2619c3e1e5d..5a26e7b75c8 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/xpath/PMDFunctions.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/xpath/PMDFunctions.java
@@ -4,7 +4,12 @@
package net.sourceforge.pmd.lang.xpath;
-public class PMDFunctions {
+import net.sourceforge.pmd.annotation.InternalApi;
+
+
+@InternalApi
+@Deprecated
+public final class PMDFunctions {
private PMDFunctions() { }
public static boolean matches(String s, String pattern1) {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/processor/AbstractPMDProcessor.java b/pmd-core/src/main/java/net/sourceforge/pmd/processor/AbstractPMDProcessor.java
index b16491a7593..412b8e0aab4 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/processor/AbstractPMDProcessor.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/processor/AbstractPMDProcessor.java
@@ -5,17 +5,23 @@
package net.sourceforge.pmd.processor;
import java.io.IOException;
+import java.util.HashSet;
import java.util.List;
+import java.util.Set;
+import java.util.logging.Level;
+import java.util.logging.Logger;
import net.sourceforge.pmd.PMDConfiguration;
import net.sourceforge.pmd.Report;
+import net.sourceforge.pmd.Rule;
import net.sourceforge.pmd.RuleContext;
import net.sourceforge.pmd.RuleSetFactory;
import net.sourceforge.pmd.RuleSets;
import net.sourceforge.pmd.RulesetsFactoryUtils;
import net.sourceforge.pmd.SourceCodeProcessor;
-import net.sourceforge.pmd.benchmark.Benchmark;
-import net.sourceforge.pmd.benchmark.Benchmarker;
+import net.sourceforge.pmd.benchmark.TimeTracker;
+import net.sourceforge.pmd.benchmark.TimedOperation;
+import net.sourceforge.pmd.benchmark.TimedOperationCategory;
import net.sourceforge.pmd.renderers.Renderer;
import net.sourceforge.pmd.util.datasource.DataSource;
@@ -25,6 +31,8 @@
*/
public abstract class AbstractPMDProcessor {
+ private static final Logger LOG = Logger.getLogger(AbstractPMDProcessor.class.getName());
+
protected final PMDConfiguration configuration;
public AbstractPMDProcessor(PMDConfiguration configuration) {
@@ -33,16 +41,12 @@ public AbstractPMDProcessor(PMDConfiguration configuration) {
public void renderReports(final List<Renderer> renderers, final Report report) {
- long start = System.nanoTime();
-
- try {
+ try (TimedOperation to = TimeTracker.startOperation(TimedOperationCategory.REPORTING)) {
for (Renderer r : renderers) {
r.renderFileReport(report);
}
- long end = System.nanoTime();
- Benchmarker.mark(Benchmark.Reporting, end - start, 1);
} catch (IOException ioe) {
-
+ throw new RuntimeException(ioe);
}
}
@@ -56,26 +60,58 @@ protected String filenameFrom(DataSource dataSource) {
* not</strong> be used by different threads. Each thread must create its
* own copy of the rules.
*
- * @param factory
+ * @param factory The factory used to create the configured rule sets
+ * @param report The base report on which to report any configuration errors
* @return the rules within a rulesets
*/
- protected RuleSets createRuleSets(RuleSetFactory factory) {
- return RulesetsFactoryUtils.getRuleSets(configuration.getRuleSets(), factory);
+ protected RuleSets createRuleSets(RuleSetFactory factory, Report report) {
+ final RuleSets rs = RulesetsFactoryUtils.getRuleSets(configuration.getRuleSets(), factory);
+
+ final Set<Rule> brokenRules = removeBrokenRules(rs);
+ for (final Rule rule : brokenRules) {
+ report.addConfigError(new Report.ConfigurationError(rule, rule.dysfunctionReason()));
+ }
+
+ return rs;
+ }
+
+ /**
+ * Remove and return the misconfigured rules from the rulesets and log them
+ * for good measure.
+ *
+ * @param ruleSets RuleSets to prune of broken rules.
+ * @return Set<Rule>
+ */
+ private Set<Rule> removeBrokenRules(final RuleSets ruleSets) {
+ final Set<Rule> brokenRules = new HashSet<>();
+ ruleSets.removeDysfunctionalRules(brokenRules);
+
+ for (final Rule rule : brokenRules) {
+ if (LOG.isLoggable(Level.WARNING)) {
+ LOG.log(Level.WARNING,
+ "Removed misconfigured rule: " + rule.getName() + " cause: " + rule.dysfunctionReason());
+ }
+ }
+
+ return brokenRules;
}
public void processFiles(RuleSetFactory ruleSetFactory, List<DataSource> files, RuleContext ctx,
List<Renderer> renderers) {
- RuleSets rs = createRuleSets(ruleSetFactory);
+ RuleSets rs = createRuleSets(ruleSetFactory, ctx.getReport());
configuration.getAnalysisCache().checkValidity(rs, configuration.getClassLoader());
SourceCodeProcessor processor = new SourceCodeProcessor(configuration);
for (DataSource dataSource : files) {
String niceFileName = filenameFrom(dataSource);
- runAnalysis(new PmdRunnable(configuration, dataSource, niceFileName, renderers,
- ctx, ruleSetFactory, processor));
+ runAnalysis(new PmdRunnable(dataSource, niceFileName, renderers, ctx, rs, processor));
}
+ // render base report first - general errors
+ renderReports(renderers, ctx.getReport());
+
+ // then add analysis results per file
collectReports(renderers);
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/processor/MultiThreadProcessor.java b/pmd-core/src/main/java/net/sourceforge/pmd/processor/MultiThreadProcessor.java
index 68a68b6f716..f398a90db8a 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/processor/MultiThreadProcessor.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/processor/MultiThreadProcessor.java
@@ -4,57 +4,51 @@
package net.sourceforge.pmd.processor;
-import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.CompletionService;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorCompletionService;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
-import java.util.concurrent.Future;
-import java.util.concurrent.ThreadFactory;
import net.sourceforge.pmd.PMDConfiguration;
import net.sourceforge.pmd.Report;
import net.sourceforge.pmd.renderers.Renderer;
+
/**
* @author Romain Pelisse <belaran@gmail.com>
- *
*/
public class MultiThreadProcessor extends AbstractPMDProcessor {
+ private final ExecutorService executor;
+ private final CompletionService<Report> completionService;
- private ThreadFactory factory;
- private ExecutorService executor;
- private CompletionService<Report> completionService;
- private List<Future<Report>> tasks = new ArrayList<>();
+ private long submittedTasks = 0L;
public MultiThreadProcessor(final PMDConfiguration configuration) {
super(configuration);
- factory = new PmdThreadFactory();
- executor = Executors.newFixedThreadPool(configuration.getThreads(), factory);
+ executor = Executors.newFixedThreadPool(configuration.getThreads(), new PmdThreadFactory());
completionService = new ExecutorCompletionService<>(executor);
}
@Override
protected void runAnalysis(PmdRunnable runnable) {
- // multi-threaded execution, dispatch analysis to worker threads
- tasks.add(completionService.submit(runnable));
+ completionService.submit(runnable);
+ submittedTasks++;
}
@Override
protected void collectReports(List<Renderer> renderers) {
- // Collect result analysis, waiting for termination if needed
try {
- for (int i = 0; i < tasks.size(); i++) {
+ for (int i = 0; i < submittedTasks; i++) {
final Report report = completionService.take().get();
super.renderReports(renderers, report);
}
- } catch (InterruptedException ie) {
+ } catch (final InterruptedException ie) {
Thread.currentThread().interrupt();
- } catch (ExecutionException ee) {
- Throwable t = ee.getCause();
+ } catch (final ExecutionException ee) {
+ final Throwable t = ee.getCause();
if (t instanceof RuntimeException) {
throw (RuntimeException) t;
} else if (t instanceof Error) {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/processor/PmdRunnable.java b/pmd-core/src/main/java/net/sourceforge/pmd/processor/PmdRunnable.java
index 4b416f8e9db..0adf3a8a4b4 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/processor/PmdRunnable.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/processor/PmdRunnable.java
@@ -12,15 +12,12 @@
import java.util.logging.Level;
import java.util.logging.Logger;
-import net.sourceforge.pmd.PMD;
-import net.sourceforge.pmd.PMDConfiguration;
import net.sourceforge.pmd.PMDException;
import net.sourceforge.pmd.Report;
import net.sourceforge.pmd.RuleContext;
-import net.sourceforge.pmd.RuleSetFactory;
-import net.sourceforge.pmd.RuleSetNotFoundException;
import net.sourceforge.pmd.RuleSets;
import net.sourceforge.pmd.SourceCodeProcessor;
+import net.sourceforge.pmd.benchmark.TimeTracker;
import net.sourceforge.pmd.renderers.Renderer;
import net.sourceforge.pmd.util.datasource.DataSource;
@@ -30,23 +27,20 @@ public class PmdRunnable implements Callable<Report> {
private static final ThreadLocal<ThreadContext> LOCAL_THREAD_CONTEXT = new ThreadLocal<>();
- private final PMDConfiguration configuration;
private final DataSource dataSource;
private final String fileName;
private final List<Renderer> renderers;
private final RuleContext ruleContext;
- private final RuleSetFactory ruleSetFactory;
+ private final RuleSets ruleSets;
private final SourceCodeProcessor sourceCodeProcessor;
- public PmdRunnable(PMDConfiguration configuration, DataSource dataSource, String fileName,
- List<Renderer> renderers, RuleContext ruleContext, RuleSetFactory ruleSetFactory,
- SourceCodeProcessor sourceCodeProcessor) {
- this.configuration = configuration;
+ public PmdRunnable(DataSource dataSource, String fileName, List<Renderer> renderers,
+ RuleContext ruleContext, RuleSets ruleSets, SourceCodeProcessor sourceCodeProcessor) {
+ this.ruleSets = ruleSets;
this.dataSource = dataSource;
this.fileName = fileName;
this.renderers = renderers;
this.ruleContext = ruleContext;
- this.ruleSetFactory = ruleSetFactory;
this.sourceCodeProcessor = sourceCodeProcessor;
}
@@ -62,23 +56,15 @@ private void addError(Report report, Exception e, String errorMessage) {
@Override
public Report call() {
+ TimeTracker.initThread();
+
ThreadContext tc = LOCAL_THREAD_CONTEXT.get();
if (tc == null) {
- try {
- tc = new ThreadContext(ruleSetFactory.createRuleSets(configuration.getRuleSets()),
- new RuleContext(ruleContext));
- } catch (RuleSetNotFoundException e) {
- throw new RuntimeException(e);
- }
+ tc = new ThreadContext(new RuleSets(ruleSets), new RuleContext(ruleContext));
LOCAL_THREAD_CONTEXT.set(tc);
}
- /*
- * FIXME : This creates ConfigErrors for dysfunctional rules **per-thread**.
- * We need rulesets to be copy-constructable and have them cleaned-up only once
- * before analysis starts, reducing this to Report.createReport(tc.ruleContext, fileName);
- */
- Report report = PMD.setupReport(tc.ruleSets, tc.ruleContext, fileName);
+ Report report = Report.createReport(tc.ruleContext, fileName);
if (LOG.isLoggable(Level.FINE)) {
LOG.fine("Processing " + tc.ruleContext.getSourceCodeFilename());
@@ -87,8 +73,7 @@ public Report call() {
r.startFileAnalysis(dataSource);
}
- try {
- InputStream stream = new BufferedInputStream(dataSource.getInputStream());
+ try (InputStream stream = new BufferedInputStream(dataSource.getInputStream())) {
tc.ruleContext.setLanguageVersion(null);
sourceCodeProcessor.processSourceCode(stream, tc.ruleSets, tc.ruleContext);
} catch (PMDException pmde) {
@@ -99,6 +84,8 @@ public Report call() {
addError(report, re, "RuntimeException during processing of " + fileName);
}
+ TimeTracker.finishThread();
+
return report;
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractMultiNumericProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractMultiNumericProperty.java
index 2d9bd655bd5..b72bb6b4cde 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractMultiNumericProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractMultiNumericProperty.java
@@ -9,12 +9,14 @@
import net.sourceforge.pmd.properties.modules.NumericPropertyModule;
+
/**
* Base class for multi-valued numeric properties.
*
* @param <T> The type of number
*
* @author Brian Remedios
+ * @author Clément Fournier
* @version Refactored June 2017 (6.0.0)
*/
/* default */ abstract class AbstractMultiNumericProperty<T extends Number> extends AbstractMultiValueProperty<T>
@@ -41,6 +43,9 @@
super(theName, theDescription, theDefault, theUIOrder, isDefinedExternally);
module = new NumericPropertyModule<>(lower, upper);
+ for (T num : theDefault) {
+ module.checkNumber(num);
+ }
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractMultiPackagedProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractMultiPackagedProperty.java
index a39cf3a7b46..a9183adcae9 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractMultiPackagedProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractMultiPackagedProperty.java
@@ -9,16 +9,18 @@
import net.sourceforge.pmd.properties.modules.PackagedPropertyModule;
+
/**
* Multi-valued property restricting the type of its values to some packages.
*
* @param <T> The type of the values
*
* @author Brian Remedios
+ * @author Clément Fournier
* @version Refactored June 2017 (6.0.0)
*/
/* default */ abstract class AbstractMultiPackagedProperty<T> extends AbstractMultiValueProperty<T>
- implements PackagedPropertyDescriptor<List<T>> {
+ implements PackagedPropertyDescriptor<List<T>> {
protected final PackagedPropertyModule<T> module;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractMultiValueProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractMultiValueProperty.java
index f016f17c3c1..514ed200033 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractMultiValueProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractMultiValueProperty.java
@@ -14,6 +14,7 @@
import net.sourceforge.pmd.Rule;
+
/**
* Multi-valued property.
*
@@ -23,7 +24,7 @@
* @version 6.0.0
*/
/* default */ abstract class AbstractMultiValueProperty<V> extends AbstractProperty<List<V>>
- implements MultiValuePropertyDescriptor<V> {
+ implements MultiValuePropertyDescriptor<V> {
/** The default value. */
@@ -118,6 +119,7 @@ private boolean defaultHasNullValue() {
*
* @return A string representation of the default value.
*/
+ @Override
protected String defaultAsString() {
return asDelimitedString(defaultValue(), multiValueDelimiter());
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractNumericProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractNumericProperty.java
index d942e02d60a..9c6c42f9d36 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractNumericProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractNumericProperty.java
@@ -8,17 +8,18 @@
import net.sourceforge.pmd.properties.modules.NumericPropertyModule;
+
/**
- * Maintains a pair of boundary limit values between which all values managed by
- * the subclasses must fit.
+ * Maintains a pair of boundary limit values between which all values managed by the subclasses must fit.
*
* @param <T> The type of value.
*
* @author Brian Remedios
+ * @author Clément Fournier
* @version Refactored June 2017 (6.0.0)
*/
/* default */ abstract class AbstractNumericProperty<T extends Number> extends AbstractSingleValueProperty<T>
- implements NumericPropertyDescriptor<T> {
+ implements NumericPropertyDescriptor<T> {
private final NumericPropertyModule<T> module;
@@ -42,8 +43,10 @@ protected AbstractNumericProperty(String theName, String theDescription, T lower
super(theName, theDescription, theDefault, theUIOrder, isDefinedExternally);
module = new NumericPropertyModule<>(lower, upper);
-
-
+ if (theDefault == null) {
+ return; // TODO: remove me when you scrap StatisticalRule (see pull #727)
+ }
+ module.checkNumber(theDefault);
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractPackagedProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractPackagedProperty.java
index d9aafbff697..3d498026a16 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractPackagedProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractPackagedProperty.java
@@ -8,17 +8,19 @@
import net.sourceforge.pmd.properties.modules.PackagedPropertyModule;
+
/**
- * Property which restricts the type of its values to some packages. If
- * the legalPackageNames value is set to null then no restrictions are made.
+ * Property which restricts the type of its values to some packages. If the legalPackageNames value is set to null then
+ * no restrictions are made.
*
* @param <T> The type of the values
*
* @author Brian Remedios
+ * @author Clément Fournier
* @version Refactored June 2017 (6.0.0)
*/
/* default */ abstract class AbstractPackagedProperty<T> extends AbstractSingleValueProperty<T>
- implements PackagedPropertyDescriptor<T> {
+ implements PackagedPropertyDescriptor<T> {
protected final PackagedPropertyModule<T> module;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractProperty.java
index 2b1650b651f..ab1815ddefe 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractProperty.java
@@ -13,12 +13,14 @@
import org.apache.commons.lang3.StringUtils;
+
/**
* Abstract class for properties.
*
* @param <T> The type of the property's value. This is a list type for multi-valued properties
*
* @author Brian Remedios
+ * @author Clément Fournier
* @version Refactored June 2017 (6.0.0)
*/
/* default */ abstract class AbstractProperty<T> implements PropertyDescriptor<T> {
@@ -50,14 +52,6 @@ protected AbstractProperty(String theName, String theDescription, float theUIOrd
}
- private static String checkNotEmpty(String arg, PropertyDescriptorField argId) throws IllegalArgumentException {
- if (StringUtils.isBlank(arg)) {
- throw new IllegalArgumentException("Property attribute '" + argId + "' cannot be null or blank");
- }
- return arg;
- }
-
-
@Override
public String description() {
return description;
@@ -106,9 +100,9 @@ public int hashCode() {
@Override
public String toString() {
- return "[PropertyDescriptor: name=" + name() + ","
- + " type=" + (isMultiValue() ? "List<" + type() + ">" : type()) + ","
- + " value=" + defaultValue() + "]";
+ return "[PropertyDescriptor: name=" + name() + ','
+ + " type=" + (isMultiValue() ? "List<" + type() + '>' : type()) + ','
+ + " value=" + defaultValue() + ']';
}
@@ -127,8 +121,8 @@ public final Map<PropertyDescriptorField, String> attributeValuesById() {
/**
- * Adds this property's attributes to the map. Subclasses can override this to add more
- * {@link PropertyDescriptorField}.
+ * Adds this property's attributes to the map. Subclasses can override this to add more {@link
+ * PropertyDescriptorField}.
*
* @param attributes The map to fill
*/
@@ -153,4 +147,12 @@ public boolean isDefinedExternally() {
}
+ private static String checkNotEmpty(String arg, PropertyDescriptorField argId) throws IllegalArgumentException {
+ if (StringUtils.isBlank(arg)) {
+ throw new IllegalArgumentException("Property attribute '" + argId + "' cannot be null or blank");
+ }
+ return arg;
+ }
+
+
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractPropertyDescriptorFactory.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractPropertyDescriptorFactory.java
deleted file mode 100755
index e4fb024153c..00000000000
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractPropertyDescriptorFactory.java
+++ /dev/null
@@ -1,312 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.properties;
-
-import static net.sourceforge.pmd.properties.PropertyDescriptor.CORE_EXPECTED_FIELDS;
-import static net.sourceforge.pmd.properties.PropertyDescriptorField.DEFAULT_VALUE;
-import static net.sourceforge.pmd.properties.PropertyDescriptorField.DELIMITER;
-import static net.sourceforge.pmd.properties.PropertyDescriptorField.DESCRIPTION;
-import static net.sourceforge.pmd.properties.PropertyDescriptorField.LEGAL_PACKAGES;
-import static net.sourceforge.pmd.properties.PropertyDescriptorField.MAX;
-import static net.sourceforge.pmd.properties.PropertyDescriptorField.MIN;
-import static net.sourceforge.pmd.properties.PropertyDescriptorField.NAME;
-
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.Map;
-import java.util.Map.Entry;
-import java.util.Set;
-
-import org.apache.commons.lang3.StringUtils;
-
-/**
- * Basic implementation of a property descriptor factory.
- *
- * @param <T> The type of values property descriptor returned by this factory. This can be a list.
- *
- * @author Brian Remedios
- */
-public abstract class AbstractPropertyDescriptorFactory<T> implements PropertyDescriptorFactory<T> {
-
- private final Class<?> valueType;
-
- /**
- * Denote the identifiers of the expected fields paired with booleans
- * denoting whether they are required or not.
- */
- private final Map<PropertyDescriptorField, Boolean> expectedFields;
-
-
- public AbstractPropertyDescriptorFactory(Class<?> theValueType) {
- valueType = theValueType;
- expectedFields = CORE_EXPECTED_FIELDS;
- }
-
-
- public AbstractPropertyDescriptorFactory(Class<?> theValueType, Map<PropertyDescriptorField, Boolean> additionalFieldTypesByKey) {
-
- valueType = theValueType;
- if (additionalFieldTypesByKey == null) {
- expectedFields = CORE_EXPECTED_FIELDS;
- return;
- }
- Map<PropertyDescriptorField, Boolean> temp
- = new HashMap<>(CORE_EXPECTED_FIELDS.size() + additionalFieldTypesByKey.size());
- temp.putAll(CORE_EXPECTED_FIELDS);
- temp.putAll(additionalFieldTypesByKey);
-
- expectedFields = Collections.unmodifiableMap(temp);
- }
-
-
- @Override
- public Class<?> valueType() {
- return valueType;
- }
-
-
- @Override
- public Set<PropertyDescriptorField> expectableFields() {
- return Collections.unmodifiableSet(expectedFields.keySet());
- }
-
-
- /**
- * Retrieves the name of the descriptor from the map.
- *
- * @param valuesById Map of attributes
- *
- * @return The name, which is null if none is specified
- */
- protected String nameIn(Map<PropertyDescriptorField, String> valuesById) {
- return valuesById.get(NAME);
- }
-
-
- /**
- * Retrieves the description from the map.
- *
- * @param valuesById Map of attributes
- *
- * @return The description, which is null if none is specified
- */
- protected String descriptionIn(Map<PropertyDescriptorField, String> valuesById) {
- return valuesById.get(DESCRIPTION);
- }
-
-
- /**
- * Retrieves the default value from the map.
- *
- * @param valuesById Map of attributes
- *
- * @return The default value
- *
- * @throws RuntimeException if the default value is null, empty, or missing
- */
- protected String defaultValueIn(Map<PropertyDescriptorField, String> valuesById) {
- String deft = valuesById.get(DEFAULT_VALUE);
- if (isValueMissing(deft)) {
- throw new RuntimeException("Default value was null, empty, or missing");
- }
- return deft;
- }
-
-
- @Override
- public final PropertyDescriptor<T> createWith(Map<PropertyDescriptorField, String> valuesById) {
- checkRequiredFields(valuesById);
- return createWith(valuesById, false);
- }
-
-
- /** Checks whether all required fields are present in the map. */
- private void checkRequiredFields(Map<PropertyDescriptorField, String> valuesById) {
- for (Entry<PropertyDescriptorField, Boolean> entry : expectedFields.entrySet()) {
- if (entry.getValue() && isValueMissing(valuesById.get(entry.getKey()))) {
- throw new RuntimeException("Missing required value for key: " + entry.getKey());
- }
- }
- }
-
-
- /**
- * Creates a new property descriptor specifying whether the descriptor is externally defined or not. This is
- * meant to be implemented by subclasses.
- *
- * @param valuesById The map of values
- * @param isExternallyDefined Whether the descriptor is externally defined
- *
- * @return A new and initialized {@link PropertyDescriptor}
- */
- protected abstract PropertyDescriptor<T> createWith(Map<PropertyDescriptorField, String> valuesById, boolean isExternallyDefined);
-
-
- /**
- * Checks if the value is considered as missing or not. Some properties support whitespace values, hence the
- * check. By default this does not support it. The factory can override this method to change the predicate.
- *
- * @param value The value to check
- *
- * @return True if the value must be considered missing, false otherwise
- */
- protected boolean isValueMissing(String value) {
- return StringUtils.isBlank(value);
- }
-
-
- /**
- * Creates a new property descriptor which was defined externally.
- *
- * @param valuesById The map of values
- *
- * @return A new and initialized {@link PropertyDescriptor}
- *
- * @see PropertyDescriptor#isDefinedExternally()
- */
- public final PropertyDescriptor<T> createExternalWith(Map<PropertyDescriptorField, String> valuesById) {
- checkRequiredFields(valuesById);
- return createWith(valuesById, true);
- }
-
-
- /**
- * Gets the labels for enumerated properties, returns a string array of length 0 if none are specified.
- *
- * @param valuesById Map of attributes
- *
- * @return An array containing the labels
- */
- protected static String[] labelsIn(Map<PropertyDescriptorField, String> valuesById) {
- return StringUtils.split(valuesById.get(PropertyDescriptorField.LABELS),
- MultiValuePropertyDescriptor.DEFAULT_DELIMITER);
- }
-
-
- // For enumerated properties
- protected static Object[] choicesIn(Map<PropertyDescriptorField, String> valuesById) {
- throw new UnsupportedOperationException(); // TODO: find a way to extract an arbitrary object from a string
- // Maybe reason enough to only allow enums...
- }
-
-
- // For enumerated properties
- protected static int indexIn(Map<PropertyDescriptorField, String> valuesById) {
- throw new UnsupportedOperationException(); // TODO
- }
-
-
- // For enumerated properties
- protected static Class<Object> classIn(Map<PropertyDescriptorField, String> valuesById) {
- throw new UnsupportedOperationException(); // TODO
- }
-
-
- // For enumerated properties
- protected static int[] indicesIn(Map<PropertyDescriptorField, String> valuesById) {
- throw new UnsupportedOperationException(); // TODO
- }
-
-
- /**
- * Finds the delimiter in the map, taking {@link MultiValuePropertyDescriptor#DEFAULT_DELIMITER} if none is
- * mentioned.
- *
- * @param valuesById Map of attributes
- *
- * @return The delimiter or the default
- */
- protected static char delimiterIn(Map<PropertyDescriptorField, String> valuesById) {
- return delimiterIn(valuesById, MultiValuePropertyDescriptor.DEFAULT_DELIMITER);
- }
-
-
- /**
- * Finds the delimiter in the map, taking the specified default delimiter if none is specified.
- *
- * @param valuesById Map of attributes
- * @param defaultDelimiter The default delimiter to take
- *
- * @return The delimiter or the default
- *
- * @throws RuntimeException If the delimiter is present but is more than 1 character
- */
- protected static char delimiterIn(Map<PropertyDescriptorField, String> valuesById, char defaultDelimiter) {
- String characterStr = "";
- if (valuesById.containsKey(DELIMITER)) {
- characterStr = valuesById.get(DELIMITER).trim();
- }
-
- if (StringUtils.isBlank(characterStr)) {
- return defaultDelimiter;
- }
-
- if (characterStr.length() != 1) {
- throw new RuntimeException("Ambiguous delimiter character, must have length 1: \"" + characterStr + "\"");
- }
- return characterStr.charAt(0);
- }
-
-
- /**
- * Retrieves the minimum and maximum values from the map.
- *
- * @param valuesById Map of attributes
- *
- * @return An array of 2 string, min at the left, max at the right
- *
- * @throws RuntimeException If one of them is missing
- */
- protected static String[] minMaxFrom(Map<PropertyDescriptorField, String> valuesById) {
- String min = minValueIn(valuesById);
- String max = maxValueIn(valuesById);
- if (StringUtils.isBlank(min) || StringUtils.isBlank(max)) {
- throw new RuntimeException("min and max values must be specified");
- }
- return new String[] {min, max};
- }
-
-
- private static String minValueIn(Map<PropertyDescriptorField, String> valuesById) {
- return valuesById.get(MIN);
- }
-
-
- private static String maxValueIn(Map<PropertyDescriptorField, String> valuesById) {
- return valuesById.get(MAX);
- }
-
-
- protected static String[] legalPackageNamesIn(Map<PropertyDescriptorField, String> valuesById, char delimiter) {
- String names = valuesById.get(LEGAL_PACKAGES);
- if (StringUtils.isBlank(names)) {
- return null;
- }
- return StringUtils.split(names, delimiter);
- }
-
-
- /**
- * Returns a map describing which fields are required to build a property using this factory. The parameters are
- * added to the {@link PropertyDescriptor#CORE_EXPECTED_FIELDS}, which are required for all descriptors.
- *
- * @param otherKeys Additional keys
- * @param otherValues Whether the corresponding keys are required or not
- *
- * @return The complete map of expected fields.
- */
- static Map<PropertyDescriptorField, Boolean> expectedFieldTypesWith(PropertyDescriptorField[] otherKeys,
- Boolean[] otherValues) {
- Map<PropertyDescriptorField, Boolean> largerMap = new HashMap<>(
- otherKeys.length + CORE_EXPECTED_FIELDS.size());
- largerMap.putAll(CORE_EXPECTED_FIELDS);
- for (int i = 0; i < otherKeys.length; i++) {
- largerMap.put(otherKeys[i], otherValues[i]);
- }
- return largerMap;
- }
-
-
-}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractPropertySource.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractPropertySource.java
index 318ec1ca2b5..2212750a7db 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractPropertySource.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractPropertySource.java
@@ -15,17 +15,45 @@
import net.sourceforge.pmd.util.CollectionUtil;
+
/**
- * Base class for objects which can be configured through properties. Rules and
- * Reports are such objects.
+ * Base class for {@link PropertySource}.
*
* @author Brian Remedios
*/
public abstract class AbstractPropertySource implements PropertySource {
- /** The list of known properties that can be configured. */
+ // setProperty should probably be hidden from Rule implementations, they have no business using that
+ // The apex rules that do that could be refactored to do it in the XML
+
+ // TODO RuleReference should extend this class
+ // This would avoid duplicating the implementation between Rule and RuleReference,
+ // which should use exactly the same mechanism to override properties (XML).
+
+ // BUT to do that RuleReference should not extend AbstractDelegateRule
+ // Indeed, AbstractDelegateRule has no business having this overriding logic built-in,
+ // it would break its contract. For all deeds and purposes that class should be removed.
+
+ // TODO 7.0.0 these fields should be made private final
+
+ /**
+ * The list of known properties that can be configured.
+ *
+ * @deprecated Will be made private final
+ */
+ @Deprecated
protected List<PropertyDescriptor<?>> propertyDescriptors = new ArrayList<>();
- /** The values for each property. */
+
+ /**
+ * The values for each property that were overridden here.
+ * Default property values are not contained in this map.
+ * In other words, if this map doesn't contain a descriptor
+ * which is in {@link #propertyDescriptors}, then it's assumed
+ * to have a default value.
+ *
+ * @deprecated Will be made private final
+ */
+ @Deprecated
protected Map<PropertyDescriptor<?>, Object> propertyValuesByDescriptor = new HashMap<>();
@@ -33,7 +61,9 @@ public abstract class AbstractPropertySource implements PropertySource {
* Creates a copied list of the property descriptors and returns it.
*
* @return a copy of the property descriptors.
+ * @deprecated Just use {@link #getPropertyDescriptors()}
*/
+ @Deprecated
protected List<PropertyDescriptor<?>> copyPropertyDescriptors() {
return new ArrayList<>(propertyDescriptors);
}
@@ -43,13 +73,16 @@ protected List<PropertyDescriptor<?>> copyPropertyDescriptors() {
* Creates a copied map of the values of the properties and returns it.
*
* @return a copy of the values
+ *
+ * @deprecated Just use {@link #getPropertiesByPropertyDescriptor()} or {@link #getOverriddenPropertiesByPropertyDescriptor()}
*/
+ @Deprecated
protected Map<PropertyDescriptor<?>, Object> copyPropertyValues() {
return new HashMap<>(propertyValuesByDescriptor);
}
-
@Override
+ @Deprecated
public Set<PropertyDescriptor<?>> ignoredProperties() {
return Collections.emptySet();
}
@@ -58,11 +91,10 @@ public Set<PropertyDescriptor<?>> ignoredProperties() {
@Override
public void definePropertyDescriptor(PropertyDescriptor<?> propertyDescriptor) {
// Check to ensure the property does not already exist.
- for (PropertyDescriptor<?> descriptor : propertyDescriptors) {
- if (descriptor.name().equals(propertyDescriptor.name())) {
- throw new IllegalArgumentException("There is already a PropertyDescriptor with name '"
- + propertyDescriptor.name() + "' defined on Rule " + getName() + ".");
- }
+ if (getPropertyDescriptor(propertyDescriptor.name()) != null) {
+ throw new IllegalArgumentException("There is already a PropertyDescriptor with name '"
+ + propertyDescriptor.name() + "' defined on " + getPropertySourceType() + " " + getName() + ".");
+
}
propertyDescriptors.add(propertyDescriptor);
// Sort in UI order
@@ -70,14 +102,7 @@ public void definePropertyDescriptor(PropertyDescriptor<?> propertyDescriptor) {
}
- /**
- * Gets the name of the property source. This is e.g. the rule name or the
- * report name.
- *
- * @return the name
- */
- public abstract String getName();
-
+ protected abstract String getPropertySourceType();
@Override
public PropertyDescriptor<?> getPropertyDescriptor(String name) {
@@ -92,18 +117,19 @@ public PropertyDescriptor<?> getPropertyDescriptor(String name) {
@Override
public boolean hasDescriptor(PropertyDescriptor<?> descriptor) {
+ return propertyDescriptors.contains(descriptor);
+ }
- if (propertyValuesByDescriptor.isEmpty()) {
- propertyValuesByDescriptor = getPropertiesByPropertyDescriptor();
- }
- return propertyValuesByDescriptor.containsKey(descriptor);
+ @Override
+ public final List<PropertyDescriptor<?>> getOverriddenPropertyDescriptors() {
+ return new ArrayList<>(propertyValuesByDescriptor.keySet());
}
@Override
public List<PropertyDescriptor<?>> getPropertyDescriptors() {
- return propertyDescriptors;
+ return Collections.unmodifiableList(propertyDescriptors);
}
@@ -120,12 +146,17 @@ public <T> T getProperty(PropertyDescriptor<T> propertyDescriptor) {
}
+ @Override
+ public boolean isPropertyOverridden(PropertyDescriptor<?> propertyDescriptor) {
+ return propertyValuesByDescriptor.containsKey(propertyDescriptor);
+ }
+
+
@Override
public <T> void setProperty(PropertyDescriptor<T> propertyDescriptor, T value) {
checkValidPropertyDescriptor(propertyDescriptor);
if (value instanceof List) {
propertyValuesByDescriptor.put(propertyDescriptor, Collections.unmodifiableList((List) value));
-
} else {
propertyValuesByDescriptor.put(propertyDescriptor, value);
}
@@ -145,13 +176,18 @@ public <V> void setProperty(MultiValuePropertyDescriptor<V> propertyDescriptor,
* @param propertyDescriptor The property descriptor to check
*/
private void checkValidPropertyDescriptor(PropertyDescriptor<?> propertyDescriptor) {
- if (!propertyDescriptors.contains(propertyDescriptor)) {
- throw new IllegalArgumentException(
- "Property descriptor not defined for Rule " + getName() + ": " + propertyDescriptor);
+ if (!hasDescriptor(propertyDescriptor)) {
+ throw new IllegalArgumentException("Property descriptor not defined for " + getPropertySourceType() + " " + getName() + ": " + propertyDescriptor);
}
}
+ @Override
+ public final Map<PropertyDescriptor<?>, Object> getOverriddenPropertiesByPropertyDescriptor() {
+ return new HashMap<>(propertyValuesByDescriptor);
+ }
+
+
@Override
public Map<PropertyDescriptor<?>, Object> getPropertiesByPropertyDescriptor() {
if (propertyDescriptors.isEmpty()) {
@@ -169,11 +205,12 @@ public Map<PropertyDescriptor<?>, Object> getPropertiesByPropertyDescriptor() {
}
}
- return propertiesByPropertyDescriptor;
+ return Collections.unmodifiableMap(propertiesByPropertyDescriptor);
}
@Override
+ @Deprecated
public boolean usesDefaultValues() {
Map<PropertyDescriptor<?>, Object> valuesByProperty = getPropertiesByPropertyDescriptor();
@@ -192,11 +229,13 @@ public boolean usesDefaultValues() {
@Override
+ @Deprecated
public void useDefaultValueFor(PropertyDescriptor<?> desc) {
propertyValuesByDescriptor.remove(desc);
}
+ // todo Java 8 move up to interface
@Override
public String dysfunctionReason() {
return null;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractSingleValueProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractSingleValueProperty.java
index 40effa179c1..0864cbaf171 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractSingleValueProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/AbstractSingleValueProperty.java
@@ -6,6 +6,7 @@
import net.sourceforge.pmd.Rule;
+
/**
* Single value property.
*
@@ -14,7 +15,7 @@
* @author Clément Fournier
*/
/* default */ abstract class AbstractSingleValueProperty<T> extends AbstractProperty<T>
- implements SingleValuePropertyDescriptor<T> {
+ implements SingleValuePropertyDescriptor<T> {
/** Default value. */
private T defaultValue;
@@ -23,10 +24,11 @@
/**
* Creates a single value property.
*
- * @param theName Name of the property
- * @param theDescription Description
- * @param theUIOrder UI order
- * @param theDefault Default value
+ * @param theName Name of the property
+ * @param theDescription Description
+ * @param theUIOrder UI order
+ * @param theDefault Default value
+ * @param isDefinedExternally Whether the property is defined in the XML (by a XPath rule) or not
*
* @throws IllegalArgumentException If name or description are empty, or UI order is negative.
*/
@@ -85,12 +87,10 @@ public String errorFor(T value) {
}
- private String typeErrorFor(T value) { // TODO:cf consider subtypes?
-
+ private String typeErrorFor(T value) {
if (value != null && !type().isAssignableFrom(value.getClass())) {
return value + " is not an instance of " + type();
}
-
return null;
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/BooleanMultiProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/BooleanMultiProperty.java
index a7f3fc69a82..bb13cac5759 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/BooleanMultiProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/BooleanMultiProperty.java
@@ -8,7 +8,10 @@
import java.util.Arrays;
import java.util.List;
-import java.util.Map;
+
+import net.sourceforge.pmd.properties.builders.MultiValuePropertyBuilder;
+import net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper;
+
/**
* Defines a property type that supports multiple Boolean values.
@@ -17,20 +20,6 @@
*/
public final class BooleanMultiProperty extends AbstractMultiValueProperty<Boolean> {
- /** Factory. */
- public static final PropertyDescriptorFactory<List<Boolean>> FACTORY // @formatter:off
- = new MultiValuePropertyDescriptorFactory<Boolean>(Boolean.class) {
- @Override
- public BooleanMultiProperty createWith(Map<PropertyDescriptorField, String> valuesById, boolean isDefinedExternally) {
- char delimiter = delimiterIn(valuesById);
- return new BooleanMultiProperty(nameIn(valuesById),
- descriptionIn(valuesById),
- ValueParserConstants.parsePrimitives(defaultValueIn(valuesById), delimiter, BOOLEAN_PARSER),
- 0f,
- isDefinedExternally);
- }
- }; // @formatter:on
-
/**
* Constructor using an array of defaults.
@@ -76,4 +65,32 @@ public Class<Boolean> type() {
return Boolean.class;
}
+
+ static PropertyDescriptorBuilderConversionWrapper.MultiValue<Boolean, BooleanMultiPBuilder> extractor() {
+ return new PropertyDescriptorBuilderConversionWrapper.MultiValue<Boolean, BooleanMultiPBuilder>(Boolean.class, ValueParserConstants.BOOLEAN_PARSER) {
+ @Override
+ protected BooleanMultiPBuilder newBuilder(String name) {
+ return new BooleanMultiPBuilder(name);
+ }
+ };
+ }
+
+
+ public static BooleanMultiPBuilder named(String name) {
+ return new BooleanMultiPBuilder(name);
+ }
+
+
+ public static final class BooleanMultiPBuilder extends MultiValuePropertyBuilder<Boolean, BooleanMultiPBuilder> {
+ private BooleanMultiPBuilder(String name) {
+ super(name);
+ }
+
+
+ @Override
+ public BooleanMultiProperty build() {
+ return new BooleanMultiProperty(this.name, this.description, this.defaultValues, this.uiOrder, isDefinedInXML);
+ }
+ }
+
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/BooleanProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/BooleanProperty.java
index 78876146fb5..acac8d414a6 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/BooleanProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/BooleanProperty.java
@@ -6,7 +6,9 @@
import static net.sourceforge.pmd.properties.ValueParserConstants.BOOLEAN_PARSER;
-import java.util.Map;
+import net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper;
+import net.sourceforge.pmd.properties.builders.SingleValuePropertyBuilder;
+
/**
* Defines a property type that supports single Boolean values.
@@ -16,23 +18,8 @@
*/
public final class BooleanProperty extends AbstractSingleValueProperty<Boolean> {
- /** Factory. */
- public static final PropertyDescriptorFactory<Boolean> FACTORY // @formatter:off
- = new SingleValuePropertyDescriptorFactory<Boolean>(Boolean.class) {
- @Override
- public BooleanProperty createWith(Map<PropertyDescriptorField, String> valuesById, boolean isDefinedExternally) {
- return new BooleanProperty(nameIn(valuesById),
- descriptionIn(valuesById),
- BOOLEAN_PARSER.valueOf(defaultValueIn(valuesById)),
- 0f,
- isDefinedExternally);
- }
- }; // @formatter:on
-
-
/**
- * Constructor for BooleanProperty limited to a single value. Converts
- * default argument string into a boolean.
+ * Constructor for BooleanProperty limited to a single value. Converts default argument string into a boolean.
*
* @param theName Name
* @param theDescription Description
@@ -75,4 +62,33 @@ public Class<Boolean> type() {
public Boolean createFrom(String propertyString) throws IllegalArgumentException {
return BOOLEAN_PARSER.valueOf(propertyString);
}
+
+
+ static PropertyDescriptorBuilderConversionWrapper.SingleValue<Boolean, BooleanPBuilder> extractor() {
+ return new PropertyDescriptorBuilderConversionWrapper.SingleValue<Boolean, BooleanPBuilder>(Boolean.class, ValueParserConstants.BOOLEAN_PARSER) {
+ @Override
+ protected BooleanPBuilder newBuilder(String name) {
+ return new BooleanPBuilder(name);
+ }
+ };
+ }
+
+
+ public static BooleanPBuilder named(String name) {
+ return new BooleanPBuilder(name);
+ }
+
+
+ public static final class BooleanPBuilder extends SingleValuePropertyBuilder<Boolean, BooleanPBuilder> {
+ private BooleanPBuilder(String name) {
+ super(name);
+ }
+
+
+ @Override
+ public BooleanProperty build() {
+ return new BooleanProperty(this.name, this.description, this.defaultValue, this.uiOrder, this.isDefinedInXML);
+ }
+ }
+
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/CharacterMultiProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/CharacterMultiProperty.java
index 1eb0e2c252d..e94c3840e84 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/CharacterMultiProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/CharacterMultiProperty.java
@@ -7,10 +7,13 @@
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
-import java.util.Map;
import org.apache.commons.lang3.StringUtils;
+import net.sourceforge.pmd.properties.builders.MultiValuePropertyBuilder;
+import net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper;
+
+
/**
* Multi-valued character property.
*
@@ -19,27 +22,6 @@
*/
public final class CharacterMultiProperty extends AbstractMultiValueProperty<Character> {
- /** Factory. */
- public static final PropertyDescriptorFactory<List<Character>> FACTORY // @formatter:off
- = new MultiValuePropertyDescriptorFactory<Character>(Character.class) {
-
- @Override
- protected boolean isValueMissing(String value) {
- return StringUtils.isEmpty(value);
- }
-
- @Override
- public CharacterMultiProperty createWith(Map<PropertyDescriptorField, String> valuesById, boolean isDefinedExternally) {
- char delimiter = delimiterIn(valuesById);
- return new CharacterMultiProperty(nameIn(valuesById),
- descriptionIn(valuesById),
- ValueParserConstants.parsePrimitives(defaultValueIn(valuesById), delimiter, ValueParserConstants.CHARACTER_PARSER),
- 0.0f,
- delimiter,
- isDefinedExternally);
- }
- }; // @formatter:on
-
/**
* Constructor using an array of defaults.
@@ -111,4 +93,33 @@ public List<Character> valueFrom(String valueString) throws IllegalArgumentExcep
return chars;
}
+
+ static PropertyDescriptorBuilderConversionWrapper.MultiValue<Character, CharacterMultiPBuilder> extractor() {
+ return new PropertyDescriptorBuilderConversionWrapper.MultiValue<Character, CharacterMultiPBuilder>(Character.class, ValueParserConstants.CHARACTER_PARSER) {
+ @Override
+ protected CharacterMultiPBuilder newBuilder(String name) {
+ return new CharacterMultiPBuilder(name);
+ }
+ };
+ }
+
+
+ public static CharacterMultiPBuilder named(String name) {
+ return new CharacterMultiPBuilder(name);
+ }
+
+
+ public static final class CharacterMultiPBuilder extends MultiValuePropertyBuilder<Character, CharacterMultiPBuilder> {
+ private CharacterMultiPBuilder(String name) {
+ super(name);
+ }
+
+
+ @Override
+ public CharacterMultiProperty build() {
+ return new CharacterMultiProperty(this.name, this.description, this.defaultValues, this.uiOrder, multiValueDelimiter, isDefinedInXML);
+ }
+ }
+
+
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/CharacterProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/CharacterProperty.java
index d91b65a3ce5..ba90f2b3f34 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/CharacterProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/CharacterProperty.java
@@ -6,9 +6,9 @@
import static net.sourceforge.pmd.properties.ValueParserConstants.CHARACTER_PARSER;
-import java.util.Map;
+import net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper;
+import net.sourceforge.pmd.properties.builders.SingleValuePropertyBuilder;
-import org.apache.commons.lang3.StringUtils;
/**
* Defines a property type that supports single Character values.
@@ -18,26 +18,6 @@
*/
public final class CharacterProperty extends AbstractSingleValueProperty<Character> {
- public static final PropertyDescriptorFactory<Character> FACTORY // @formatter:off
- = new SingleValuePropertyDescriptorFactory<Character>(Character.class) {
-
- @Override
- protected boolean isValueMissing(String value) {
- return StringUtils.isEmpty(value);
- }
-
- @Override
- public CharacterProperty createWith(Map<PropertyDescriptorField, String> valuesById, boolean isDefinedExternally) {
- return new CharacterProperty(nameIn(valuesById),
- descriptionIn(valuesById),
- defaultValueIn(valuesById) == null ? null
- : defaultValueIn(valuesById).charAt(0),
- 0f,
- isDefinedExternally);
- }
- }; // @formatter:on
-
-
/**
* Constructor for CharacterProperty.
*
@@ -60,20 +40,6 @@ private CharacterProperty(String theName, String theDescription, Character theDe
}
- /**
- * Parses a String into a Character.
- *
- * @param charStr String to parse
- *
- * @return Parsed Character
- *
- * @throws IllegalArgumentException if the String doesn't have length 1
- */
- public static Character charFrom(String charStr) {
- return CHARACTER_PARSER.valueOf(charStr);
- }
-
-
/**
* Constructor.
*
@@ -98,4 +64,45 @@ public Character createFrom(String valueString) throws IllegalArgumentException
return charFrom(valueString);
}
+
+ /**
+ * Parses a String into a Character.
+ *
+ * @param charStr String to parse
+ *
+ * @return Parsed Character
+ * @throws IllegalArgumentException if the String doesn't have length 1
+ */
+ public static Character charFrom(String charStr) {
+ return CHARACTER_PARSER.valueOf(charStr);
+ }
+
+
+ static PropertyDescriptorBuilderConversionWrapper.SingleValue<Character, CharacterPBuilder> extractor() {
+ return new PropertyDescriptorBuilderConversionWrapper.SingleValue<Character, CharacterPBuilder>(Character.class, ValueParserConstants.CHARACTER_PARSER) {
+ @Override
+ protected CharacterPBuilder newBuilder(String name) {
+ return new CharacterPBuilder(name);
+ }
+ };
+ }
+
+
+ public static CharacterPBuilder named(String name) {
+ return new CharacterPBuilder(name);
+ }
+
+
+ public static final class CharacterPBuilder extends SingleValuePropertyBuilder<Character, CharacterPBuilder> {
+ private CharacterPBuilder(String name) {
+ super(name);
+ }
+
+
+ @Override
+ public CharacterProperty build() {
+ return new CharacterProperty(this.name, this.description, this.defaultValue, this.uiOrder, isDefinedInXML);
+ }
+ }
+
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/DoubleMultiProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/DoubleMultiProperty.java
index dd48d54cb1b..5bfabaf259f 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/DoubleMultiProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/DoubleMultiProperty.java
@@ -4,11 +4,12 @@
package net.sourceforge.pmd.properties;
-import static net.sourceforge.pmd.properties.ValueParserConstants.DOUBLE_PARSER;
-
import java.util.Arrays;
import java.util.List;
-import java.util.Map;
+
+import net.sourceforge.pmd.properties.builders.MultiNumericPropertyBuilder;
+import net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper;
+
/**
* Multi-valued double property.
@@ -18,27 +19,6 @@
*/
public final class DoubleMultiProperty extends AbstractMultiNumericProperty<Double> {
- /** Factory. */
- public static final PropertyDescriptorFactory<List<Double>> FACTORY // @formatter:off
- = new MultiValuePropertyDescriptorFactory<Double>(Double.class, NUMBER_FIELD_TYPES_BY_KEY) {
- @Override
- public DoubleMultiProperty createWith(Map<PropertyDescriptorField, String> valuesById, boolean isDefinedExternally) {
- String[] minMax = minMaxFrom(valuesById);
- char delimiter = delimiterIn(valuesById, DEFAULT_NUMERIC_DELIMITER);
- List<Double> defaultValues
- = ValueParserConstants.parsePrimitives(defaultValueIn(valuesById), delimiter, DOUBLE_PARSER);
-
- return new DoubleMultiProperty(nameIn(valuesById),
- descriptionIn(valuesById),
- DOUBLE_PARSER.valueOf(minMax[0]),
- DOUBLE_PARSER.valueOf(minMax[1]),
- defaultValues,
- 0f,
- isDefinedExternally);
- }
- }; // @formatter:on
-
-
/**
* Constructor using an array of defaults.
*
@@ -49,7 +29,7 @@ public DoubleMultiProperty createWith(Map<PropertyDescriptorField, String> value
* @param defaultValues Array of defaults
* @param theUIOrder UI order
*
- * @throws IllegalArgumentException if min > max or one of the defaults is not between the bounds
+ * @throws IllegalArgumentException if {@literal min > max} or one of the defaults is not between the bounds
*/
public DoubleMultiProperty(String theName, String theDescription, Double min, Double max,
Double[] defaultValues, float theUIOrder) {
@@ -74,7 +54,7 @@ private DoubleMultiProperty(String theName, String theDescription, Double min, D
* @param defaultValues List of defaults
* @param theUIOrder UI order
*
- * @throws IllegalArgumentException if min > max or one of the defaults is not between the bounds
+ * @throws IllegalArgumentException if {@literal min > max} or one of the defaults is not between the bounds
*/
public DoubleMultiProperty(String theName, String theDescription, Double min, Double max,
List<Double> defaultValues, float theUIOrder) {
@@ -93,4 +73,32 @@ protected Double createFrom(String value) {
return Double.valueOf(value);
}
+
+ static PropertyDescriptorBuilderConversionWrapper.MultiValue.Numeric<Double, DoubleMultiPBuilder> extractor() {
+ return new PropertyDescriptorBuilderConversionWrapper.MultiValue.Numeric<Double, DoubleMultiPBuilder>(Double.class, ValueParserConstants.DOUBLE_PARSER) {
+ @Override
+ protected DoubleMultiPBuilder newBuilder(String name) {
+ return new DoubleMultiPBuilder(name);
+ }
+ };
+ }
+
+
+ public static DoubleMultiPBuilder named(String name) {
+ return new DoubleMultiPBuilder(name);
+ }
+
+
+ public static final class DoubleMultiPBuilder extends MultiNumericPropertyBuilder<Double, DoubleMultiPBuilder> {
+ private DoubleMultiPBuilder(String name) {
+ super(name);
+ }
+
+
+ @Override
+ public DoubleMultiProperty build() {
+ return new DoubleMultiProperty(name, description, lowerLimit, upperLimit, defaultValues, uiOrder, isDefinedInXML);
+ }
+ }
+
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/DoubleProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/DoubleProperty.java
index 5a0d374745f..ce635c43668 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/DoubleProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/DoubleProperty.java
@@ -6,34 +6,18 @@
import static net.sourceforge.pmd.properties.ValueParserConstants.DOUBLE_PARSER;
-import java.util.Map;
+import net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper;
+import net.sourceforge.pmd.properties.builders.SingleNumericPropertyBuilder;
+
/**
- * Defines a property type that support single double-type property values
- * within an upper and lower boundary.
+ * Defines a property type that support single double-type property values within an upper and lower boundary.
*
* @author Brian Remedios
* @version Refactored June 2017 (6.0.0)
*/
public final class DoubleProperty extends AbstractNumericProperty<Double> {
- /** Factory. */
- public static final PropertyDescriptorFactory<Double> FACTORY // @formatter:off
- = new SingleValuePropertyDescriptorFactory<Double>(Double.class, NUMBER_FIELD_TYPES_BY_KEY) {
- @Override
- public DoubleProperty createWith(Map<PropertyDescriptorField, String> valuesById,
- boolean isDefinedExternally) {
- final String[] minMax = minMaxFrom(valuesById);
- return new DoubleProperty(nameIn(valuesById),
- descriptionIn(valuesById),
- doubleFrom(minMax[0]),
- doubleFrom(minMax[1]),
- doubleFrom(defaultValueIn(valuesById)),
- 0f,
- isDefinedExternally);
- }
- }; // @formatter:on
-
/**
* Constructor for DoubleProperty that limits itself to a single value within the specified limits. Converts string
@@ -46,7 +30,7 @@ public DoubleProperty createWith(Map<PropertyDescriptorField, String> valuesById
* @param defaultStr Default value
* @param theUIOrder UI order
*
- * @throws IllegalArgumentException if min > max or one of the defaults is not between the bounds
+ * @throws IllegalArgumentException if {@literal min > max} or one of the defaults is not between the bounds
* @deprecated will be removed in 7.0.0
*/
public DoubleProperty(String theName, String theDescription, String minStr, String maxStr, String defaultStr,
@@ -62,18 +46,6 @@ private DoubleProperty(String theName, String theDescription, Double min, Double
}
- /**
- * Parses a String into a Double.
- *
- * @param numberString String to parse
- *
- * @return Parsed Double
- */
- private static Double doubleFrom(String numberString) {
- return DOUBLE_PARSER.valueOf(numberString);
- }
-
-
/**
* Constructor that limits itself to a single value within the specified limits.
*
@@ -84,7 +56,7 @@ private static Double doubleFrom(String numberString) {
* @param theDefault Default value
* @param theUIOrder UI order
*
- * @throws IllegalArgumentException if min > max or one of the defaults is not between the bounds
+ * @throws IllegalArgumentException if {@literal min > max} or one of the defaults is not between the bounds
*/
public DoubleProperty(String theName, String theDescription, Double min, Double max, Double theDefault,
float theUIOrder) {
@@ -102,4 +74,45 @@ public Class<Double> type() {
protected Double createFrom(String value) {
return doubleFrom(value);
}
+
+
+ /**
+ * Parses a String into a Double.
+ *
+ * @param numberString String to parse
+ *
+ * @return Parsed Double
+ */
+ private static Double doubleFrom(String numberString) {
+ return DOUBLE_PARSER.valueOf(numberString);
+ }
+
+
+ static PropertyDescriptorBuilderConversionWrapper.SingleValue.Numeric<Double, DoublePBuilder> extractor() {
+ return new PropertyDescriptorBuilderConversionWrapper.SingleValue.Numeric<Double, DoublePBuilder>(Double.class, ValueParserConstants.DOUBLE_PARSER) {
+ @Override
+ protected DoublePBuilder newBuilder(String name) {
+ return new DoublePBuilder(name);
+ }
+ };
+ }
+
+
+ public static DoublePBuilder named(String name) {
+ return new DoublePBuilder(name);
+ }
+
+
+ public static final class DoublePBuilder extends SingleNumericPropertyBuilder<Double, DoublePBuilder> {
+ private DoublePBuilder(String name) {
+ super(name);
+ }
+
+
+ @Override
+ public DoubleProperty build() {
+ return new DoubleProperty(name, description, lowerLimit, upperLimit, defaultValue, uiOrder, isDefinedInXML);
+ }
+ }
+
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/EnumeratedMultiProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/EnumeratedMultiProperty.java
index 06ea880080d..fd4ed5530b6 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/EnumeratedMultiProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/EnumeratedMultiProperty.java
@@ -8,9 +8,11 @@
import java.util.List;
import java.util.Map;
+import net.sourceforge.pmd.properties.builders.MultiValuePropertyBuilder;
import net.sourceforge.pmd.properties.modules.EnumeratedPropertyModule;
import net.sourceforge.pmd.util.CollectionUtil;
+
/**
* Multi-valued property which can take only a fixed set of values of any type, then selected via String labels. The
* mappings method returns the set of mappings between the labels and their values.
@@ -24,21 +26,6 @@
public final class EnumeratedMultiProperty<E> extends AbstractMultiValueProperty<E>
implements EnumeratedPropertyDescriptor<E, List<E>> {
- /** Factory. */
- public static final PropertyDescriptorFactory<List<Object>> FACTORY // @formatter:off
- = new MultiValuePropertyDescriptorFactory<Object>(Object.class) { // TODO:cf is Object the right type?
- @Override
- public EnumeratedMultiProperty createWith(Map<PropertyDescriptorField, String> valuesById, boolean isDefinedExternally) {
- Object[] choices = choicesIn(valuesById);
- return new EnumeratedMultiProperty<>(nameIn(valuesById),
- descriptionIn(valuesById),
- CollectionUtil.mapFrom(labelsIn(valuesById), choices),
- selection(indicesIn(valuesById), choices),
- classIn(valuesById),
- 0f,
- isDefinedExternally);
- }
- }; // @formatter:on
private final EnumeratedPropertyModule<E> module;
@@ -56,13 +43,13 @@ public EnumeratedMultiProperty createWith(Map<PropertyDescriptorField, String> v
* @param theUIOrder UI order
*
* @deprecated Use {@link #EnumeratedMultiProperty(String, String, Map, List, Class, float)}. Will be removed in
- * 7.0.0
+ * 7.0.0
*/
@Deprecated
public EnumeratedMultiProperty(String theName, String theDescription, String[] theLabels, E[] theChoices,
int[] choiceIndices, Class<E> valueType, float theUIOrder) {
this(theName, theDescription, CollectionUtil.mapFrom(theLabels, theChoices),
- selection(choiceIndices, theChoices), valueType, theUIOrder, false);
+ selection(choiceIndices, theChoices), valueType, theUIOrder, false);
}
@@ -78,13 +65,13 @@ public EnumeratedMultiProperty(String theName, String theDescription, String[] t
* @param theUIOrder UI order
*
* @deprecated Use {@link #EnumeratedMultiProperty(String, String, Map, List, Class, float)}. Will be removed in
- * 7.0.0
+ * 7.0.0
*/
@Deprecated
public EnumeratedMultiProperty(String theName, String theDescription, String[] theLabels, E[] theChoices,
int[] choiceIndices, float theUIOrder) {
this(theName, theDescription, CollectionUtil.mapFrom(theLabels, theChoices),
- selection(choiceIndices, theChoices), null, theUIOrder, false);
+ selection(choiceIndices, theChoices), null, theUIOrder, false);
}
@@ -168,4 +155,44 @@ private static <E> List<E> selection(int[] choiceIndices, E[] theChoices) {
return selected;
}
+
+ public static <E> EnumMultiPBuilder<E> named(String name) {
+ return new EnumMultiPBuilder<>(name);
+ }
+
+
+ public static final class EnumMultiPBuilder<E> extends MultiValuePropertyBuilder<E, EnumMultiPBuilder<E>> {
+
+ private Class<E> valueType;
+ private Map<String, E> mappings;
+
+
+ private EnumMultiPBuilder(String name) {
+ super(name);
+ }
+
+ public EnumMultiPBuilder<E> type(Class<E> type) {
+ this.valueType = type;
+ return this;
+ }
+
+ /**
+ * Sets the key-value mappings.
+ *
+ * @param map A map of label to value
+ *
+ * @return The same builder
+ */
+ public EnumMultiPBuilder<E> mappings(Map<String, E> map) {
+ this.mappings = map;
+ return this;
+ }
+
+
+ @Override
+ public EnumeratedMultiProperty<E> build() {
+ return new EnumeratedMultiProperty<>(this.name, this.description, mappings, this.defaultValues, valueType, this.uiOrder, isDefinedInXML);
+ }
+ }
+
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/EnumeratedProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/EnumeratedProperty.java
index ccaab99d773..d22cf554874 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/EnumeratedProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/EnumeratedProperty.java
@@ -4,17 +4,18 @@
package net.sourceforge.pmd.properties;
-import java.util.Enumeration;
import java.util.Map;
+import net.sourceforge.pmd.properties.builders.SingleValuePropertyBuilder;
import net.sourceforge.pmd.properties.modules.EnumeratedPropertyModule;
import net.sourceforge.pmd.util.CollectionUtil;
+
/**
* Property which can take only a fixed set of values of any type, then selected via String labels. The mappings method
* returns the set of mappings between the labels and their values.
*
- * <p>This property currently doesn't support serialization and cannot be defined in a ruleset file.z
+ * <p>This property currently doesn't support serialization and cannot be defined in a ruleset file.z </p>
*
* @param <E> Type of the values
*
@@ -23,26 +24,7 @@
* @version Refactored June 2017 (6.0.0)
*/
public final class EnumeratedProperty<E> extends AbstractSingleValueProperty<E>
- implements EnumeratedPropertyDescriptor<E, E> {
-
- /** Factory. */
- public static final PropertyDescriptorFactory<? extends Enumeration> FACTORY // @formatter:off
- = new SingleValuePropertyDescriptorFactory<Enumeration>(Enumeration.class) { // TODO:cf Enumeration? Object?
-
- @Override
- public EnumeratedProperty createWith(Map<PropertyDescriptorField, String> valuesById, boolean isDefinedExternally) {
- Map<String, Object> labelsToChoices = CollectionUtil.mapFrom(labelsIn(valuesById), // this is not implemented
- choicesIn(valuesById)); // ditto
- return new EnumeratedProperty<>(nameIn(valuesById),
- descriptionIn(valuesById),
- labelsToChoices,
- choicesIn(valuesById)[indexIn(valuesById)],
- classIn(valuesById),
- 0f,
- isDefinedExternally);
- }
- }; // @formatter:on
-
+ implements EnumeratedPropertyDescriptor<E, E> {
private final EnumeratedPropertyModule<E> module;
@@ -65,7 +47,7 @@ public EnumeratedProperty createWith(Map<PropertyDescriptorField, String> values
public EnumeratedProperty(String theName, String theDescription, String[] theLabels, E[] theChoices,
int defaultIndex, Class<E> valueType, float theUIOrder) {
this(theName, theDescription, CollectionUtil.mapFrom(theLabels, theChoices),
- theChoices[defaultIndex], valueType, theUIOrder, false);
+ theChoices[defaultIndex], valueType, theUIOrder, false);
}
@@ -86,7 +68,7 @@ public EnumeratedProperty(String theName, String theDescription, String[] theLab
public EnumeratedProperty(String theName, String theDescription, String[] theLabels, E[] theChoices,
int defaultIndex, float theUIOrder) {
this(theName, theDescription, CollectionUtil.mapFrom(theLabels, theChoices),
- theChoices[defaultIndex], null, theUIOrder, false);
+ theChoices[defaultIndex], null, theUIOrder, false);
}
@@ -146,4 +128,34 @@ public Map<String, E> mappings() {
}
+ public static <E> EnumPBuilder<E> named(String name) {
+ return new EnumPBuilder<>(name);
+ }
+
+ public static final class EnumPBuilder<E> extends SingleValuePropertyBuilder<E, EnumPBuilder<E>> {
+
+ private Class<E> valueType;
+ private Map<String, E> mappings;
+
+
+ private EnumPBuilder(String name) {
+ super(name);
+ }
+
+ public EnumPBuilder<E> type(Class<E> type) {
+ this.valueType = type;
+ return this;
+ }
+
+ public EnumPBuilder<E> mappings(Map<String, E> map) {
+ this.mappings = map;
+ return this;
+ }
+
+
+ @Override
+ public EnumeratedProperty<E> build() {
+ return new EnumeratedProperty<>(this.name, this.description, mappings, this.defaultValue, valueType, this.uiOrder, isDefinedInXML);
+ }
+ }
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/EnumeratedPropertyDescriptor.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/EnumeratedPropertyDescriptor.java
index 9a4b4a36bea..0736db2c4d8 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/EnumeratedPropertyDescriptor.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/EnumeratedPropertyDescriptor.java
@@ -6,6 +6,7 @@
import java.util.Map;
+
/**
* Interface defining an enumerated property descriptor.
*
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/ExpectedFieldsBuilder.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/ExpectedFieldsBuilder.java
deleted file mode 100644
index f5dac458c44..00000000000
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/ExpectedFieldsBuilder.java
+++ /dev/null
@@ -1,57 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.properties;
-
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.Map;
-
-/** Builder for an expected fields map. */
-public final class ExpectedFieldsBuilder {
-
- private final Map<PropertyDescriptorField, Boolean> requiredFields = new HashMap<>();
-
-
- private ExpectedFieldsBuilder() {
-
- }
-
-
- /**
- * Adds a mapping of field/ required to the map.
- *
- * @param field The field to expect
- * @param isRequired Whether it's required or not
- *
- * @return This instance, so that we have a fluent interface
- */
- public ExpectedFieldsBuilder put(PropertyDescriptorField field, boolean isRequired) {
- requiredFields.put(field, isRequired);
- return this;
- }
-
-
- /**
- * Gets an immutable map containing the fields we've put here.
- *
- * @return The map of field/ isRequired mappings
- */
- public Map<PropertyDescriptorField, Boolean> build() {
- return Collections.unmodifiableMap(requiredFields);
- }
-
-
- /**
- * Gets a builder for a required fields map.
- *
- * @return A builder
- *
- * @see ExpectedFieldsBuilder
- */
- public static ExpectedFieldsBuilder instance() {
- return new ExpectedFieldsBuilder();
- }
-
-}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/FileProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/FileProperty.java
index d8d7bc7611a..57209296258 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/FileProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/FileProperty.java
@@ -5,10 +5,13 @@
package net.sourceforge.pmd.properties;
import java.io.File;
-import java.util.Map;
import org.apache.commons.lang3.StringUtils;
+import net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper;
+import net.sourceforge.pmd.properties.builders.SinglePackagedPropertyBuilder;
+
+
/**
* Property taking a File object as its value.
*
@@ -17,19 +20,6 @@
*/
public final class FileProperty extends AbstractSingleValueProperty<File> {
- /** Factory. */
- public static final PropertyDescriptorFactory<File> FACTORY // @formatter:off
- = new SingleValuePropertyDescriptorFactory<File>(File.class) {
- @Override
- public FileProperty createWith(Map<PropertyDescriptorField, String> valuesById, boolean isDefinedExternally) {
- return new FileProperty(nameIn(valuesById),
- descriptionIn(valuesById),
- null,
- 0f,
- isDefinedExternally);
- }
- }; // @formatter:on
-
/**
* Constructor for file property.
@@ -60,4 +50,34 @@ public Class<File> type() {
public File createFrom(String propertyString) {
return StringUtils.isBlank(propertyString) ? null : new File(propertyString);
}
+
+
+ static PropertyDescriptorBuilderConversionWrapper.SingleValue<File, FilePBuilder> extractor() {
+ return new PropertyDescriptorBuilderConversionWrapper.SingleValue<File, FilePBuilder>(File.class, ValueParserConstants.FILE_PARSER) {
+ @Override
+ protected FilePBuilder newBuilder(String name) {
+ return new FilePBuilder(name);
+ }
+ };
+ }
+
+
+ public static FilePBuilder named(String name) {
+ return new FilePBuilder(name);
+ }
+
+
+ public static final class FilePBuilder extends SinglePackagedPropertyBuilder<File, FilePBuilder> {
+ private FilePBuilder(String name) {
+ super(name);
+ }
+
+
+ @Override
+ public FileProperty build() {
+ return new FileProperty(name, description, defaultValue, uiOrder, isDefinedInXML);
+ }
+ }
+
+
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/FloatMultiProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/FloatMultiProperty.java
index c5b60f3ecb2..4c06a0f107d 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/FloatMultiProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/FloatMultiProperty.java
@@ -4,11 +4,12 @@
package net.sourceforge.pmd.properties;
-import static net.sourceforge.pmd.properties.ValueParserConstants.FLOAT_PARSER;
-
import java.util.Arrays;
import java.util.List;
-import java.util.Map;
+
+import net.sourceforge.pmd.properties.builders.MultiNumericPropertyBuilder;
+import net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper;
+
/**
* Multi-valued float property.
@@ -18,25 +19,6 @@
*/
public final class FloatMultiProperty extends AbstractMultiNumericProperty<Float> {
- /** Factory. */
- public static final PropertyDescriptorFactory<List<Float>> FACTORY // @formatter:off
- = new MultiValuePropertyDescriptorFactory<Float>(Float.class, NUMBER_FIELD_TYPES_BY_KEY) {
- @Override
- public FloatMultiProperty createWith(Map<PropertyDescriptorField, String> valuesById,
- boolean isDefinedExternally) {
- String[] minMax = minMaxFrom(valuesById);
- char delimiter = delimiterIn(valuesById, DEFAULT_NUMERIC_DELIMITER);
- List<Float> defaultValues = ValueParserConstants.parsePrimitives(defaultValueIn(valuesById), delimiter, FLOAT_PARSER);
- return new FloatMultiProperty(nameIn(valuesById),
- descriptionIn(valuesById),
- FLOAT_PARSER.valueOf(minMax[0]),
- FLOAT_PARSER.valueOf(minMax[1]),
- defaultValues,
- 0f,
- isDefinedExternally);
- }
- }; // @formatter:on
-
/**
* Constructor using an array of defaults.
@@ -48,7 +30,7 @@ public FloatMultiProperty createWith(Map<PropertyDescriptorField, String> values
* @param defaultValues Array of defaults
* @param theUIOrder UI order
*
- * @throws IllegalArgumentException if min > max or one of the defaults is not between the bounds
+ * @throws IllegalArgumentException if {@literal min > max} or one of the defaults is not between the bounds
*/
public FloatMultiProperty(String theName, String theDescription, Float min, Float max,
Float[] defaultValues, float theUIOrder) {
@@ -73,7 +55,7 @@ private FloatMultiProperty(String theName, String theDescription, Float min, Flo
* @param defaultValues List of defaults
* @param theUIOrder UI order
*
- * @throws IllegalArgumentException if min > max or one of the defaults is not between the bounds
+ * @throws IllegalArgumentException if {@literal min > max} or one of the defaults is not between the bounds
*/
public FloatMultiProperty(String theName, String theDescription, Float min, Float max,
List<Float> defaultValues, float theUIOrder) {
@@ -91,4 +73,34 @@ public Class<Float> type() {
protected Float createFrom(String value) {
return Float.valueOf(value);
}
+
+
+ static PropertyDescriptorBuilderConversionWrapper.MultiValue.Numeric<Float, FloatMultiPBuilder> extractor() {
+ return new PropertyDescriptorBuilderConversionWrapper.MultiValue.Numeric<Float, FloatMultiPBuilder>(Float.class, ValueParserConstants.FLOAT_PARSER) {
+ @Override
+ protected FloatMultiPBuilder newBuilder(String name) {
+ return new FloatMultiPBuilder(name);
+ }
+ };
+ }
+
+
+ public static FloatMultiPBuilder named(String name) {
+ return new FloatMultiPBuilder(name);
+ }
+
+
+ public static final class FloatMultiPBuilder extends MultiNumericPropertyBuilder<Float, FloatMultiPBuilder> {
+ private FloatMultiPBuilder(String name) {
+ super(name);
+ }
+
+
+ @Override
+ public FloatMultiProperty build() {
+ return new FloatMultiProperty(name, description, lowerLimit, upperLimit, defaultValues, uiOrder, isDefinedInXML);
+ }
+ }
+
+
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/FloatProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/FloatProperty.java
index 17ecfa812c8..a3ce5de9a18 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/FloatProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/FloatProperty.java
@@ -6,32 +6,17 @@
import static net.sourceforge.pmd.properties.ValueParserConstants.FLOAT_PARSER;
-import java.util.Map;
+import net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper;
+import net.sourceforge.pmd.properties.builders.SingleNumericPropertyBuilder;
+
/**
- * Defines a property type that supports single float property values within an
- * upper and lower boundary.
+ * Defines a property type that supports single float property values within an upper and lower boundary.
*
* @author Brian Remedios
*/
public final class FloatProperty extends AbstractNumericProperty<Float> {
- /** Factory. */
- public static final PropertyDescriptorFactory<Float> FACTORY // @formatter:off
- = new SingleValuePropertyDescriptorFactory<Float>(Float.class, NUMBER_FIELD_TYPES_BY_KEY) {
- @Override
- public FloatProperty createWith(Map<PropertyDescriptorField, String> valuesById, boolean isDefinedExternally) {
- final String[] minMax = minMaxFrom(valuesById);
- return new FloatProperty(nameIn(valuesById),
- descriptionIn(valuesById),
- FLOAT_PARSER.valueOf(minMax[0]),
- FLOAT_PARSER.valueOf(minMax[1]),
- FLOAT_PARSER.valueOf(defaultValueIn(valuesById)),
- 0f,
- isDefinedExternally);
- }
- }; // @formatter:on
-
/**
* Constructor for FloatProperty that limits itself to a single value within the specified limits. Converts string
@@ -44,13 +29,13 @@ public FloatProperty createWith(Map<PropertyDescriptorField, String> valuesById,
* @param defaultStr Default value
* @param theUIOrder UI order
*
- * @throws IllegalArgumentException if min > max or one of the defaults is not between the bounds
+ * @throws IllegalArgumentException if {@literal min > max} or one of the defaults is not between the bounds
* @deprecated will be removed in 7.0.0
*/
public FloatProperty(String theName, String theDescription, String minStr, String maxStr, String defaultStr,
float theUIOrder) {
this(theName, theDescription, FLOAT_PARSER.valueOf(minStr),
- FLOAT_PARSER.valueOf(maxStr), FLOAT_PARSER.valueOf(defaultStr), theUIOrder, false);
+ FLOAT_PARSER.valueOf(maxStr), FLOAT_PARSER.valueOf(defaultStr), theUIOrder, false);
}
@@ -71,7 +56,7 @@ private FloatProperty(String theName, String theDescription, Float min, Float ma
* @param theDefault Default value
* @param theUIOrder UI order
*
- * @throws IllegalArgumentException if min > max or one of the defaults is not between the bounds
+ * @throws IllegalArgumentException if {@literal min > max} or one of the defaults is not between the bounds
*/
public FloatProperty(String theName, String theDescription, Float min, Float max, Float theDefault,
float theUIOrder) {
@@ -91,4 +76,32 @@ protected Float createFrom(String value) {
}
+ static PropertyDescriptorBuilderConversionWrapper.SingleValue.Numeric<Float, FloatPBuilder> extractor() {
+ return new PropertyDescriptorBuilderConversionWrapper.SingleValue.Numeric<Float, FloatPBuilder>(Float.class, ValueParserConstants.FLOAT_PARSER) {
+ @Override
+ protected FloatPBuilder newBuilder(String name) {
+ return new FloatPBuilder(name);
+ }
+ };
+ }
+
+
+ public static FloatPBuilder named(String name) {
+ return new FloatPBuilder(name);
+ }
+
+
+ public static final class FloatPBuilder extends SingleNumericPropertyBuilder<Float, FloatPBuilder> {
+ private FloatPBuilder(String name) {
+ super(name);
+ }
+
+
+ @Override
+ public FloatProperty build() {
+ return new FloatProperty(name, description, lowerLimit, upperLimit, defaultValue, uiOrder, isDefinedInXML);
+ }
+ }
+
+
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/IntegerMultiProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/IntegerMultiProperty.java
index 59e9ba298a0..3aa5781651f 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/IntegerMultiProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/IntegerMultiProperty.java
@@ -4,11 +4,12 @@
package net.sourceforge.pmd.properties;
-import static net.sourceforge.pmd.properties.ValueParserConstants.INTEGER_PARSER;
-
import java.util.Arrays;
import java.util.List;
-import java.util.Map;
+
+import net.sourceforge.pmd.properties.builders.MultiNumericPropertyBuilder;
+import net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper;
+
/**
* Multi-valued integer property.
@@ -18,25 +19,6 @@
*/
public final class IntegerMultiProperty extends AbstractMultiNumericProperty<Integer> {
- /** Factory. */
- public static final PropertyDescriptorFactory<List<Integer>> FACTORY // @formatter:off
- = new MultiValuePropertyDescriptorFactory<Integer>(Integer.class, NUMBER_FIELD_TYPES_BY_KEY) {
- @Override
- public IntegerMultiProperty createWith(Map<PropertyDescriptorField, String> valuesById, boolean
- isDefinedExternally) {
- String[] minMax = minMaxFrom(valuesById);
- char delimiter = delimiterIn(valuesById, DEFAULT_NUMERIC_DELIMITER);
- List<Integer> defaultValues = ValueParserConstants.parsePrimitives(defaultValueIn(valuesById), delimiter, INTEGER_PARSER);
- return new IntegerMultiProperty(nameIn(valuesById),
- descriptionIn(valuesById),
- INTEGER_PARSER.valueOf(minMax[0]),
- INTEGER_PARSER.valueOf(minMax[1]),
- defaultValues,
- 0f,
- isDefinedExternally);
- }
- }; // @formatter:on
-
/**
* Constructor using an array of defaults.
@@ -48,7 +30,7 @@ public IntegerMultiProperty createWith(Map<PropertyDescriptorField, String> valu
* @param defaultValues Array of defaults
* @param theUIOrder UI order
*
- * @throws IllegalArgumentException if min > max or one of the defaults is not between the bounds
+ * @throws IllegalArgumentException if {@literal min > max} or one of the defaults is not between the bounds
*/
public IntegerMultiProperty(String theName, String theDescription, Integer min, Integer max,
Integer[] defaultValues, float theUIOrder) {
@@ -74,7 +56,7 @@ private IntegerMultiProperty(String theName, String theDescription, Integer min,
* @param defaultValues List of defaults
* @param theUIOrder UI order
*
- * @throws IllegalArgumentException if min > max or one of the defaults is not between the bounds
+ * @throws IllegalArgumentException if {@literal min > max} or one of the defaults is not between the bounds
*/
public IntegerMultiProperty(String theName, String theDescription, Integer min, Integer max,
List<Integer> defaultValues, float theUIOrder) {
@@ -93,4 +75,32 @@ public Class<Integer> type() {
protected Integer createFrom(String toParse) {
return Integer.valueOf(toParse);
}
+
+
+ static PropertyDescriptorBuilderConversionWrapper.MultiValue.Numeric<Integer, IntegerMultiPBuilder> extractor() {
+ return new PropertyDescriptorBuilderConversionWrapper.MultiValue.Numeric<Integer, IntegerMultiPBuilder>(Integer.class, ValueParserConstants.INTEGER_PARSER) {
+ @Override
+ protected IntegerMultiPBuilder newBuilder(String name) {
+ return new IntegerMultiPBuilder(name);
+ }
+ };
+ }
+
+
+ public static IntegerMultiPBuilder named(String name) {
+ return new IntegerMultiPBuilder(name);
+ }
+
+
+ public static final class IntegerMultiPBuilder extends MultiNumericPropertyBuilder<Integer, IntegerMultiPBuilder> {
+ private IntegerMultiPBuilder(String name) {
+ super(name);
+ }
+
+
+ @Override
+ public IntegerMultiProperty build() {
+ return new IntegerMultiProperty(name, description, lowerLimit, upperLimit, defaultValues, uiOrder, isDefinedInXML);
+ }
+ }
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/IntegerProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/IntegerProperty.java
index bc03221c334..6508fa3fbe8 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/IntegerProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/IntegerProperty.java
@@ -6,33 +6,17 @@
import static net.sourceforge.pmd.properties.ValueParserConstants.INTEGER_PARSER;
-import java.util.Map;
+import net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper;
+import net.sourceforge.pmd.properties.builders.SingleNumericPropertyBuilder;
+
/**
- * Defines a datatype that supports single Integer property values within an
- * upper and lower boundary.
+ * Defines a datatype that supports single Integer property values within an upper and lower boundary.
*
* @author Brian Remedios
*/
public final class IntegerProperty extends AbstractNumericProperty<Integer> {
- /** Factory. */
- public static final PropertyDescriptorFactory<Integer> FACTORY // @formatter:off
- = new SingleValuePropertyDescriptorFactory<Integer>(Integer.class, NUMBER_FIELD_TYPES_BY_KEY) {
-
- @Override
- public IntegerProperty createWith(Map<PropertyDescriptorField, String> valuesById, boolean isDefinedExternally) {
- final String[] minMax = minMaxFrom(valuesById);
- return new IntegerProperty(nameIn(valuesById),
- descriptionIn(valuesById),
- INTEGER_PARSER.valueOf(minMax[0]),
- INTEGER_PARSER.valueOf(minMax[1]),
- INTEGER_PARSER.valueOf(defaultValueIn(valuesById)),
- 0f,
- isDefinedExternally);
- }
- }; // @formatter:on
-
/**
* Constructor that limits itself to a single value within the specified limits.
@@ -44,7 +28,7 @@ public IntegerProperty createWith(Map<PropertyDescriptorField, String> valuesByI
* @param theDefault Default value
* @param theUIOrder UI order
*
- * @throws IllegalArgumentException if min > max or one of the defaults is not between the bounds
+ * @throws IllegalArgumentException if {@literal min > max} or one of the defaults is not between the bounds
*/
public IntegerProperty(String theName, String theDescription, Integer min, Integer max, Integer theDefault,
float theUIOrder) {
@@ -71,4 +55,31 @@ protected Integer createFrom(String value) {
}
+ static PropertyDescriptorBuilderConversionWrapper.SingleValue.Numeric<Integer, IntegerPBuilder> extractor() {
+ return new PropertyDescriptorBuilderConversionWrapper.SingleValue.Numeric<Integer, IntegerPBuilder>(Integer.class, ValueParserConstants.INTEGER_PARSER) {
+ @Override
+ protected IntegerPBuilder newBuilder(String name) {
+ return new IntegerPBuilder(name);
+ }
+ };
+ }
+
+
+ public static IntegerPBuilder named(String name) {
+ return new IntegerPBuilder(name);
+ }
+
+
+ public static final class IntegerPBuilder extends SingleNumericPropertyBuilder<Integer, IntegerPBuilder> {
+ private IntegerPBuilder(String name) {
+ super(name);
+ }
+
+
+ @Override
+ public IntegerProperty build() {
+ return new IntegerProperty(name, description, lowerLimit, upperLimit, defaultValue, uiOrder, isDefinedInXML);
+ }
+ }
+
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/LongMultiProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/LongMultiProperty.java
index cbc49746006..eb07bf17bcd 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/LongMultiProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/LongMultiProperty.java
@@ -4,11 +4,12 @@
package net.sourceforge.pmd.properties;
-import static net.sourceforge.pmd.properties.ValueParserConstants.LONG_PARSER;
-
import java.util.Arrays;
import java.util.List;
-import java.util.Map;
+
+import net.sourceforge.pmd.properties.builders.MultiNumericPropertyBuilder;
+import net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper;
+
/**
* Multi-valued long property.
@@ -18,24 +19,6 @@
*/
public final class LongMultiProperty extends AbstractMultiNumericProperty<Long> {
- /** Factory. */
- public static final PropertyDescriptorFactory<List<Long>> FACTORY // @formatter:off
- = new MultiValuePropertyDescriptorFactory<Long>(Long.class, NUMBER_FIELD_TYPES_BY_KEY) {
- @Override
- public LongMultiProperty createWith(Map<PropertyDescriptorField, String> valuesById, boolean isDefinedExternally) {
- String[] minMax = minMaxFrom(valuesById);
- char delimiter = delimiterIn(valuesById, DEFAULT_NUMERIC_DELIMITER);
- List<Long> defaultValues = ValueParserConstants.parsePrimitives(defaultValueIn(valuesById), delimiter, LONG_PARSER);
- return new LongMultiProperty(nameIn(valuesById),
- descriptionIn(valuesById),
- LONG_PARSER.valueOf(minMax[0]),
- LONG_PARSER.valueOf(minMax[1]),
- defaultValues,
- 0f,
- isDefinedExternally);
- }
- }; // @formatter:on
-
/**
* Constructor using an array of defaults.
@@ -47,7 +30,7 @@ public LongMultiProperty createWith(Map<PropertyDescriptorField, String> valuesB
* @param defaultValues Array of defaults
* @param theUIOrder UI order
*
- * @throws IllegalArgumentException if min > max or one of the defaults is not between the bounds
+ * @throws IllegalArgumentException if {@literal min > max} or one of the defaults is not between the bounds
*/
public LongMultiProperty(String theName, String theDescription, Long min, Long max,
Long[] defaultValues, float theUIOrder) {
@@ -72,7 +55,7 @@ private LongMultiProperty(String theName, String theDescription, Long min, Long
* @param defaultValues List of defaults
* @param theUIOrder UI order
*
- * @throws IllegalArgumentException if min > max or one of the defaults is not between the bounds
+ * @throws IllegalArgumentException if {@literal min > max} or one of the defaults is not between the bounds
*/
public LongMultiProperty(String theName, String theDescription, Long min, Long max,
List<Long> defaultValues, float theUIOrder) {
@@ -91,4 +74,36 @@ protected Long createFrom(String value) {
return Long.valueOf(value);
}
+
+ static PropertyDescriptorBuilderConversionWrapper.MultiValue.Numeric<Long, LongMultiPBuilder> extractor() {
+ return new PropertyDescriptorBuilderConversionWrapper.MultiValue.Numeric<Long, LongMultiPBuilder>(Long.class, ValueParserConstants.LONG_PARSER) {
+ @Override
+ protected LongMultiPBuilder newBuilder(String name) {
+ return new LongMultiPBuilder(name);
+ }
+ };
+ }
+
+
+ public static LongMultiPBuilder named(String name) {
+ return new LongMultiPBuilder(name);
+ }
+
+
+ public static final class LongMultiPBuilder
+ extends MultiNumericPropertyBuilder<Long, LongMultiPBuilder> {
+
+ protected LongMultiPBuilder(String name) {
+ super(name);
+ }
+
+
+ @Override
+ public LongMultiProperty build() {
+ return new LongMultiProperty(name, description, lowerLimit, upperLimit,
+ defaultValues, uiOrder, isDefinedInXML);
+ }
+ }
+
+
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/LongProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/LongProperty.java
index 144123953e4..020dc50f3e3 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/LongProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/LongProperty.java
@@ -4,35 +4,19 @@
package net.sourceforge.pmd.properties;
-import static net.sourceforge.pmd.properties.ValueParserConstants.LONG_PARSER;
+import net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper;
+import net.sourceforge.pmd.properties.builders.SingleNumericPropertyBuilder;
-import java.util.Map;
/**
* Single valued long property.
*
* @author Brian Remedios
+ * @author Clément Fournier
* @version Refactored June 2017 (6.0.0)
*/
public final class LongProperty extends AbstractNumericProperty<Long> {
- /** Factory. */
- public static final PropertyDescriptorFactory<Long> FACTORY // @formatter:off
- = new SingleValuePropertyDescriptorFactory<Long>(Long.class, NUMBER_FIELD_TYPES_BY_KEY) {
- @Override
- public LongProperty createWith(Map<PropertyDescriptorField, String> valuesById, boolean isDefinedExternally) {
- final String[] minMax = minMaxFrom(valuesById);
- return new LongProperty(nameIn(valuesById),
- descriptionIn(valuesById),
- LONG_PARSER.valueOf(minMax[0]),
- LONG_PARSER.valueOf(minMax[1]),
- LONG_PARSER.valueOf(defaultValueIn(valuesById)),
- 0f,
- isDefinedExternally);
- }
- };
- // @formatter:on
-
/**
* Constructor for LongProperty that limits itself to a single value within the specified limits. Converts string
@@ -45,13 +29,13 @@ public LongProperty createWith(Map<PropertyDescriptorField, String> valuesById,
* @param defaultStr Default value
* @param theUIOrder UI order
*
- * @throws IllegalArgumentException if min > max or one of the defaults is not between the bounds
+ * @throws IllegalArgumentException if {@literal min > max} or one of the defaults is not between the bounds
* @deprecated will be removed in 7.0.0
*/
public LongProperty(String theName, String theDescription, String minStr, String maxStr, String defaultStr,
float theUIOrder) {
this(theName, theDescription, Long.valueOf(minStr), Long.valueOf(maxStr),
- Long.valueOf(defaultStr), theUIOrder, false);
+ Long.valueOf(defaultStr), theUIOrder, false);
}
@@ -72,7 +56,7 @@ private LongProperty(String theName, String theDescription, Long min, Long max,
* @param theDefault Default value
* @param theUIOrder UI order
*
- * @throws IllegalArgumentException if min > max or one of the defaults is not between the bounds
+ * @throws IllegalArgumentException if {@literal min > max} or one of the defaults is not between the bounds
*/
public LongProperty(String theName, String theDescription, Long min, Long max, Long theDefault, float theUIOrder) {
this(theName, theDescription, min, max, theDefault, theUIOrder, false);
@@ -90,4 +74,32 @@ protected Long createFrom(String toParse) {
return Long.valueOf(toParse);
}
+
+ static PropertyDescriptorBuilderConversionWrapper.SingleValue.Numeric<Long, LongPBuilder> extractor() {
+ return new PropertyDescriptorBuilderConversionWrapper.SingleValue.Numeric<Long, LongPBuilder>(Long.class, ValueParserConstants.LONG_PARSER) {
+ @Override
+ protected LongPBuilder newBuilder(String name) {
+ return new LongPBuilder(name);
+ }
+ };
+ }
+
+
+ public static LongPBuilder named(String name) {
+ return new LongPBuilder(name);
+ }
+
+
+ public static final class LongPBuilder extends SingleNumericPropertyBuilder<Long, LongPBuilder> {
+ private LongPBuilder(String name) {
+ super(name);
+ }
+
+
+ @Override
+ public LongProperty build() {
+ return new LongProperty(name, description, lowerLimit, upperLimit, defaultValue, uiOrder, isDefinedInXML);
+ }
+ }
+
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/MethodMultiProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/MethodMultiProperty.java
index 68c11a59364..bac24a7efbe 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/MethodMultiProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/MethodMultiProperty.java
@@ -9,39 +9,23 @@
import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.List;
-import java.util.Map;
+import net.sourceforge.pmd.properties.builders.MultiPackagedPropertyBuilder;
+import net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper;
import net.sourceforge.pmd.properties.modules.MethodPropertyModule;
+
/**
- * Defines a property type that can specify multiple methods to use as part of a
- * rule.
+ * Defines a property type that can specify multiple methods to use as part of a rule.
*
- * Rule developers can limit the rules to those within designated packages per
- * the 'legalPackages' argument in the constructor which can be an array of
- * partial package names, i.e., ["java.lang", "com.mycompany" ].
+ * Rule developers can limit the rules to those within designated packages per the 'legalPackages' argument in the
+ * constructor which can be an array of partial package names, i.e., ["java.lang", "com.mycompany" ].
*
* @author Brian Remedios
* @version Refactored June 2017 (6.0.0)
*/
public final class MethodMultiProperty extends AbstractMultiPackagedProperty<Method> {
- /** Factory. */
- public static final PropertyDescriptorFactory<List<Method>> FACTORY // @formatter:off
- = new MultiValuePropertyDescriptorFactory<Method>(Method.class, PACKAGED_FIELD_TYPES_BY_KEY) {
- @Override
- public MethodMultiProperty createWith(Map<PropertyDescriptorField, String> valuesById, boolean isDefinedExternally) {
- char delimiter = delimiterIn(valuesById, MULTI_VALUE_DELIMITER);
- return new MethodMultiProperty(nameIn(valuesById),
- descriptionIn(valuesById),
- methodsFrom(defaultValueIn(valuesById)),
- legalPackageNamesIn(valuesById, delimiter),
- 0f,
- isDefinedExternally);
- }
-
- }; // @formatter:on
-
/**
* Constructor for MethodMultiProperty using an array of defaults.
@@ -79,7 +63,7 @@ public MethodMultiProperty(String theName, String theDescription, List<Method> t
private MethodMultiProperty(String theName, String theDescription, List<Method> theDefaults,
String[] legalPackageNames, float theUIOrder, boolean isDefinedExternally) {
super(theName, theDescription, theDefaults, theUIOrder, isDefinedExternally,
- new MethodPropertyModule(legalPackageNames, theDefaults));
+ new MethodPropertyModule(legalPackageNames, theDefaults));
}
@@ -98,14 +82,9 @@ private MethodMultiProperty(String theName, String theDescription, List<Method>
public MethodMultiProperty(String theName, String theDescription, String methodDefaults,
String[] legalPackageNames, float theUIOrder) {
this(theName, theDescription,
- methodsFrom(methodDefaults),
- legalPackageNames, theUIOrder,
- false);
- }
-
-
- private static List<Method> methodsFrom(String valueString) {
- return ValueParserConstants.parsePrimitives(valueString, MULTI_VALUE_DELIMITER, METHOD_PARSER);
+ methodsFrom(methodDefaults),
+ legalPackageNames, theUIOrder,
+ false);
}
@@ -131,4 +110,38 @@ public Class<Method> type() {
public List<Method> valueFrom(String valueString) throws IllegalArgumentException {
return methodsFrom(valueString);
}
+
+
+ private static List<Method> methodsFrom(String valueString) {
+ return ValueParserConstants.parsePrimitives(valueString, MULTI_VALUE_DELIMITER, METHOD_PARSER);
+ }
+
+
+ static PropertyDescriptorBuilderConversionWrapper.MultiValue.Packaged<Method, MethodMultiPBuilder> extractor() {
+ return new PropertyDescriptorBuilderConversionWrapper.MultiValue.Packaged<Method, MethodMultiPBuilder>(Method.class, ValueParserConstants.METHOD_PARSER) {
+ @Override
+ protected MethodMultiPBuilder newBuilder(String name) {
+ return new MethodMultiPBuilder(name);
+ }
+ };
+ }
+
+
+ public static MethodMultiPBuilder named(String name) {
+ return new MethodMultiPBuilder(name);
+ }
+
+
+ public static final class MethodMultiPBuilder extends MultiPackagedPropertyBuilder<Method, MethodMultiPBuilder> {
+ private MethodMultiPBuilder(String name) {
+ super(name);
+ }
+
+
+ @Override
+ public MethodMultiProperty build() {
+ return new MethodMultiProperty(name, description, defaultValues, legalPackageNames, uiOrder, isDefinedInXML);
+ }
+ }
+
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/MethodProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/MethodProperty.java
index fe92aa88fcc..66cc0bed814 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/MethodProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/MethodProperty.java
@@ -9,38 +9,23 @@
import java.lang.reflect.Method;
import java.util.Collections;
-import java.util.Map;
+import net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper;
+import net.sourceforge.pmd.properties.builders.SinglePackagedPropertyBuilder;
import net.sourceforge.pmd.properties.modules.MethodPropertyModule;
+
/**
- * Defines a property type that can specify a single method to use as part of a
- * rule.
+ * Defines a property type that can specify a single method to use as part of a rule.
*
- * <p>Rule developers can limit the rules to those within designated packages per
- * the 'legalPackages' argument in the constructor which can be an array of
- * partial package names, i.e., ["java.lang", "com.mycompany" ].</p>
+ * <p>Rule developers can limit the rules to those within designated packages per the 'legalPackages' argument in the
+ * constructor which can be an array of partial package names, i.e., ["java.lang", "com.mycompany" ].</p>
*
* @author Brian Remedios
* @version Refactored June 2017 (6.0.0)
*/
public final class MethodProperty extends AbstractPackagedProperty<Method> {
- /** Factory. */
- public static final PropertyDescriptorFactory<Method> FACTORY // @formatter:off
- = new SingleValuePropertyDescriptorFactory<Method>(Method.class, PACKAGED_FIELD_TYPES_BY_KEY) {
- @Override
- public MethodProperty createWith(Map<PropertyDescriptorField, String> valuesById, boolean isDefinedExternally) {
- char delimiter = delimiterIn(valuesById);
- return new MethodProperty(nameIn(valuesById),
- descriptionIn(valuesById),
- METHOD_PARSER.valueOf(defaultValueIn(valuesById)),
- legalPackageNamesIn(valuesById, delimiter),
- 0f,
- isDefinedExternally);
- }
- }; // @formatter:on
-
/**
* Constructor for MethodProperty.
@@ -61,7 +46,7 @@ public MethodProperty(String theName, String theDescription, Method theDefault,
private MethodProperty(String theName, String theDescription, Method theDefault, String[] legalPackageNames,
float theUIOrder, boolean isDefinedExternally) {
super(theName, theDescription, theDefault, theUIOrder, isDefinedExternally,
- new MethodPropertyModule(legalPackageNames, Collections.singletonList(theDefault)));
+ new MethodPropertyModule(legalPackageNames, Collections.singletonList(theDefault)));
}
@@ -79,7 +64,7 @@ private MethodProperty(String theName, String theDescription, Method theDefault,
public MethodProperty(String theName, String theDescription, String defaultMethodStr, String[] legalPackageNames,
float theUIOrder) {
this(theName, theDescription, METHOD_PARSER.valueOf(defaultMethodStr),
- legalPackageNames, theUIOrder, false);
+ legalPackageNames, theUIOrder, false);
}
@@ -101,4 +86,32 @@ public Method createFrom(String valueString) throws IllegalArgumentException {
}
+ static PropertyDescriptorBuilderConversionWrapper.SingleValue.Packaged<Method, MethodPBuilder> extractor() {
+ return new PropertyDescriptorBuilderConversionWrapper.SingleValue.Packaged<Method, MethodPBuilder>(Method.class, ValueParserConstants.METHOD_PARSER) {
+ @Override
+ protected MethodPBuilder newBuilder(String name) {
+ return new MethodPBuilder(name);
+ }
+ };
+ }
+
+
+ public static MethodPBuilder named(String name) {
+ return new MethodPBuilder(name);
+ }
+
+
+ public static final class MethodPBuilder extends SinglePackagedPropertyBuilder<Method, MethodPBuilder> {
+ private MethodPBuilder(String name) {
+ super(name);
+ }
+
+
+ @Override
+ public MethodProperty build() {
+ return new MethodProperty(name, description, defaultValue, legalPackageNames, uiOrder, isDefinedInXML);
+ }
+ }
+
+
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/MultiValuePropertyDescriptor.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/MultiValuePropertyDescriptor.java
index 4d047a0b140..6d70fd44a79 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/MultiValuePropertyDescriptor.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/MultiValuePropertyDescriptor.java
@@ -6,6 +6,7 @@
import java.util.List;
+
/**
* Specializes property descriptors for multi valued descriptors. For this type of property, the return value of the
* {@link #type()} method must be the class literal of the type parameter of this interface, which is the type of the
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/MultiValuePropertyDescriptorFactory.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/MultiValuePropertyDescriptorFactory.java
deleted file mode 100644
index 08693bd6107..00000000000
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/MultiValuePropertyDescriptorFactory.java
+++ /dev/null
@@ -1,40 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.properties;
-
-import java.util.List;
-import java.util.Map;
-
-/**
- * Concrete implementation of a property descriptor factory for multi valued properties.
- *
- * @param <T> Type of the property
- *
- * @author Clément Fournier
- * @since 6.0.0
- */
-public abstract class MultiValuePropertyDescriptorFactory<T> extends AbstractPropertyDescriptorFactory<List<T>> {
-
- public MultiValuePropertyDescriptorFactory(Class<T> theValueType) {
- super(theValueType);
- }
-
-
- public MultiValuePropertyDescriptorFactory(Class<T> theValueType,
- Map<PropertyDescriptorField, Boolean> additionalFieldTypesByKey) {
- super(theValueType, additionalFieldTypesByKey);
- }
-
-
- @Override
- protected abstract MultiValuePropertyDescriptor<T> createWith(Map<PropertyDescriptorField, String> valuesById,
- boolean isDefinedExternally);
-
-
- @Override
- public boolean isMultiValue() {
- return true;
- }
-}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/NumericPropertyDescriptor.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/NumericPropertyDescriptor.java
index 82cac5e9d5b..99959662a97 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/NumericPropertyDescriptor.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/NumericPropertyDescriptor.java
@@ -4,25 +4,16 @@
package net.sourceforge.pmd.properties;
-import static net.sourceforge.pmd.properties.PropertyDescriptorField.MAX;
-import static net.sourceforge.pmd.properties.PropertyDescriptorField.MIN;
-
-import java.util.Map;
-
/**
- * Defines a descriptor type whose instance values are required to lie within
- * specified upper and lower limits.
+ * Defines a descriptor type whose instance values are required to lie within specified upper and lower limits.
*
* @param <T> type of the property value
*
* @author Brian Remedios
+ * @author Clément Fournier
*/
public interface NumericPropertyDescriptor<T> extends PropertyDescriptor<T> {
- Map<PropertyDescriptorField, Boolean> NUMBER_FIELD_TYPES_BY_KEY
- = ExpectedFieldsBuilder.instance().put(MIN, true).put(MAX, true).build();
-
-
/**
* Returns the maximum value that instances of the property can have.
*
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/PackagedPropertyDescriptor.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/PackagedPropertyDescriptor.java
index a58d21e4e0e..bfc42fc402f 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/PackagedPropertyDescriptor.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/PackagedPropertyDescriptor.java
@@ -4,10 +4,6 @@
package net.sourceforge.pmd.properties;
-import static net.sourceforge.pmd.properties.PropertyDescriptorField.LEGAL_PACKAGES;
-
-import java.util.Map;
-
/**
* Defines a property descriptor type whose values can be described by qualified names and thus restricted to only some
* packages. These typically use values such as {@link Class} and {@link java.lang.reflect.Method}.
@@ -18,11 +14,6 @@
*/
public interface PackagedPropertyDescriptor<T> extends PropertyDescriptor<T> {
- /** Required additional fields. */
- Map<PropertyDescriptorField, Boolean> PACKAGED_FIELD_TYPES_BY_KEY
- = AbstractPropertyDescriptorFactory.expectedFieldTypesWith(new PropertyDescriptorField[] {LEGAL_PACKAGES},
- new Boolean[] {false});
-
/** Delimiter used to separate package names. */
char PACKAGE_NAME_DELIMITER = ' ';
/** Delimiter used to separate multiple values if this descriptor is multi valued. */
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyDescriptor.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyDescriptor.java
index d154888eb8b..09d501e01cb 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyDescriptor.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyDescriptor.java
@@ -4,50 +4,33 @@
package net.sourceforge.pmd.properties;
-import static net.sourceforge.pmd.properties.PropertyDescriptorField.DEFAULT_VALUE;
-import static net.sourceforge.pmd.properties.PropertyDescriptorField.DELIMITER;
-import static net.sourceforge.pmd.properties.PropertyDescriptorField.DESCRIPTION;
-import static net.sourceforge.pmd.properties.PropertyDescriptorField.NAME;
-
import java.util.Map;
import net.sourceforge.pmd.Rule;
import net.sourceforge.pmd.RuleSetWriter;
+
/**
- * Property value descriptor that defines the use & requirements for setting
- * property values for use within PMD and any associated GUIs. While concrete
- * descriptor instances are static and immutable they provide validation,
+ * Property value descriptor that defines the use & requirements for setting property values for use within PMD and
+ * any associated GUIs. While concrete descriptor instances are static and immutable they provide validation,
* serialization, and default values for any specific datatypes.
*
- * <p>This interface is primarily specialized according to whether the property is
- * multi-valued or single-valued, see {@link SingleValuePropertyDescriptor} and
- * {@link MultiValuePropertyDescriptor}.
+ * <p>This interface is primarily specialized according to whether the property is multi-valued or single-valued, see
+ * {@link SingleValuePropertyDescriptor} and {@link MultiValuePropertyDescriptor}.
*
- * <p>Several interfaces further specialize the behaviour of descriptors to accommodate
- * specific types of descriptors, see {@link NumericPropertyDescriptor} and
- * {@link EnumeratedPropertyDescriptor}.
+ * <p>Several interfaces further specialize the behaviour of descriptors to accommodate specific types of descriptors,
+ * see {@link NumericPropertyDescriptor} and {@link EnumeratedPropertyDescriptor}.
*
* @param <T> type of the property's value. This is a list type for multi-valued properties.
*
* @author Brian Remedios
+ * @author Clément Fournier
* @version Refactored June 2017 (6.0.0)
*/
public interface PropertyDescriptor<T> extends Comparable<PropertyDescriptor<?>> {
- /** Default expected fields. Unmodifiable. */
- Map<PropertyDescriptorField, Boolean> CORE_EXPECTED_FIELDS
- = ExpectedFieldsBuilder.instance()
- .put(NAME, true)
- .put(DESCRIPTION, true)
- .put(DEFAULT_VALUE, true)
- .put(DELIMITER, false)
- .build();
-
-
/**
- * The name of the property without spaces as it serves as the key into the
- * property map.
+ * The name of the property without spaces as it serves as the key into the property map.
*
* @return String
*/
@@ -55,8 +38,7 @@ public interface PropertyDescriptor<T> extends Comparable<PropertyDescriptor<?>>
/**
- * Describes the property and the role it plays within the rule it is
- * specified for. Could be used in a tooltip.
+ * Describes the property and the role it plays within the rule it is specified for. Could be used in a tooltip.
*
* @return String
*/
@@ -64,8 +46,8 @@ public interface PropertyDescriptor<T> extends Comparable<PropertyDescriptor<?>>
/**
- * Denotes the value datatype. For multi value properties, this is not the
- * List class but the list's component class.
+ * Denotes the value datatype. For multi value properties, this is not the List class but the list's component
+ * class.
*
* @return Class literal of the value type
*/
@@ -75,10 +57,9 @@ public interface PropertyDescriptor<T> extends Comparable<PropertyDescriptor<?>>
/**
* Returns whether the property is multi-valued, i.e. an array of strings,
*
- * <p>As unary property rule properties will return a value of one, you must
- * use the get/setProperty accessors when working with the actual values.
- * When working with multi-value properties then the get/setProperties
- * accessors must be used.</p>
+ * <p>As unary property rule properties will return a value of one, you must use the get/setProperty accessors when
+ * working with the actual values. When working with multi-value properties then the get/setProperties accessors
+ * must be used.</p>
*
* @return boolean
*/
@@ -86,8 +67,7 @@ public interface PropertyDescriptor<T> extends Comparable<PropertyDescriptor<?>>
/**
- * Default value to use when the user hasn't specified one or when they wish
- * to revert to a known-good state.
+ * Default value to use when the user hasn't specified one or when they wish to revert to a known-good state.
*
* @return Object
*/
@@ -95,8 +75,8 @@ public interface PropertyDescriptor<T> extends Comparable<PropertyDescriptor<?>>
/**
- * Validation function that returns a diagnostic error message for a sample
- * property value. Returns null if the value is acceptable.
+ * Validation function that returns a diagnostic error message for a sample property value. Returns null if the
+ * value is acceptable.
*
* @param value The value to check.
*
@@ -106,15 +86,12 @@ public interface PropertyDescriptor<T> extends Comparable<PropertyDescriptor<?>>
/**
- * Denotes the relative order the property field should occupy if we are
- * using an auto-generated UI to display and edit property values. If the
- * value returned has a non-zero fractional part then this is can be used to
- * place adjacent fields on the same row.
+ * Denotes the relative order the property field should occupy if we are using an auto-generated UI to display and
+ * edit property values. If the value returned has a non-zero fractional part then this is can be used to place
+ * adjacent fields on the same row.
*
- * <p>Example:<br>
- * name -> 0.0 description 1.0 minValue -> 2.0 maxValue -> 2.1
- * </p>
- * ..would have their fields placed like:<br>
+ * <p>Example:<br> name -> 0.0 description 1.0 minValue -> 2.0 maxValue -> 2.1 </p> ..would have their
+ * fields placed like:<br>
*
* <code>name: [ ] description: [ ] minimum: [ ] maximum: [ ]</code>
*
@@ -129,15 +106,13 @@ public interface PropertyDescriptor<T> extends Comparable<PropertyDescriptor<?>>
* @param propertyString The string to parse
*
* @return The value represented by the string
- *
* @throws IllegalArgumentException if the given string cannot be parsed
*/
T valueFrom(String propertyString) throws IllegalArgumentException;
/**
- * Formats the object onto a string suitable for storage within the property
- * map.
+ * Formats the object onto a string suitable for storage within the property map.
*
* @param value Object
*
@@ -147,8 +122,8 @@ public interface PropertyDescriptor<T> extends Comparable<PropertyDescriptor<?>>
/**
- * A convenience method that returns an error string if the rule holds onto
- * a property value that has a problem. Returns null otherwise.
+ * A convenience method that returns an error string if the rule holds onto a property value that has a problem.
+ * Returns null otherwise.
*
* @param rule Rule
*
@@ -158,9 +133,8 @@ public interface PropertyDescriptor<T> extends Comparable<PropertyDescriptor<?>>
/**
- * If the datatype is a String then return the preferred number of rows to
- * allocate in the text widget, returns a value of one for all other types.
- * Useful for multi-line XPATH editors.
+ * If the datatype is a String then return the preferred number of rows to allocate in the text widget, returns a
+ * value of one for all other types. Useful for multi-line XPATH editors.
*
* @return int
*/
@@ -168,8 +142,7 @@ public interface PropertyDescriptor<T> extends Comparable<PropertyDescriptor<?>>
/**
- * Returns a map representing all the property attributes of the receiver in
- * string form.
+ * Returns a map representing all the property attributes of the receiver in string form.
*
* @return map
*/
@@ -177,10 +150,9 @@ public interface PropertyDescriptor<T> extends Comparable<PropertyDescriptor<?>>
/**
- * True if this descriptor was defined in the ruleset xml. This precision is
- * necessary for the {@link RuleSetWriter} to write out the property correctly:
- * if it was defined externally, then its definition must be written out, otherwise
- * only its value.
+ * True if this descriptor was defined in the ruleset xml. This precision is necessary for the {@link RuleSetWriter}
+ * to write out the property correctly: if it was defined externally, then its definition must be written out,
+ * otherwise only its value.
*
* @return True if the descriptor was defined in xml
*/
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyDescriptorFactory.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyDescriptorFactory.java
deleted file mode 100755
index a21517322ee..00000000000
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyDescriptorFactory.java
+++ /dev/null
@@ -1,56 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.properties;
-
-import java.util.Map;
-import java.util.Set;
-
-/**
- * A factory to create {@link PropertyDescriptor}s based on a map of values.
- *
- * @param <T> The type of values property descriptor returned by this factory. This can be a list.
- *
- * @author Brian Remedios
- * @version Refactored July 2017 (6.0.0)
- */
-public interface PropertyDescriptorFactory<T> {
-
- /**
- * The type of the value of the {@link PropertyDescriptor} created by this
- * factory.
- *
- * @return The type of the value.
- */
- Class<?> valueType();
-
-
- /**
- * Returns true if the built property descriptor is multi-valued.
- *
- * @return True if the built property descriptor is multi-valued.
- */
- boolean isMultiValue();
-
-
- /**
- * Denote the identifiers of all fields that contribute to building
- * this descriptor. Control of the required fields is performed
- * inside the factory.
- *
- * @return A set of field identifiers
- */
- Set<PropertyDescriptorField> expectableFields();
-
-
- /**
- * Create a property descriptor of the appropriate type using the values
- * provided.
- *
- * @param valuesById the map of values
- *
- * @return A new and initialized {@link PropertyDescriptor}
- */
- PropertyDescriptor<T> createWith(Map<PropertyDescriptorField, String> valuesById);
-}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyDescriptorField.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyDescriptorField.java
index 745771bdb27..e1d3f1dd09c 100755
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyDescriptorField.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyDescriptorField.java
@@ -4,15 +4,18 @@
package net.sourceforge.pmd.properties;
+import java.util.Objects;
+
import net.sourceforge.pmd.RuleSetFactory;
+
/**
- * Field names for parsing the properties out of the ruleset xml files. These are intended to be used as the keys to
- * a map of fields to values. Most property descriptors can be built directly from such a map using their factory.
+ * Field names for parsing the properties out of the ruleset xml files. These are intended to be used as the keys to a
+ * map of fields to values. Most property descriptors can be built directly from such a map using their factory.
*
* @author Brian Remedios
* @see RuleSetFactory
- * @see PropertyDescriptorUtil
+ * @see PropertyTypeId
*/
public enum PropertyDescriptorField {
@@ -22,6 +25,8 @@ public enum PropertyDescriptorField {
NAME("name"),
/** The description of the property. */
DESCRIPTION("description"),
+ /** The UI order. */
+ UI_ORDER("uiOrder"),
/** The default value. */
DEFAULT_VALUE("value"),
/** For multi-valued properties, this defines the delimiter of the single values. */
@@ -30,10 +35,7 @@ public enum PropertyDescriptorField {
MIN("min"),
/** The maximum allowed value for numeric properties. */
MAX("max"),
- /**
- * To limit the range of valid values, package names.
- * @see PackagedPro
- */
+ /** To limit the range of valid values, package names. */
LEGAL_PACKAGES("legalPackages"),
/** Labels for enumerated properties. */
LABELS("labels"),
@@ -65,4 +67,14 @@ public String toString() {
return attributeName();
}
+
+ public static PropertyDescriptorField getConstant(String name) {
+ for (PropertyDescriptorField f : values()) {
+ if (Objects.equals(f.attributeName, name)) {
+ return f;
+ }
+ }
+ return null;
+ }
+
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyDescriptorUtil.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyDescriptorUtil.java
deleted file mode 100755
index afc0dea3f65..00000000000
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyDescriptorUtil.java
+++ /dev/null
@@ -1,89 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.properties;
-
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.Map;
-
-/**
- * Utility class allowing to find the factory of a specific type of descriptor. That's used to define descriptors in
- * the xml, eg for xpath rules.
- *
- * @author Brian Remedios
- */
-public final class PropertyDescriptorUtil {
-
- private static final Map<String, PropertyDescriptorFactory<?>> DESCRIPTOR_FACTORIES_BY_TYPE;
-
-
- static {
- Map<String, PropertyDescriptorFactory<?>> temp = new HashMap<>(18);
- temp.put("Boolean", BooleanProperty.FACTORY);
- temp.put("List<Boolean>", BooleanMultiProperty.FACTORY);
-
- temp.put("String", StringProperty.FACTORY);
- temp.put("List<String>", StringMultiProperty.FACTORY);
- temp.put("Character", CharacterProperty.FACTORY);
- temp.put("List<Character>", CharacterMultiProperty.FACTORY);
-
-
- temp.put("Integer", IntegerProperty.FACTORY);
- temp.put("List<Integer>", IntegerMultiProperty.FACTORY);
- temp.put("Long", LongProperty.FACTORY);
- temp.put("List<Long>", LongMultiProperty.FACTORY);
- temp.put("Float", FloatProperty.FACTORY);
- temp.put("List<Float>", FloatMultiProperty.FACTORY);
- temp.put("Double", DoubleProperty.FACTORY);
- temp.put("List<Double>", DoubleMultiProperty.FACTORY);
- // temp.put("Enum", EnumeratedProperty.FACTORY); // TODO:cf implement that
- // temp.put("List<Enum>", EnumeratedMultiProperty.FACTORY);
-
- temp.put("Class", TypeProperty.FACTORY);
- temp.put("List<Class>", TypeMultiProperty.FACTORY);
- temp.put("Method", MethodProperty.FACTORY);
- temp.put("List<Method>", MethodMultiProperty.FACTORY);
-
- temp.put("File", FileProperty.FACTORY);
-
- DESCRIPTOR_FACTORIES_BY_TYPE = Collections.unmodifiableMap(temp);
- }
-
-
- private PropertyDescriptorUtil() { }
-
-
- /**
- * Gets the factory for the descriptor identified by the string id.
- *
- * @param typeId The identifier of the type
- *
- * @return The factory used to build new instances of a descriptor
- */
- public static PropertyDescriptorFactory<?> factoryFor(String typeId) {
- return DESCRIPTOR_FACTORIES_BY_TYPE.get(typeId);
- }
-
-
- /**
- * Gets the string representation of this type, as it should be given when defining a descriptor in the xml.
- *
- * @param valueType The type to look for
- * @param multiValue Whether the descriptor is multivalued or not
- *
- * @return The type id
- */
- public static String typeIdFor(Class<?> valueType, boolean multiValue) {
-
- for (Map.Entry<String, PropertyDescriptorFactory<?>> entry : DESCRIPTOR_FACTORIES_BY_TYPE.entrySet()) {
- if (entry.getValue().valueType() == valueType && entry.getValue().isMultiValue() == multiValue) {
- return entry.getKey();
- }
- }
- return null;
- }
-
-
-}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertySource.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertySource.java
index 2f7af354d0f..7b24644164a 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertySource.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertySource.java
@@ -8,16 +8,26 @@
import java.util.Map;
import java.util.Set;
+
/**
- * Any entity that manages a list of properties is a {@link PropertySource}.
- * These are e.g. Rules and Renderers.
+ * Entity that manages a list of properties. Properties are described by
+ * {@linkplain PropertyDescriptor property descriptors}. A property source
+ * maintains a mapping of property descriptors to property values. The value
+ * of a property can be set by {@link #setProperty(PropertyDescriptor, Object)}.
+ * If the property wasn't set with this method, then the property is assumed
+ * to take a default value, which is specified by {@linkplain PropertyDescriptor#defaultValue() the property descriptor}.
+ *
+ * <p>Bad configuration of the properties may be reported by {@link #dysfunctionReason()}.
+ *
+ * <p>Notable instances of this interface are {@linkplain net.sourceforge.pmd.Rule rules} and
+ * {@linkplain net.sourceforge.pmd.renderers.Renderer renderers}.
*
* @author Brian Remedios
*/
public interface PropertySource {
/**
- * Define a new property via a PropertyDescriptor.
+ * Defines a new property. Properties must be defined before they can be set a value.
*
* @param propertyDescriptor The property descriptor.
*
@@ -26,6 +36,15 @@ public interface PropertySource {
void definePropertyDescriptor(PropertyDescriptor<?> propertyDescriptor) throws IllegalArgumentException;
+ /**
+ * Gets the name of this property source. This is e.g. the name
+ * of the rule or renderer.
+ *
+ * @return The name
+ */
+ String getName();
+
+
/**
* Get the PropertyDescriptor for the given property name.
*
@@ -37,8 +56,8 @@ public interface PropertySource {
/**
- * Get the PropertyDescriptors for all defined properties. The properties
- * are returned sorted by UI order.
+ * Get the descriptors of all defined properties.
+ * The properties are returned sorted by UI order.
*
* @return The PropertyDescriptors in UI order.
*/
@@ -46,7 +65,16 @@ public interface PropertySource {
/**
- * Get the typed value for the given property. Multi valued properties return immutable lists.
+ * Returns a modifiable list of the property descriptors
+ * that don't use default values.
+ *
+ * @return The descriptors that don't use default values
+ */
+ List<PropertyDescriptor<?>> getOverriddenPropertyDescriptors();
+
+ /**
+ * Get the typed value for the given property.
+ * Multi valued properties return immutable lists.
*
* @param <T> The underlying type of the property descriptor.
* @param propertyDescriptor The property descriptor.
@@ -57,7 +85,18 @@ public interface PropertySource {
/**
- * Set the property value specified (will be type-checked)
+ * Returns true if the given property has been set to a value
+ * somewhere in the XML.
+ *
+ * @param propertyDescriptor The descriptor
+ *
+ * @return True if the property has been set
+ */
+ boolean isPropertyOverridden(PropertyDescriptor<?> propertyDescriptor);
+
+ /**
+ * Set the property value specified. This is also referred to as "overriding"
+ * the (default) value of a property.
*
* @param <T> The underlying type of the property descriptor.
* @param propertyDescriptor The property descriptor.
@@ -68,6 +107,7 @@ public interface PropertySource {
/**
* Sets the value of a multi value property descriptor with a variable number of arguments.
+ * This is also referred to as "overriding" the (default) value of a property.
*
* @param propertyDescriptor The property descriptor for which to add a value
* @param values Values
@@ -77,20 +117,36 @@ public interface PropertySource {
/**
- * Returns all the current property values for the receiver or an immutable
- * empty map if none are specified.
+ * Returns an unmodifiable map of descriptors to property values
+ * for the current receiver. The returned map has an entry for
+ * every defined descriptor ({@link #getPropertyDescriptors()}),
+ * if they were not specified explicitly, then default values are
+ * used.
*
- * @return all current property values or a empty map.
+ * @return An unmodifiable map of descriptors to property values
*/
Map<PropertyDescriptor<?>, Object> getPropertiesByPropertyDescriptor();
/**
- * Returns whether this Rule has the specified PropertyDescriptor.
+ * Returns a modifiable map of the property descriptors
+ * that don't use default values, to their overridden value.
+ * Modifications on the returned map don't affect this property
+ * source.
+ *
+ * @return The descriptors that don't use default values
+ */
+ Map<PropertyDescriptor<?>, Object> getOverriddenPropertiesByPropertyDescriptor();
+
+
+ /**
+ * Returns whether the specified property is defined on this property source,
+ * in which case it can be set or retrieved with {@link #getProperty(PropertyDescriptor)}
+ * and {@link #setProperty(PropertyDescriptor, Object)}.
*
- * @param descriptor The PropertyDescriptor for which to check.
+ * @param descriptor The descriptor to look for
*
- * @return boolean <code>true</code> if the descriptor is present, <code>false</code> otherwise.
+ * @return {@code true} if the descriptor is defined, {@code false} otherwise.
*/
boolean hasDescriptor(PropertyDescriptor<?> descriptor);
@@ -99,33 +155,39 @@ public interface PropertySource {
* Returns whether this Rule uses default values for properties.
*
* @return boolean <code>true</code> if the properties all have default values, <code>false</code> otherwise.
+ *
+ * @deprecated Has no real utility, will be removed by 7.0.0
*/
+ @Deprecated
boolean usesDefaultValues();
/**
- * Clears out any user-specified value for the property allowing it to use
- * the default value in the descriptor.
+ * Clears out any user-specified value for the property allowing it to use the default value in the descriptor.
*
* @param desc the property to clear out
+ *
+ * @deprecated Has no real utility, and the name is confusing, will be removed by 7.0.0
*/
+ @Deprecated
void useDefaultValueFor(PropertyDescriptor<?> desc);
/**
- * Return the properties that are effectively ignored due to the
- * configuration of the rule and values held by other properties. This can
- * be used to disable corresponding widgets in a UI.
+ * Return the properties that are effectively ignored due to the configuration of the rule and values held by other
+ * properties. This can be used to disable corresponding widgets in a UI.
*
* @return the properties that are ignored
+ * @deprecated Has no real utility, will be removed by 7.0.0
*/
+ @Deprecated
Set<PropertyDescriptor<?>> ignoredProperties();
/**
- * Returns a description of why the receiver may be dysfunctional. Usually
- * due to missing property values or some kind of conflict between values.
- * Returns null if the receiver is ok.
+ * Returns a description of why the receiver may be dysfunctional.
+ * Usually due to missing property values or some kind of conflict
+ * between values. Returns null if the receiver is ok.
*
* @return String
*/
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyTypeId.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyTypeId.java
new file mode 100644
index 00000000000..dfe151feada
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/PropertyTypeId.java
@@ -0,0 +1,204 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.properties;
+
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+
+import net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper;
+import net.sourceforge.pmd.properties.builders.PropertyDescriptorExternalBuilder;
+
+
+/**
+ * Enumerates the properties that can be built from the XML. Defining a property in
+ * the XML requires the {@code type} attribute, which acts as a mnemonic for the type
+ * of the property that should be built. The mapping between the values of this attribute
+ * and the concrete property that is built is encoded in the constants of this enum.
+ *
+ * @author Clément Fournier
+ * @see PropertyDescriptorExternalBuilder
+ * @since 6.0.0
+ */
+public enum PropertyTypeId {
+ BOOLEAN("Boolean", BooleanProperty.extractor(), ValueParserConstants.BOOLEAN_PARSER),
+ BOOLEAN_LIST("List[Boolean]", BooleanMultiProperty.extractor(), ValueParserConstants.BOOLEAN_PARSER),
+
+ STRING("String", StringProperty.extractor(), ValueParserConstants.STRING_PARSER),
+ STRING_LIST("List[String]", StringMultiProperty.extractor(), ValueParserConstants.STRING_PARSER),
+ CHARACTER("Character", CharacterProperty.extractor(), ValueParserConstants.CHARACTER_PARSER),
+ CHARACTER_LIST("List[Character]", CharacterMultiProperty.extractor(), ValueParserConstants.CHARACTER_PARSER),
+
+ REGEX("Regex", RegexProperty.extractor(), ValueParserConstants.REGEX_PARSER),
+
+ INTEGER("Integer", IntegerProperty.extractor(), ValueParserConstants.INTEGER_PARSER),
+ INTEGER_LIST("List[Integer]", IntegerMultiProperty.extractor(), ValueParserConstants.INTEGER_PARSER),
+ LONG("Long", LongProperty.extractor(), ValueParserConstants.LONG_PARSER),
+ LONG_LIST("List[Long]", LongMultiProperty.extractor(), ValueParserConstants.LONG_PARSER),
+ FLOAT("Float", FloatProperty.extractor(), ValueParserConstants.FLOAT_PARSER),
+ FLOAT_LIST("List[Float]", FloatMultiProperty.extractor(), ValueParserConstants.FLOAT_PARSER),
+ DOUBLE("Double", DoubleProperty.extractor(), ValueParserConstants.DOUBLE_PARSER),
+ DOUBLE_LIST("List[Double]", DoubleMultiProperty.extractor(), ValueParserConstants.DOUBLE_PARSER),
+ // ENUM("Enum", EnumeratedProperty.FACTORY), // TODO:cf we need new syntax in the xml to support that
+ // ENUM_LIST("List[Enum]", EnumeratedMultiProperty.FACTORY),
+
+ CLASS("Class", TypeProperty.extractor(), ValueParserConstants.CLASS_PARSER),
+ CLASS_LIST("List[Class]", TypeMultiProperty.extractor(), ValueParserConstants.CLASS_PARSER);
+
+
+ private static final Map<String, PropertyTypeId> CONSTANTS_BY_MNEMONIC;
+ private final String stringId;
+ private final PropertyDescriptorExternalBuilder<?> factory;
+ private final ValueParser<?> valueParser;
+
+ static {
+ Map<String, PropertyTypeId> temp = new HashMap<>();
+ for (PropertyTypeId id : values()) {
+ temp.put(id.stringId, id);
+ }
+ CONSTANTS_BY_MNEMONIC = Collections.unmodifiableMap(temp);
+ }
+
+
+ PropertyTypeId(String id, PropertyDescriptorExternalBuilder<?> factory, ValueParser<?> valueParser) {
+ this.stringId = id;
+ this.factory = factory;
+ this.valueParser = valueParser;
+ }
+
+
+ /**
+ * Gets the value of the type attribute represented by this constant.
+ *
+ * @return The string id
+ */
+ public String getStringId() {
+ return stringId;
+ }
+
+
+ /**
+ * Gets the factory associated to the type id, that can build the
+ * property from strings extracted from the XML.
+ *
+ * @return The factory
+ */
+ public PropertyDescriptorExternalBuilder<?> getFactory() {
+ return factory;
+ }
+
+
+ /**
+ * Returns true if the property corresponding to this factory is numeric,
+ * which means it can be safely cast to a {@link NumericPropertyDescriptor}.
+ *
+ * @return whether the property is numeric
+ */
+ public boolean isPropertyNumeric() {
+ return factory instanceof PropertyDescriptorBuilderConversionWrapper.SingleValue.Numeric
+ || factory instanceof PropertyDescriptorBuilderConversionWrapper.MultiValue.Numeric;
+ }
+
+
+ /**
+ * Returns true if the property corresponding to this factory is packaged,
+ * which means it can be safely cast to a {@link PackagedPropertyDescriptor}.
+ *
+ * @return whether the property is packaged
+ */
+ public boolean isPropertyPackaged() {
+ return factory instanceof PropertyDescriptorBuilderConversionWrapper.SingleValue.Packaged
+ || factory instanceof PropertyDescriptorBuilderConversionWrapper.MultiValue.Packaged;
+ }
+
+
+ /**
+ * Returns true if the property corresponding to this factory takes
+ * lists of values as its value.
+ *
+ * @return whether the property is multivalue
+ */
+ public boolean isPropertyMultivalue() {
+ return factory.isMultiValue();
+ }
+
+
+ /**
+ * Returns the value type of the property corresponding to this factory.
+ * This is the component type of the list if the property is multivalued.
+ *
+ * @return The value type of the property
+ */
+ public Class<?> propertyValueType() {
+ return factory.valueType();
+ }
+
+
+ /**
+ * Gets the object used to parse the values of this property from a string.
+ * If the property is multivalued, the parser only parses individual components
+ * of the list. A list parser can be obtained with {@link ValueParserConstants#multi(ValueParser, char)}.
+ *
+ * @return The value parser
+ */
+ public ValueParser<?> getValueParser() {
+ return valueParser;
+ }
+
+
+ /**
+ * Returns the full mappings from type ids to enum constants.
+ *
+ * @return The full mapping.
+ */
+ public static Map<String, PropertyTypeId> typeIdsToConstants() {
+ return CONSTANTS_BY_MNEMONIC;
+ }
+
+
+ /**
+ * Gets the factory for the descriptor identified by the string id.
+ *
+ * @param stringId The identifier of the type
+ *
+ * @return The factory used to build new instances of a descriptor
+ */
+ public static PropertyDescriptorExternalBuilder<?> factoryFor(String stringId) {
+ PropertyTypeId cons = CONSTANTS_BY_MNEMONIC.get(stringId);
+ return cons == null ? null : cons.factory;
+ }
+
+
+ /**
+ * Gets the enum constant corresponding to the given mnemonic.
+ *
+ * @param stringId A mnemonic for the property type
+ *
+ * @return A PropertyTypeId
+ */
+ public static PropertyTypeId lookupMnemonic(String stringId) {
+ return CONSTANTS_BY_MNEMONIC.get(stringId);
+ }
+
+
+ /**
+ * Gets the string representation of this type, as it should be given
+ * when defining a descriptor in the xml.
+ *
+ * @param valueType The type to look for
+ * @param multiValue Whether the descriptor is multivalued or not
+ *
+ * @return The string id
+ */
+ public static String typeIdFor(Class<?> valueType, boolean multiValue) {
+ for (Map.Entry<String, PropertyTypeId> entry : CONSTANTS_BY_MNEMONIC.entrySet()) {
+ if (entry.getValue().propertyValueType() == valueType
+ && entry.getValue().isPropertyMultivalue() == multiValue) {
+ return entry.getKey();
+ }
+ }
+ return null;
+ }
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/RegexProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/RegexProperty.java
new file mode 100644
index 00000000000..c7559693b91
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/RegexProperty.java
@@ -0,0 +1,87 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.properties;
+
+import java.util.regex.Pattern;
+
+import net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper;
+import net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper.SingleValue;
+import net.sourceforge.pmd.properties.builders.SingleValuePropertyBuilder;
+
+
+/**
+ * Property which has a regex pattern as a value. This property has no multi-valued
+ * variant, since it would be ambiguous whether the delimiters are part of the regex
+ * or not.
+ *
+ * @author Clément Fournier
+ * @since 6.2.0
+ */
+public final class RegexProperty extends AbstractSingleValueProperty<Pattern> {
+
+ RegexProperty(String theName, String theDescription, Pattern theDefault, float theUIOrder, boolean isDefinedExternally) {
+ super(theName, theDescription, theDefault, theUIOrder, isDefinedExternally);
+ }
+
+
+ @Override
+ protected Pattern createFrom(String toParse) {
+ return Pattern.compile(toParse);
+ }
+
+
+ @Override
+ public Class<Pattern> type() {
+ return Pattern.class;
+ }
+
+
+ static SingleValue<Pattern, RegexPBuilder> extractor() {
+ return new PropertyDescriptorBuilderConversionWrapper.SingleValue<Pattern, RegexPBuilder>(Pattern.class, ValueParserConstants.REGEX_PARSER) {
+ @Override
+ protected RegexPBuilder newBuilder(String name) {
+ return new RegexPBuilder(name);
+ }
+ };
+ }
+
+
+ /**
+ * Creates a new builder for a regex property.
+ *
+ * @param name The name of the property
+ *
+ * @return A new builder
+ */
+ public static RegexPBuilder named(String name) {
+ return new RegexPBuilder(name);
+ }
+
+ /** Builder for a {@link RegexProperty}. */
+ public static final class RegexPBuilder extends SingleValuePropertyBuilder<Pattern, RegexProperty.RegexPBuilder> {
+ private RegexPBuilder(String name) {
+ super(name);
+ }
+
+
+ /**
+ * Specify a default pattern for the property.
+ * The argument must be a valid regex pattern.
+ *
+ * @param val Regex pattern
+ *
+ * @return The same builder
+ */
+ public RegexPBuilder defaultValue(String val) {
+ return super.defaultValue(Pattern.compile(val));
+ }
+
+
+ @Override
+ public RegexProperty build() {
+ return new RegexProperty(this.name, this.description, this.defaultValue, this.uiOrder, isDefinedInXML);
+ }
+ }
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/SingleValuePropertyDescriptorFactory.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/SingleValuePropertyDescriptorFactory.java
deleted file mode 100644
index 78967158ef1..00000000000
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/SingleValuePropertyDescriptorFactory.java
+++ /dev/null
@@ -1,39 +0,0 @@
-/**
- * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
- */
-
-package net.sourceforge.pmd.properties;
-
-import java.util.Map;
-
-/**
- * Concrete implementation of a property descriptor factory for single valued properties.
- *
- * @param <T> Type of the property
- *
- * @author Clément Fournier
- * @since 6.0.0
- */
-public abstract class SingleValuePropertyDescriptorFactory<T> extends AbstractPropertyDescriptorFactory<T> {
-
- /* default */ SingleValuePropertyDescriptorFactory(Class<T> theValueType) {
- super(theValueType);
- }
-
-
- /* default */ SingleValuePropertyDescriptorFactory(Class<T> theValueType,
- Map<PropertyDescriptorField, Boolean> additionalFieldTypesByKey) {
- super(theValueType, additionalFieldTypesByKey);
- }
-
-
- @Override
- public abstract SingleValuePropertyDescriptor<T> createWith(Map<PropertyDescriptorField, String> valuesById,
- boolean isDefinedExternally);
-
-
- @Override
- public final boolean isMultiValue() {
- return false;
- }
-}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/StringMultiProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/StringMultiProperty.java
index 4e6f945708f..538c0abc200 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/StringMultiProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/StringMultiProperty.java
@@ -4,44 +4,24 @@
package net.sourceforge.pmd.properties;
-import static net.sourceforge.pmd.properties.ValueParserConstants.STRING_PARSER;
-
import java.util.Arrays;
import java.util.List;
-import java.util.Map;
import org.apache.commons.lang3.StringUtils;
+import net.sourceforge.pmd.properties.builders.MultiValuePropertyBuilder;
+import net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper;
+
+
/**
- * Defines a datatype that supports multiple String values. Note that all
- * strings must be filtered by the delimiter character.
+ * Defines a datatype that supports multiple String values. Note that all strings must be filtered by the delimiter
+ * character.
*
* @author Brian Remedios
* @version Refactored June 2017 (6.0.0)
*/
public final class StringMultiProperty extends AbstractMultiValueProperty<String> {
- /** Factory. */
- public static final PropertyDescriptorFactory<List<String>> FACTORY // @formatter:off
- = new MultiValuePropertyDescriptorFactory<String>(String.class) {
-
- @Override
- protected boolean isValueMissing(String value) {
- return StringUtils.isEmpty(value);
- }
-
- @Override
- public StringMultiProperty createWith(Map<PropertyDescriptorField, String> valuesById, boolean isDefinedExternally) {
- char delimiter = delimiterIn(valuesById);
- return new StringMultiProperty(nameIn(valuesById),
- descriptionIn(valuesById),
- ValueParserConstants.parsePrimitives(defaultValueIn(valuesById), delimiter, STRING_PARSER),
- 0.0f,
- delimiter,
- isDefinedExternally);
- }
- }; // @formatter:on
-
/**
* Constructor using an array of defaults.
@@ -88,28 +68,6 @@ private StringMultiProperty(String theName, String theDescription, List<String>
}
- /**
- * Checks if the values are valid.
- *
- * @param defaultValue The default value
- * @param delim The delimiter
- *
- * @throws IllegalArgumentException if one value contains the delimiter
- */
- private static void checkDefaults(List<String> defaultValue, char delim) {
-
- if (defaultValue == null) {
- return;
- }
-
- for (String aDefaultValue : defaultValue) {
- if (aDefaultValue.indexOf(delim) >= 0) {
- throw new IllegalArgumentException("Cannot include the delimiter in the set of defaults");
- }
- }
- }
-
-
@Override
public Class<String> type() {
return String.class;
@@ -155,4 +113,54 @@ private boolean containsDelimiter(String value) {
protected String createFrom(String toParse) {
return toParse;
}
+
+
+ /**
+ * Checks if the values are valid.
+ *
+ * @param defaultValue The default value
+ * @param delim The delimiter
+ *
+ * @throws IllegalArgumentException if one value contains the delimiter
+ */
+ private static void checkDefaults(List<String> defaultValue, char delim) {
+
+ if (defaultValue == null) {
+ return;
+ }
+
+ for (String aDefaultValue : defaultValue) {
+ if (aDefaultValue.indexOf(delim) >= 0) {
+ throw new IllegalArgumentException("Cannot include the delimiter in the set of defaults");
+ }
+ }
+ }
+
+
+ static PropertyDescriptorBuilderConversionWrapper.MultiValue<String, StringMultiPBuilder> extractor() {
+ return new PropertyDescriptorBuilderConversionWrapper.MultiValue<String, StringMultiPBuilder>(String.class, ValueParserConstants.STRING_PARSER) {
+ @Override
+ protected StringMultiPBuilder newBuilder(String name) {
+ return new StringMultiPBuilder(name);
+ }
+ };
+ }
+
+
+ public static StringMultiPBuilder named(String name) {
+ return new StringMultiPBuilder(name);
+ }
+
+
+ public static final class StringMultiPBuilder extends MultiValuePropertyBuilder<String, StringMultiPBuilder> {
+ private StringMultiPBuilder(String name) {
+ super(name);
+ }
+
+
+ @Override
+ public StringMultiProperty build() {
+ return new StringMultiProperty(this.name, this.description, this.defaultValues, this.uiOrder, this.multiValueDelimiter, isDefinedInXML);
+ }
+ }
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/StringProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/StringProperty.java
index 6b751fdfcc9..0fe2652845c 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/StringProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/StringProperty.java
@@ -4,9 +4,9 @@
package net.sourceforge.pmd.properties;
-import java.util.Map;
+import net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper;
+import net.sourceforge.pmd.properties.builders.SingleValuePropertyBuilder;
-import org.apache.commons.lang3.StringUtils;
/**
* Defines a datatype that supports single String values.
@@ -16,26 +16,6 @@
*/
public final class StringProperty extends AbstractSingleValueProperty<String> {
- /** Factory. */
- public static final PropertyDescriptorFactory<String> FACTORY // @formatter:off
- = new SingleValuePropertyDescriptorFactory<String>(String.class) {
-
- @Override
- protected boolean isValueMissing(String value) {
- return StringUtils.isEmpty(value);
- }
-
- @Override
- public StringProperty createWith(Map<PropertyDescriptorField, String> valuesById, boolean isDefinedExternally) {
- return new StringProperty(nameIn(valuesById),
- descriptionIn(valuesById),
- defaultValueIn(valuesById),
- 0f,
- isDefinedExternally);
- }
- }; // @formatter:on
-
-
/**
* Constructor.
*
@@ -66,4 +46,32 @@ public Class<String> type() {
public String createFrom(String valueString) {
return valueString;
}
+
+
+ static PropertyDescriptorBuilderConversionWrapper.SingleValue<String, StringPBuilder> extractor() {
+ return new PropertyDescriptorBuilderConversionWrapper.SingleValue<String, StringPBuilder>(String.class, ValueParserConstants.STRING_PARSER) {
+ @Override
+ protected StringPBuilder newBuilder(String name) {
+ return new StringPBuilder(name);
+ }
+ };
+ }
+
+
+ public static StringPBuilder named(String name) {
+ return new StringPBuilder(name);
+ }
+
+
+ public static final class StringPBuilder extends SingleValuePropertyBuilder<String, StringPBuilder> {
+ private StringPBuilder(String name) {
+ super(name);
+ }
+
+
+ @Override
+ public StringProperty build() {
+ return new StringProperty(this.name, this.description, this.defaultValue, this.uiOrder, isDefinedInXML);
+ }
+ }
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/TypeMultiProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/TypeMultiProperty.java
index aa832efff95..5e53397e4a2 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/TypeMultiProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/TypeMultiProperty.java
@@ -5,13 +5,14 @@
package net.sourceforge.pmd.properties;
import java.util.List;
-import java.util.Map;
+import net.sourceforge.pmd.properties.builders.MultiPackagedPropertyBuilder;
+import net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper;
import net.sourceforge.pmd.properties.modules.TypePropertyModule;
+
/**
- * Defines a property that supports multiple class types, even for primitive
- * values!
+ * Defines a property that supports multiple class types, even for primitive values!
*
* TODO - untested for array types
*
@@ -19,20 +20,6 @@
*/
public final class TypeMultiProperty extends AbstractMultiPackagedProperty<Class> {
- /** Factory. */
- public static final PropertyDescriptorFactory<List<Class>> FACTORY // @formatter:off
- = new MultiValuePropertyDescriptorFactory<Class>(Class.class, PACKAGED_FIELD_TYPES_BY_KEY) {
- @Override
- public TypeMultiProperty createWith(Map<PropertyDescriptorField, String> valuesById, boolean isDefinedExternally) {
- char delimiter = delimiterIn(valuesById);
- return new TypeMultiProperty(nameIn(valuesById),
- descriptionIn(valuesById),
- defaultValueIn(valuesById),
- legalPackageNamesIn(valuesById, delimiter),
- 0f);
- }
- }; // @formatter:on
-
/**
* Constructor for TypeProperty.
@@ -56,7 +43,7 @@ public TypeMultiProperty(String theName, String theDescription, List<Class> theD
private TypeMultiProperty(String theName, String theDescription, List<Class> theTypeDefaults,
String[] legalPackageNames, float theUIOrder, boolean isDefinedExternally) {
super(theName, theDescription, theTypeDefaults, theUIOrder, isDefinedExternally,
- new TypePropertyModule(legalPackageNames, theTypeDefaults));
+ new TypePropertyModule(legalPackageNames, theTypeDefaults));
}
@@ -74,14 +61,9 @@ private TypeMultiProperty(String theName, String theDescription, List<Class> the
public TypeMultiProperty(String theName, String theDescription, String theTypeDefaults,
String[] legalPackageNames, float theUIOrder) {
this(theName, theDescription, typesFrom(theTypeDefaults),
- legalPackageNames,
- theUIOrder, false);
-
- }
-
+ legalPackageNames,
+ theUIOrder, false);
- private static List<Class> typesFrom(String valueString) {
- return ValueParserConstants.parsePrimitives(valueString, MULTI_VALUE_DELIMITER, ValueParserConstants.CLASS_PARSER);
}
@@ -107,4 +89,38 @@ protected Class createFrom(String toParse) {
public List<Class> valueFrom(String valueString) {
return typesFrom(valueString);
}
+
+
+ private static List<Class> typesFrom(String valueString) {
+ return ValueParserConstants.parsePrimitives(valueString, MULTI_VALUE_DELIMITER, ValueParserConstants.CLASS_PARSER);
+ }
+
+
+ public static PropertyDescriptorBuilderConversionWrapper.MultiValue.Packaged<Class, TypeMultiPBuilder> extractor() {
+ return new PropertyDescriptorBuilderConversionWrapper.MultiValue.Packaged<Class, TypeMultiPBuilder>(Class.class, ValueParserConstants.CLASS_PARSER) {
+ @Override
+ protected TypeMultiPBuilder newBuilder(String name) {
+ return new TypeMultiPBuilder(name);
+ }
+ };
+ }
+
+
+ public static TypeMultiPBuilder named(String name) {
+ return new TypeMultiPBuilder(name);
+ }
+
+
+ public static final class TypeMultiPBuilder extends MultiPackagedPropertyBuilder<Class, TypeMultiPBuilder> {
+
+ private TypeMultiPBuilder(String name) {
+ super(name);
+ }
+
+
+ @Override
+ public TypeMultiProperty build() {
+ return new TypeMultiProperty(name, description, defaultValues, legalPackageNames, uiOrder, isDefinedInXML);
+ }
+ }
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/TypeProperty.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/TypeProperty.java
index fc5d577297a..a7d2ef2898b 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/TypeProperty.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/TypeProperty.java
@@ -5,13 +5,14 @@
package net.sourceforge.pmd.properties;
import java.util.Collections;
-import java.util.Map;
+import net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper;
+import net.sourceforge.pmd.properties.builders.SinglePackagedPropertyBuilder;
import net.sourceforge.pmd.properties.modules.TypePropertyModule;
+
/**
- * Defines a property that supports single class types, even for primitive
- * values!
+ * Defines a property that supports single class types, even for primitive values!
*
* TODO - untested for array types
*
@@ -19,22 +20,6 @@
*/
public final class TypeProperty extends AbstractPackagedProperty<Class> {
- /** Factory. */
- public static final PropertyDescriptorFactory<Class> FACTORY // @formatter:off
- = new SingleValuePropertyDescriptorFactory<Class>(Class.class, PACKAGED_FIELD_TYPES_BY_KEY) {
- @Override
- public TypeProperty createWith(Map<PropertyDescriptorField, String> valuesById, boolean isDefinedExternally) {
- char delimiter = delimiterIn(valuesById);
- return new TypeProperty(nameIn(valuesById),
- descriptionIn(valuesById),
- ValueParserConstants.CLASS_PARSER.valueOf(defaultValueIn(valuesById)),
- legalPackageNamesIn(valuesById, delimiter),
- 0f,
- isDefinedExternally);
- }
- }; // @formatter:on
-
-
/**
* Constructor for TypeProperty using a string as default value.
*
@@ -57,7 +42,7 @@ public TypeProperty(String theName, String theDescription, String defaultTypeStr
private TypeProperty(String theName, String theDescription, Class<?> theDefault, String[] legalPackageNames,
float theUIOrder, boolean isDefinedExternally) {
super(theName, theDescription, theDefault, theUIOrder, isDefinedExternally,
- new TypePropertyModule(legalPackageNames, Collections.<Class>singletonList(theDefault)));
+ new TypePropertyModule(legalPackageNames, Collections.<Class>singletonList(theDefault)));
}
@@ -92,4 +77,33 @@ protected String asString(Class value) {
public Class<?> createFrom(String valueString) {
return ValueParserConstants.CLASS_PARSER.valueOf(valueString);
}
+
+
+ static PropertyDescriptorBuilderConversionWrapper.SingleValue.Packaged<Class, TypePBuilder> extractor() {
+ return new PropertyDescriptorBuilderConversionWrapper.SingleValue.Packaged<Class, TypePBuilder>(Class.class, ValueParserConstants.CLASS_PARSER) {
+ @Override
+ protected TypePBuilder newBuilder(String name) {
+ return new TypePBuilder(name);
+ }
+ };
+ }
+
+
+ public static TypePBuilder named(String name) {
+ return new TypePBuilder(name);
+ }
+
+
+ public static final class TypePBuilder extends SinglePackagedPropertyBuilder<Class, TypePBuilder> {
+ private TypePBuilder(String name) {
+ super(name);
+ }
+
+
+ @Override
+ public TypeProperty build() {
+ return new TypeProperty(name, description, defaultValue, legalPackageNames, uiOrder, isDefinedInXML);
+ }
+ }
+
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/ValueParser.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/ValueParser.java
index 4224006c6cd..4ce4acdcad1 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/ValueParser.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/ValueParser.java
@@ -18,7 +18,6 @@ public interface ValueParser<U> {
* @param value The string to parse
*
* @return The primitive found
- *
* @throws IllegalArgumentException if the value couldn't be parsed
*/
U valueOf(String value) throws IllegalArgumentException;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/ValueParserConstants.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/ValueParserConstants.java
index c7a426c2121..b4f60a7f6e7 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/ValueParserConstants.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/ValueParserConstants.java
@@ -9,114 +9,27 @@
import static net.sourceforge.pmd.properties.modules.MethodPropertyModule.METHOD_ARG_DELIMITER;
import static net.sourceforge.pmd.properties.modules.MethodPropertyModule.METHOD_GROUP_DELIMITERS;
+import java.io.File;
import java.lang.reflect.Array;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;
+import java.util.regex.Pattern;
import org.apache.commons.lang3.StringUtils;
import net.sourceforge.pmd.util.ClassUtil;
+
/**
* @author Clément Fournier
* @since 6.0.0
*/
-//TODO: make package-private when we move everything to n.s.pmd.properties
public final class ValueParserConstants {
- /** Extracts characters. */
- static final ValueParser<Character> CHARACTER_PARSER = new ValueParser<Character>() {
- @Override
- public Character valueOf(String value) {
- if (value == null || value.length() != 1) {
- throw new IllegalArgumentException("missing/ambiguous character value");
- }
- return value.charAt(0);
- }
- };
-
-
- /** Extracts strings. That's a dummy used to return a list in StringMultiProperty. */
- static final ValueParser<String> STRING_PARSER = new ValueParser<String>() {
- @Override
- public String valueOf(String value) {
- return value;
- }
- };
-
-
- /** Extracts integers. */
- static final ValueParser<Integer> INTEGER_PARSER = new ValueParser<Integer>() {
- @Override
- public Integer valueOf(String value) {
- return Integer.valueOf(value);
- }
- };
-
-
- /** Extracts booleans. */
- static final ValueParser<Boolean> BOOLEAN_PARSER = new ValueParser<Boolean>() {
- @Override
- public Boolean valueOf(String value) {
- return Boolean.valueOf(value);
- }
- };
-
-
- /** Extracts floats. */
- static final ValueParser<Float> FLOAT_PARSER = new ValueParser<Float>() {
- @Override
- public Float valueOf(String value) {
- return Float.valueOf(value);
- }
- };
-
-
- /** Extracts longs. */
- static final ValueParser<Long> LONG_PARSER = new ValueParser<Long>() {
- @Override
- public Long valueOf(String value) {
- return Long.valueOf(value);
- }
- };
-
-
- /** Extracts doubles. */
- static final ValueParser<Double> DOUBLE_PARSER = new ValueParser<Double>() {
- @Override
- public Double valueOf(String value) {
- return Double.valueOf(value);
- }
- };
-
-
- /** Extract classes. */
- static final ValueParser<Class> CLASS_PARSER = new ValueParser<Class>() {
- @Override
- public Class valueOf(String value) throws IllegalArgumentException {
- if (StringUtils.isBlank(value)) {
- return null;
- }
-
- Class<?> cls = ClassUtil.getTypeFor(value);
- if (cls != null) {
- return cls;
- }
-
- try {
- return Class.forName(value);
- } catch (ClassNotFoundException ex) {
- throw new IllegalArgumentException(value);
- }
- }
- };
-
-
/** Extracts methods. */
- // TODO: make package-private when we move everything to n.s.pmd.properties
- public static final ValueParser<Method> METHOD_PARSER = new ValueParser<Method>() {
+ static final ValueParser<Method> METHOD_PARSER = new ValueParser<Method>() {
@Override
public Method valueOf(String value) throws IllegalArgumentException {
return methodFrom(value, CLASS_METHOD_DELIMITER, METHOD_ARG_DELIMITER);
@@ -223,6 +136,94 @@ private Class<?> typeFor(String typeName) {
}
};
+ /** Extracts characters. */
+ static final ValueParser<Character> CHARACTER_PARSER = new ValueParser<Character>() {
+ @Override
+ public Character valueOf(String value) {
+ if (value == null || value.length() != 1) {
+ throw new IllegalArgumentException("missing/ambiguous character value");
+ }
+ return value.charAt(0);
+ }
+ };
+ /** Extracts strings. That's a dummy used to return a list in StringMultiProperty. */
+ static final ValueParser<String> STRING_PARSER = new ValueParser<String>() {
+ @Override
+ public String valueOf(String value) {
+ return value;
+ }
+ };
+ /** Extracts integers. */
+ static final ValueParser<Integer> INTEGER_PARSER = new ValueParser<Integer>() {
+ @Override
+ public Integer valueOf(String value) {
+ return Integer.valueOf(value);
+ }
+ };
+ /** Extracts booleans. */
+ static final ValueParser<Boolean> BOOLEAN_PARSER = new ValueParser<Boolean>() {
+ @Override
+ public Boolean valueOf(String value) {
+ return Boolean.valueOf(value);
+ }
+ };
+ /** Extracts floats. */
+ static final ValueParser<Float> FLOAT_PARSER = new ValueParser<Float>() {
+ @Override
+ public Float valueOf(String value) {
+ return Float.valueOf(value);
+ }
+ };
+ /** Extracts longs. */
+ static final ValueParser<Long> LONG_PARSER = new ValueParser<Long>() {
+ @Override
+ public Long valueOf(String value) {
+ return Long.valueOf(value);
+ }
+ };
+ /** Extracts doubles. */
+ static final ValueParser<Double> DOUBLE_PARSER = new ValueParser<Double>() {
+ @Override
+ public Double valueOf(String value) {
+ return Double.valueOf(value);
+ }
+ };
+ /** Extracts files */
+ static final ValueParser<File> FILE_PARSER = new ValueParser<File>() {
+ @Override
+ public File valueOf(String value) throws IllegalArgumentException {
+ return new File(value);
+ }
+ };
+
+ /** Compiles a regex. */
+ static final ValueParser<Pattern> REGEX_PARSER = new ValueParser<Pattern>() {
+ @Override
+ public Pattern valueOf(String value) throws IllegalArgumentException {
+ return Pattern.compile(value);
+ }
+ };
+
+ /** Extract classes. */
+ static final ValueParser<Class> CLASS_PARSER = new ValueParser<Class>() {
+ @Override
+ public Class valueOf(String value) throws IllegalArgumentException {
+ if (StringUtils.isBlank(value)) {
+ return null;
+ }
+
+ Class<?> cls = ClassUtil.getTypeFor(value);
+ if (cls != null) {
+ return cls;
+ }
+
+ try {
+ return Class.forName(value);
+ } catch (ClassNotFoundException ex) {
+ throw new IllegalArgumentException(value);
+ }
+ }
+ };
private ValueParserConstants() {
@@ -230,6 +231,25 @@ private ValueParserConstants() {
}
+ /**
+ * Returns a value parser parsing lists of values of type U.
+ *
+ * @param parser Parser used to parse a single value
+ * @param delimiter Char delimiting values
+ * @param <U> Element type of the target list
+ *
+ * @return A list of values
+ */
+ public static <U> ValueParser<List<U>> multi(final ValueParser<U> parser, final char delimiter) {
+ return new ValueParser<List<U>>() {
+ @Override
+ public List<U> valueOf(String value) throws IllegalArgumentException {
+ return parsePrimitives(value, delimiter, parser);
+ }
+ };
+ }
+
+
/**
* Parses a string into a list of values of type {@literal <U>}.
*
@@ -242,7 +262,7 @@ private ValueParserConstants() {
*/
// FUTURE 1.8 : use java.util.function.Function<String, U> in place of ValueParser<U>,
// replace ValueParser constants with static functions
- public static <U> List<U> parsePrimitives(String toParse, char delimiter, ValueParser<U> extractor) {
+ static <U> List<U> parsePrimitives(String toParse, char delimiter, ValueParser<U> extractor) {
String[] values = StringUtils.split(toParse, delimiter);
List<U> result = new ArrayList<>();
for (String s : values) {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/MultiNumericPropertyBuilder.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/MultiNumericPropertyBuilder.java
new file mode 100644
index 00000000000..8bcc2340c38
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/MultiNumericPropertyBuilder.java
@@ -0,0 +1,45 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.properties.builders;
+
+import net.sourceforge.pmd.properties.MultiValuePropertyDescriptor;
+
+
+/**
+ * For multi-value numeric properties.
+ *
+ * @param <V> Element type of the list
+ * @param <T> Concrete type of the underlying builder
+ */
+public abstract class MultiNumericPropertyBuilder<V, T extends MultiNumericPropertyBuilder<V, T>>
+ extends MultiValuePropertyBuilder<V, T> {
+
+
+ protected V lowerLimit;
+ protected V upperLimit;
+
+
+ protected MultiNumericPropertyBuilder(String name) {
+ super(name);
+ multiValueDelimiter = MultiValuePropertyDescriptor.DEFAULT_NUMERIC_DELIMITER;
+ }
+
+
+ /**
+ * Specify the range of acceptable values.
+ *
+ * @param min Lower bound, inclusive
+ * @param max Upper bound, inclusive
+ *
+ * @return The same builder
+ */
+ @SuppressWarnings("unchecked")
+ public T range(V min, V max) {
+ this.lowerLimit = min;
+ this.upperLimit = max;
+ return (T) this;
+ }
+
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/MultiPackagedPropertyBuilder.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/MultiPackagedPropertyBuilder.java
new file mode 100644
index 00000000000..aad9f61895f
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/MultiPackagedPropertyBuilder.java
@@ -0,0 +1,33 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.properties.builders;
+
+import java.util.Arrays;
+
+
+/**
+ * @author Clément Fournier
+ * @since 6.0.0
+ */
+public abstract class MultiPackagedPropertyBuilder<V, T extends MultiPackagedPropertyBuilder<V, T>>
+ extends MultiValuePropertyBuilder<V, T> {
+
+ protected String[] legalPackageNames;
+
+
+ protected MultiPackagedPropertyBuilder(String name) {
+ super(name);
+ }
+
+
+ @SuppressWarnings("unchecked")
+ public T legalPackages(String[] packs) {
+ if (packs != null) {
+ this.legalPackageNames = Arrays.copyOf(packs, packs.length);
+ }
+ return (T) this;
+ }
+
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/MultiValuePropertyBuilder.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/MultiValuePropertyBuilder.java
new file mode 100644
index 00000000000..6405dd57701
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/MultiValuePropertyBuilder.java
@@ -0,0 +1,74 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.properties.builders;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.List;
+
+import net.sourceforge.pmd.properties.MultiValuePropertyDescriptor;
+
+
+/**
+ * For multi-value properties.
+ *
+ * @param <V> Element type of the list
+ * @param <T> Concrete type of the underlying builder
+ */
+public abstract class MultiValuePropertyBuilder<V, T extends MultiValuePropertyBuilder<V, T>>
+ extends PropertyDescriptorBuilder<List<V>, T> {
+
+ protected List<V> defaultValues;
+ protected char multiValueDelimiter = MultiValuePropertyDescriptor.DEFAULT_DELIMITER;
+
+
+ protected MultiValuePropertyBuilder(String name) {
+ super(name);
+ }
+
+
+ /**
+ * Specify a default value.
+ *
+ * @param val List of values
+ *
+ * @return The same builder
+ */
+ @SuppressWarnings("unchecked")
+ public T defaultValues(Collection<? extends V> val) {
+ this.defaultValues = new ArrayList<>(val);
+ return (T) this;
+ }
+
+
+ /**
+ * Specify default values.
+ *
+ * @param val List of values
+ *
+ * @return The same builder
+ */
+ @SuppressWarnings("unchecked")
+ public T defaultValues(V... val) {
+ this.defaultValues = Arrays.asList(val);
+ return (T) this;
+ }
+
+
+ /**
+ * Specify a delimiter character. By default it's {@link MultiValuePropertyDescriptor#DEFAULT_DELIMITER}, or {@link
+ * MultiValuePropertyDescriptor#DEFAULT_NUMERIC_DELIMITER} for numeric properties.
+ *
+ * @param delim Delimiter
+ *
+ * @return The same builder
+ */
+ @SuppressWarnings("unchecked")
+ public T delim(char delim) {
+ this.multiValueDelimiter = delim;
+ return (T) this;
+ }
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/PropertyDescriptorBuilder.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/PropertyDescriptorBuilder.java
new file mode 100644
index 00000000000..784fe1ff0fd
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/PropertyDescriptorBuilder.java
@@ -0,0 +1,85 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.properties.builders;
+
+import org.apache.commons.lang3.StringUtils;
+
+import net.sourceforge.pmd.properties.PropertyDescriptor;
+
+
+/**
+ * Base class for property builders.
+ *
+ * @param <E> Value type of the built descriptor
+ * @param <T> Concrete type of this builder instance. Removes code duplication at the expense of a few unchecked casts.
+ * Everything goes well if this parameter's value is correctly set.
+ *
+ * @author Clément Fournier
+ * @since 6.0.0
+ */
+public abstract class PropertyDescriptorBuilder<E, T extends PropertyDescriptorBuilder<E, T>> {
+
+ protected String name;
+ protected String description;
+ protected float uiOrder = 0f;
+ protected boolean isDefinedInXML = false;
+
+
+ protected PropertyDescriptorBuilder(String name) {
+ if (StringUtils.isBlank(name)) {
+ throw new IllegalArgumentException("Name must be provided");
+ }
+ this.name = name;
+ }
+
+
+ /**
+ * Specify the description of the property.
+ *
+ * @param desc The description
+ *
+ * @return The same builder
+ */
+ @SuppressWarnings("unchecked")
+ public T desc(String desc) {
+ if (StringUtils.isBlank(desc)) {
+ throw new IllegalArgumentException("Description must be provided");
+ }
+ this.description = desc;
+ return (T) this;
+ }
+
+
+ /**
+ * Specify the UI order of the property.
+ *
+ * @param f The UI order
+ *
+ * @return The same builder
+ */
+ @SuppressWarnings("unchecked")
+ public T uiOrder(float f) {
+ this.uiOrder = f;
+ return (T) this;
+ }
+
+
+ /**
+ * Builds the descriptor and returns it.
+ *
+ * @return The built descriptor
+ * @throws IllegalArgumentException if parameters are incorrect
+ */
+ public abstract PropertyDescriptor<E> build();
+
+
+ /**
+ * Returns the name of the property to be built.
+ */
+ public String getName() {
+ return name;
+ }
+
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/PropertyDescriptorBuilderConversionWrapper.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/PropertyDescriptorBuilderConversionWrapper.java
new file mode 100644
index 00000000000..caf9beb9d61
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/PropertyDescriptorBuilderConversionWrapper.java
@@ -0,0 +1,259 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.properties.builders;
+
+
+import static net.sourceforge.pmd.properties.PropertyDescriptorField.DELIMITER;
+import static net.sourceforge.pmd.properties.PropertyDescriptorField.LEGAL_PACKAGES;
+
+import java.util.List;
+import java.util.Map;
+
+import org.apache.commons.lang3.StringUtils;
+
+import net.sourceforge.pmd.properties.MultiValuePropertyDescriptor;
+import net.sourceforge.pmd.properties.PropertyDescriptor;
+import net.sourceforge.pmd.properties.PropertyDescriptorField;
+import net.sourceforge.pmd.properties.ValueParser;
+import net.sourceforge.pmd.properties.ValueParserConstants;
+
+
+/**
+ * Wraps a property builder and maps its inputs from strings to the target types of the descriptor.
+ *
+ * @param <E> Value type of the descriptor
+ * @param <T> Concrete type of the underlying builder
+ *
+ * @author Clément Fournier
+ * @since 6.0.0
+ */
+public abstract class PropertyDescriptorBuilderConversionWrapper<E, T extends PropertyDescriptorBuilder<E, T>>
+ implements PropertyDescriptorExternalBuilder<E> {
+
+ private final Class<?> valueType;
+
+
+ protected PropertyDescriptorBuilderConversionWrapper(Class<?> valueType) {
+ this.valueType = valueType;
+ }
+
+
+ /** Populates the builder with extracted fields. To be overridden. */
+ protected void populate(T builder, Map<PropertyDescriptorField, String> fields) {
+ builder.desc(fields.get(PropertyDescriptorField.DESCRIPTION));
+ if (fields.containsKey(PropertyDescriptorField.UI_ORDER)) {
+ builder.uiOrder(Float.parseFloat(fields.get(PropertyDescriptorField.UI_ORDER)));
+ }
+ }
+
+
+ @Override
+ public abstract boolean isMultiValue();
+
+
+ @Override
+ public Class<?> valueType() {
+ return valueType;
+ }
+
+
+ protected abstract T newBuilder(String name); // FUTURE 1.8: use a Supplier constructor parameter
+
+
+ @Override
+ public PropertyDescriptor<E> build(Map<PropertyDescriptorField, String> fields) {
+ T builder = newBuilder(fields.get(PropertyDescriptorField.NAME));
+ populate(builder, fields);
+ builder.isDefinedInXML = true;
+ return builder.build();
+ }
+
+
+ protected static String[] legalPackageNamesIn(Map<PropertyDescriptorField, String> valuesById, char delimiter) {
+ String names = valuesById.get(LEGAL_PACKAGES);
+ return StringUtils.isBlank(names) ? null : StringUtils.split(names, delimiter);
+ }
+
+
+ private static char delimiterIn(Map<PropertyDescriptorField, String> valuesById, char defalt) {
+ String characterStr = "";
+ if (valuesById.containsKey(DELIMITER)) {
+ characterStr = valuesById.get(DELIMITER).trim();
+ }
+
+ if (StringUtils.isBlank(characterStr)) {
+ return defalt;
+ }
+
+ if (characterStr.length() != 1) {
+ throw new RuntimeException("Ambiguous delimiter character, must have length 1: \"" + characterStr + "\"");
+ }
+ return characterStr.charAt(0);
+ }
+
+
+ /**
+ * For multi-value properties.
+ *
+ * @param <V> Element type of the list
+ * @param <T> Concrete type of the underlying builder
+ */
+ public abstract static class MultiValue<V, T extends MultiValuePropertyBuilder<V, T>>
+ extends PropertyDescriptorBuilderConversionWrapper<List<V>, T> {
+
+ protected final ValueParser<V> parser;
+
+
+ protected MultiValue(Class<V> valueType, ValueParser<V> parser) {
+ super(valueType);
+ this.parser = parser;
+ }
+
+
+ @Override
+ protected void populate(T builder, Map<PropertyDescriptorField, String> fields) {
+ super.populate(builder, fields);
+ char delim = delimiterIn(fields, builder.multiValueDelimiter);
+ builder.delim(delim).defaultValues(ValueParserConstants.multi(parser, delim)
+ .valueOf(fields.get(PropertyDescriptorField.DEFAULT_VALUE)));
+ }
+
+
+ @Override
+ public boolean isMultiValue() {
+ return true;
+ }
+
+
+ /**
+ * For multi-value numeric properties.
+ *
+ * @param <V> Element type of the list
+ * @param <T> Concrete type of the underlying builder
+ */
+ public abstract static class Numeric<V, T extends MultiNumericPropertyBuilder<V, T>>
+ extends MultiValue<V, T> {
+
+ protected Numeric(Class<V> valueType, ValueParser<V> parser) {
+ super(valueType, parser);
+ }
+
+
+ @Override
+ protected void populate(T builder, Map<PropertyDescriptorField, String> fields) {
+ super.populate(builder, fields);
+ V min = parser.valueOf(fields.get(PropertyDescriptorField.MIN));
+ V max = parser.valueOf(fields.get(PropertyDescriptorField.MAX));
+ builder.range(min, max);
+ }
+ }
+
+
+ /**
+ * For single-value packaged properties.
+ *
+ * @param <V> Element type of the list
+ * @param <T> Concrete type of the underlying builder
+ */
+ public abstract static class Packaged<V, T extends MultiPackagedPropertyBuilder<V, T>>
+ extends MultiValue<V, T> {
+
+ protected Packaged(Class<V> valueType, ValueParser<V> parser) {
+ super(valueType, parser);
+ }
+
+
+ @Override
+ protected void populate(T builder, Map<PropertyDescriptorField, String> fields) {
+ super.populate(builder, fields);
+ builder.legalPackages(legalPackageNamesIn(fields, PropertyDescriptorBuilderConversionWrapper.delimiterIn(fields,
+ MultiValuePropertyDescriptor.DEFAULT_DELIMITER)));
+ }
+ }
+
+ }
+
+
+ /**
+ * For single-value properties.
+ *
+ * @param <E> Value type of the property
+ * @param <T> Concrete type of the underlying builder
+ */
+ public abstract static class SingleValue<E, T extends SingleValuePropertyBuilder<E, T>>
+ extends PropertyDescriptorBuilderConversionWrapper<E, T> {
+
+ protected final ValueParser<E> parser;
+
+
+ protected SingleValue(Class<E> valueType, ValueParser<E> parser) {
+ super(valueType);
+ this.parser = parser;
+ }
+
+
+ @Override
+ protected void populate(T builder, Map<PropertyDescriptorField, String> fields) {
+ super.populate(builder, fields);
+ builder.defaultValue(parser.valueOf(fields.get(PropertyDescriptorField.DEFAULT_VALUE)));
+ }
+
+
+ @Override
+ public boolean isMultiValue() {
+ return false;
+ }
+
+
+ /**
+ * For single-value numeric properties.
+ *
+ * @param <V> Element type of the list
+ * @param <T> Concrete type of the underlying builder
+ */
+ public abstract static class Numeric<V, T extends SingleNumericPropertyBuilder<V, T>>
+ extends SingleValue<V, T> {
+
+ protected Numeric(Class<V> valueType, ValueParser<V> parser) {
+ super(valueType, parser);
+ }
+
+
+ @Override
+ protected void populate(T builder, Map<PropertyDescriptorField, String> fields) {
+ super.populate(builder, fields);
+ V min = parser.valueOf(fields.get(PropertyDescriptorField.MIN));
+ V max = parser.valueOf(fields.get(PropertyDescriptorField.MAX));
+ builder.range(min, max);
+ }
+ }
+
+
+ /**
+ * For single-value packaged properties.
+ *
+ * @param <E> Element type of the list
+ * @param <T> Concrete type of the underlying builder
+ */
+ public abstract static class Packaged<E, T extends SinglePackagedPropertyBuilder<E, T>>
+ extends SingleValue<E, T> {
+
+ protected Packaged(Class<E> valueType, ValueParser<E> parser) {
+ super(valueType, parser);
+ }
+
+
+ @Override
+ protected void populate(T builder, Map<PropertyDescriptorField, String> fields) {
+ super.populate(builder, fields);
+ builder.legalPackageNames(legalPackageNamesIn(fields, PropertyDescriptorBuilderConversionWrapper.delimiterIn(fields,
+ MultiValuePropertyDescriptor.DEFAULT_DELIMITER)));
+ }
+ }
+
+
+ }
+
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/PropertyDescriptorExternalBuilder.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/PropertyDescriptorExternalBuilder.java
new file mode 100644
index 00000000000..16ded671411
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/PropertyDescriptorExternalBuilder.java
@@ -0,0 +1,48 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.properties.builders;
+
+import java.util.Map;
+
+import net.sourceforge.pmd.properties.PropertyDescriptor;
+import net.sourceforge.pmd.properties.PropertyDescriptorField;
+
+
+/**
+ * Builds properties from a map of key value pairs, eg extracted from an XML element.
+ *
+ * @param <E> The type of values.
+ *
+ * @author Clément Fournier
+ * @since 6.0.0
+ */
+public interface PropertyDescriptorExternalBuilder<E> {
+
+
+ /**
+ * Whether this descriptor is multi-valued.
+ *
+ * @return True if this descriptor is multi-valued
+ */
+ boolean isMultiValue();
+
+
+ /**
+ * Type of the values of the descriptor, or component type if this descriptor is multi-valued.
+ *
+ * @return Type of the values
+ */
+ Class<?> valueType();
+
+
+ /**
+ * Builds a descriptor. The descriptor returned is tagged as built externally.
+ *
+ * @param fields Key value pairs
+ *
+ * @return A builder
+ */
+ PropertyDescriptor<E> build(Map<PropertyDescriptorField, String> fields);
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/SingleNumericPropertyBuilder.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/SingleNumericPropertyBuilder.java
new file mode 100644
index 00000000000..4e4d450aed6
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/SingleNumericPropertyBuilder.java
@@ -0,0 +1,39 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.properties.builders;
+
+/**
+ * @author Clément Fournier
+ * @since 6.0.0
+ */
+public abstract class SingleNumericPropertyBuilder<V, T extends SingleNumericPropertyBuilder<V, T>>
+ extends SingleValuePropertyBuilder<V, T> {
+
+
+ protected V lowerLimit;
+ protected V upperLimit;
+
+
+ public SingleNumericPropertyBuilder(String name) {
+ super(name);
+ }
+
+
+ /**
+ * Specify the range of acceptable values.
+ *
+ * @param min Lower bound
+ * @param max Upper bound
+ *
+ * @return The same builder
+ */
+ @SuppressWarnings("unchecked")
+ public T range(V min, V max) {
+ this.lowerLimit = min;
+ this.upperLimit = max;
+ return (T) this;
+ }
+
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/SinglePackagedPropertyBuilder.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/SinglePackagedPropertyBuilder.java
new file mode 100644
index 00000000000..2f7219d14c3
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/SinglePackagedPropertyBuilder.java
@@ -0,0 +1,57 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.properties.builders;
+
+import java.util.Arrays;
+import java.util.Collection;
+
+
+/**
+ * @author Clément Fournier
+ * @since 6.0.0
+ */
+public abstract class SinglePackagedPropertyBuilder<V, T extends SinglePackagedPropertyBuilder<V, T>>
+ extends SingleValuePropertyBuilder<V, T> {
+
+ protected String[] legalPackageNames;
+
+
+ public SinglePackagedPropertyBuilder(String name) {
+ super(name);
+ }
+
+
+ /**
+ * Specify the allowed package prefixes.
+ *
+ * @param packs The package prefixes
+ *
+ * @return The same builder
+ */
+ @SuppressWarnings("unchecked")
+ public T legalPackageNames(String... packs) {
+ if (packs != null) {
+ this.legalPackageNames = Arrays.copyOf(packs, packs.length);
+ }
+ return (T) this;
+ }
+
+
+ /**
+ * Specify the allowed package prefixes.
+ *
+ * @param packs The package prefixes
+ *
+ * @return The same builder
+ */
+ @SuppressWarnings("unchecked")
+ public T legalPackageNames(Collection<String> packs) {
+ if (packs != null) {
+ this.legalPackageNames = packs.toArray(new String[0]);
+ }
+ return (T) this;
+ }
+
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/SingleValuePropertyBuilder.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/SingleValuePropertyBuilder.java
new file mode 100644
index 00000000000..4c8edbf11bb
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/builders/SingleValuePropertyBuilder.java
@@ -0,0 +1,38 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.properties.builders;
+
+/**
+ * For single-value property descriptors.
+ *
+ * @param <E> Value type of the built descriptor
+ * @param <T> Concrete type of this builder instance.
+ */
+public abstract class SingleValuePropertyBuilder<E, T extends SingleValuePropertyBuilder<E, T>>
+ extends PropertyDescriptorBuilder<E, T> {
+
+ protected E defaultValue;
+
+
+ protected SingleValuePropertyBuilder(String name) {
+ super(name);
+ }
+
+
+ /**
+ * Specify a default value.
+ *
+ * @param val Value
+ *
+ * @return The same builder
+ */
+ @SuppressWarnings("unchecked")
+ public T defaultValue(E val) {
+ this.defaultValue = val;
+ return (T) this;
+ }
+
+
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/modules/EnumeratedPropertyModule.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/modules/EnumeratedPropertyModule.java
index f1c7d8afe3e..ff78fa232bf 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/modules/EnumeratedPropertyModule.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/modules/EnumeratedPropertyModule.java
@@ -9,6 +9,7 @@
import net.sourceforge.pmd.util.CollectionUtil;
+
/**
* Factorises common functionality for enumerated properties.
*
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/modules/MethodPropertyModule.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/modules/MethodPropertyModule.java
index 2dbd0afe6ff..c2b1019055a 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/modules/MethodPropertyModule.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/modules/MethodPropertyModule.java
@@ -10,6 +10,7 @@
import net.sourceforge.pmd.util.ClassUtil;
+
/**
* Factorises common functionality for method properties.
*
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/modules/NumericPropertyModule.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/modules/NumericPropertyModule.java
index 46c5455738d..e37286f9a11 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/modules/NumericPropertyModule.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/modules/NumericPropertyModule.java
@@ -11,6 +11,7 @@
import net.sourceforge.pmd.properties.PropertyDescriptorField;
+
/**
* Common utilities for implementations of numeric property descriptors.
*
@@ -32,12 +33,10 @@ public NumericPropertyModule(T lowerLimit, T upperLimit) {
if (lowerLimit.doubleValue() > upperLimit.doubleValue()) {
throw new IllegalArgumentException("Lower limit cannot be greater than the upper limit");
}
-
-
}
- private void checkNumber(T number) {
+ public void checkNumber(T number) {
String error = valueErrorFor(number);
if (error != null) {
throw new IllegalArgumentException(error);
@@ -61,19 +60,6 @@ public String valueErrorFor(T value) {
}
- /**
- * Returns a string representing the range defined by the two bounds.
- *
- * @param low Lower bound
- * @param up Upper bound
- *
- * @return String
- */
- private static String rangeString(Number low, Number up) {
- return "(" + low + " -> " + up + ")";
- }
-
-
public T getLowerLimit() {
return lowerLimit;
}
@@ -90,4 +76,17 @@ public void addAttributesTo(Map<PropertyDescriptorField, String> attributes) {
}
+ /**
+ * Returns a string representing the range defined by the two bounds.
+ *
+ * @param low Lower bound
+ * @param up Upper bound
+ *
+ * @return String
+ */
+ private static String rangeString(Number low, Number up) {
+ return "(" + low + " -> " + up + ")";
+ }
+
+
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/modules/PackagedPropertyModule.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/modules/PackagedPropertyModule.java
index 06bf77db145..a9c29a0ea6a 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/modules/PackagedPropertyModule.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/modules/PackagedPropertyModule.java
@@ -18,6 +18,7 @@
import net.sourceforge.pmd.properties.PropertyDescriptorField;
+
/**
* Factorises common functionality for packaged properties.
*
@@ -55,7 +56,7 @@ private void checkValidPackages(String[] legalNamePrefixes) throws IllegalArgume
for (String name : legalNamePrefixes) {
if (name == null) {
throw new IllegalArgumentException("Null is not allowed in the legal package names:"
- + Arrays.toString(legalNamePrefixes));
+ + Arrays.toString(legalNamePrefixes));
} else if (!PACKAGE_NAME_PATTERN.matcher(name).matches()) {
throw new IllegalArgumentException("One name is not a package: '" + name + "'");
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/properties/modules/TypePropertyModule.java b/pmd-core/src/main/java/net/sourceforge/pmd/properties/modules/TypePropertyModule.java
index 0758b86c20e..183357552ea 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/properties/modules/TypePropertyModule.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/properties/modules/TypePropertyModule.java
@@ -6,6 +6,7 @@
import java.util.List;
+
/**
* Factorises common functionality for type properties.
*
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/AbstractAccumulatingRenderer.java b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/AbstractAccumulatingRenderer.java
index b12e0803b4e..5ffb4e8fd56 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/AbstractAccumulatingRenderer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/AbstractAccumulatingRenderer.java
@@ -32,24 +32,16 @@ public AbstractAccumulatingRenderer(String name, String description) {
super(name, description);
}
- /**
- * {@inheritDoc}
- */
@Override
public void start() throws IOException {
report = new Report();
}
- /**
- * {@inheritDoc}
- */
@Override
public void startFileAnalysis(DataSource dataSource) {
+ // does nothing - override if necessary
}
- /**
- * {@inheritDoc}
- */
@Override
public void renderFileReport(Report report) throws IOException {
this.report.merge(report);
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/AbstractIncrementingRenderer.java b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/AbstractIncrementingRenderer.java
index c3dd54918f4..6e60d9d1198 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/AbstractIncrementingRenderer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/AbstractIncrementingRenderer.java
@@ -45,23 +45,16 @@ public AbstractIncrementingRenderer(String name, String description) {
super(name, description);
}
- /**
- * {@inheritDoc}
- */
@Override
public void start() throws IOException {
+ // does nothing - override if necessary
}
- /**
- * {@inheritDoc}
- */
@Override
public void startFileAnalysis(DataSource dataSource) {
+ // does nothing - override if necessary
}
- /**
- * {@inheritDoc}
- */
@Override
public void renderFileReport(Report report) throws IOException {
Iterator<RuleViolation> violations = report.iterator();
@@ -92,10 +85,8 @@ public void renderFileReport(Report report) throws IOException {
*/
public abstract void renderFileViolations(Iterator<RuleViolation> violations) throws IOException;
- /**
- * {@inheritDoc}
- */
@Override
public void end() throws IOException {
+ // does nothing - override if necessary
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/AbstractRenderer.java b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/AbstractRenderer.java
index 965f0e3ccbc..33a76124950 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/AbstractRenderer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/AbstractRenderer.java
@@ -27,65 +27,46 @@ public AbstractRenderer(String name, String description) {
this.description = description;
}
- /**
- * {@inheritDoc}
- */
+ @Override
+ protected String getPropertySourceType() {
+ return "renderer";
+ }
+
@Override
public String getName() {
return name;
}
- /**
- * {@inheritDoc}
- */
@Override
public void setName(String name) {
this.name = name;
}
- /**
- * {@inheritDoc}
- */
@Override
public String getDescription() {
return description;
}
- /**
- * {@inheritDoc}
- */
@Override
public void setDescription(String description) {
this.description = description;
}
- /**
- * {@inheritDoc}
- */
@Override
public boolean isShowSuppressedViolations() {
return showSuppressedViolations;
}
- /**
- * {@inheritDoc}
- */
@Override
public void setShowSuppressedViolations(boolean showSuppressedViolations) {
this.showSuppressedViolations = showSuppressedViolations;
}
- /**
- * {@inheritDoc}
- */
@Override
public void setWriter(Writer writer) {
this.writer = writer;
}
- /**
- * {@inheritDoc}
- */
@Override
public Writer getWriter() {
return writer;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/CSVRenderer.java b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/CSVRenderer.java
index 5dcf3de6914..8c3ef261c2c 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/CSVRenderer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/CSVRenderer.java
@@ -132,9 +132,6 @@ private CSVWriter<RuleViolation> csvWriter() {
return csvWriter;
}
- /**
- * {@inheritDoc}
- */
@Override
public void start() throws IOException {
csvWriter().writeTitles(getWriter());
@@ -145,9 +142,6 @@ public String defaultFileExtension() {
return "csv";
}
- /**
- * {@inheritDoc}
- */
@Override
public void renderFileViolations(Iterator<RuleViolation> violations) throws IOException {
csvWriter().writeData(getWriter(), violations);
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/CodeClimateIssue.java b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/CodeClimateIssue.java
index aec04f9ab15..7d66f5ba0d4 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/CodeClimateIssue.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/CodeClimateIssue.java
@@ -11,7 +11,7 @@
* (https://github.com/codeclimate/spec/blob/master/SPEC.md#issues)
*/
public class CodeClimateIssue {
- public final String type = "issue";
+ public String type;
public String check_name; // SUPPRESS CHECKSTYLE underscore is required per codeclimate format
public String description;
public Content content;
@@ -20,6 +20,10 @@ public class CodeClimateIssue {
public String severity;
public int remediation_points; // SUPPRESS CHECKSTYLE underscore is required per codeclimate format
+ public CodeClimateIssue() {
+ type = "issue"; // the default type for PMD violations when reporting as code climate
+ }
+
/**
* Location structure
*/
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/CodeClimateRenderer.java b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/CodeClimateRenderer.java
index 7765310c80e..ba7675e504b 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/CodeClimateRenderer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/CodeClimateRenderer.java
@@ -17,6 +17,7 @@
import org.apache.commons.lang3.StringUtils;
import net.sourceforge.pmd.PMD;
+import net.sourceforge.pmd.PMDVersion;
import net.sourceforge.pmd.Rule;
import net.sourceforge.pmd.RuleViolation;
import net.sourceforge.pmd.properties.PropertyDescriptor;
@@ -35,25 +36,22 @@ public class CodeClimateRenderer extends AbstractIncrementingRenderer {
// Note: required by https://github.com/codeclimate/spec/blob/master/SPEC.md
protected static final String NULL_CHARACTER = "\u0000";
- private final String pmdDeveloperUrl;
+ protected static final List<String> INTERNAL_DEV_PROPERTIES = Arrays.asList("version", "xpath");
+ private static final String PMD_PROPERTIES_URL = getPmdPropertiesURL();
private Rule rule;
public CodeClimateRenderer() {
super(NAME, "Code Climate integration.");
- pmdDeveloperUrl = getPmdDeveloperURL();
}
- private static String getPmdDeveloperURL() {
- String url = "http://pmd.github.io/pmd-" + PMD.VERSION + "/customizing/pmd-developer.html";
- if (PMD.VERSION.contains("SNAPSHOT") || "unknown".equals(PMD.VERSION)) {
- url = "http://pmd.sourceforge.net/snapshot/customizing/pmd-developer.html";
+ private static String getPmdPropertiesURL() {
+ String url = "https://pmd.github.io/pmd-" + PMDVersion.VERSION + "/pmd_devdocs_working_with_properties.html";
+ if (PMDVersion.isSnapshot() || PMDVersion.isUnknown()) {
+ url = "https://pmd.github.io/latest/pmd_devdocs_working_with_properties.html";
}
return url;
}
- /**
- * {@inheritDoc}
- */
@Override
public void renderFileViolations(Iterator<RuleViolation> violations) throws IOException {
Writer writer = getWriter();
@@ -165,11 +163,16 @@ private <T> String getBody() {
}
if (!rule.getPropertyDescriptors().isEmpty()) {
- result += "\\n\\n### [PMD properties](" + pmdDeveloperUrl + ")\\n\\n";
+ result += "\\n\\n### [PMD properties](" + PMD_PROPERTIES_URL + ")\\n\\n";
result += "Name | Value | Description\\n";
result += "--- | --- | ---\\n";
for (PropertyDescriptor<?> property : rule.getPropertyDescriptors()) {
+ String propertyName = property.name().replaceAll("\\_", "\\\\_");
+ if (INTERNAL_DEV_PROPERTIES.contains(propertyName)) {
+ continue;
+ }
+
@SuppressWarnings("unchecked")
PropertyDescriptor<T> typed = (PropertyDescriptor<T>) property;
T value = rule.getProperty(typed);
@@ -179,10 +182,7 @@ private <T> String getBody() {
}
propertyValue = propertyValue.replaceAll("(\n|\r\n|\r)", "\\\\n");
- String porpertyName = property.name();
- porpertyName = porpertyName.replaceAll("\\_", "\\\\_");
-
- result += porpertyName + " | " + propertyValue + " | " + property.description() + "\\n";
+ result += propertyName + " | " + propertyValue + " | " + property.description() + "\\n";
}
}
return cleaned(result);
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/EmacsRenderer.java b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/EmacsRenderer.java
index 388b1565b35..3a00d2161ed 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/EmacsRenderer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/EmacsRenderer.java
@@ -28,9 +28,6 @@ public String defaultFileExtension() {
return "emacs";
}
- /**
- * {@inheritDoc}
- */
@Override
public void renderFileViolations(Iterator<RuleViolation> violations) throws IOException {
Writer writer = getWriter();
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/EmptyRenderer.java b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/EmptyRenderer.java
index 5a2c60b16f9..bf1207f7e12 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/EmptyRenderer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/EmptyRenderer.java
@@ -26,17 +26,21 @@ public String defaultFileExtension() {
@Override
public void start() throws IOException {
+ // deliberately does nothing
}
@Override
public void startFileAnalysis(DataSource dataSource) {
+ // deliberately does nothing
}
@Override
public void renderFileReport(Report report) throws IOException {
+ // deliberately does nothing
}
@Override
public void end() throws IOException {
+ // deliberately does nothing
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/HTMLRenderer.java b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/HTMLRenderer.java
index 3733396f127..ecebba5dd5e 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/HTMLRenderer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/HTMLRenderer.java
@@ -75,9 +75,6 @@ public void renderBody(Writer writer, Report report) throws IOException {
glomConfigurationErrors(writer, configErrors);
}
- /**
- * {@inheritDoc}
- */
@Override
public void start() throws IOException {
Writer writer = getWriter();
@@ -88,18 +85,12 @@ public void start() throws IOException {
+ "<th>#</th><th>File</th><th>Line</th><th>Problem</th></tr>" + PMD.EOL);
}
- /**
- * {@inheritDoc}
- */
@Override
public void renderFileViolations(Iterator<RuleViolation> violations) throws IOException {
Writer writer = getWriter();
glomRuleViolations(writer, violations);
}
- /**
- * {@inheritDoc}
- */
@Override
public void end() throws IOException {
Writer writer = getWriter();
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/IDEAJRenderer.java b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/IDEAJRenderer.java
index 96563962b6e..f6cddabd647 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/IDEAJRenderer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/IDEAJRenderer.java
@@ -45,9 +45,6 @@ public String defaultFileExtension() {
return "txt";
}
- /**
- * {@inheritDoc}
- */
@Override
public void renderFileViolations(Iterator<RuleViolation> violations) throws IOException {
classAndMethodName = getProperty(CLASS_AND_METHOD_NAME);
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/Renderer.java b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/Renderer.java
index 4e82bb43dc8..c033f26f5b9 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/Renderer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/Renderer.java
@@ -40,6 +40,7 @@ public interface Renderer extends PropertySource {
*
* @return The name of the Renderer.
*/
+ @Override
String getName();
/**
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/RendererFactory.java b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/RendererFactory.java
index cee09d0118a..48631ab33f9 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/RendererFactory.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/RendererFactory.java
@@ -21,7 +21,7 @@
*
* @see Renderer
*/
-public class RendererFactory {
+public final class RendererFactory {
private static final Logger LOG = Logger.getLogger(RendererFactory.class.getName());
@@ -129,8 +129,8 @@ private static Constructor<? extends Renderer> getRendererConstructor(Class<? ex
if (!Modifier.isPublic(constructor.getModifiers())) {
constructor = null;
}
- } catch (NoSuchMethodException e) {
- // Ok
+ } catch (NoSuchMethodException ignored) {
+ // Ignored, we'll check default constructor next
}
// 2) No-arg constructor?
@@ -139,8 +139,8 @@ private static Constructor<? extends Renderer> getRendererConstructor(Class<? ex
if (!Modifier.isPublic(constructor.getModifiers())) {
constructor = null;
}
- } catch (NoSuchMethodException e2) {
- // Ok
+ } catch (NoSuchMethodException ignored) {
+ // Ignored, we'll eventually throw an exception, if there is no constructor
}
if (constructor == null) {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/SummaryHTMLRenderer.java b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/SummaryHTMLRenderer.java
index 38340759cb8..0b5c907a7d4 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/SummaryHTMLRenderer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/SummaryHTMLRenderer.java
@@ -31,9 +31,6 @@ public String defaultFileExtension() {
return "html";
}
- /**
- * {@inheritDoc}
- */
@Override
public void end() throws IOException {
writer.write("<html><head><title>PMD " + PMD.EOL);
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/TextColorRenderer.java b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/TextColorRenderer.java
index f3002017cdb..f28df9dab36 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/TextColorRenderer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/TextColorRenderer.java
@@ -13,8 +13,6 @@
import java.util.Iterator;
import java.util.Map;
-import org.apache.commons.io.IOUtils;
-
import net.sourceforge.pmd.PMD;
import net.sourceforge.pmd.Report;
import net.sourceforge.pmd.RuleViolation;
@@ -109,9 +107,6 @@ private boolean isPropertyEnabled(String property) {
return property != null && !("0".equals(property) || "false".equalsIgnoreCase(property));
}
- /**
- * {@inheritDoc}
- */
@Override
public void end() throws IOException {
StringBuilder buf = new StringBuilder(500);
@@ -194,17 +189,13 @@ public void end() throws IOException {
*/
private String getLine(String sourceFile, int line) {
String code = null;
- BufferedReader br = null;
- try {
- br = new BufferedReader(getReader(sourceFile));
+ try (BufferedReader br = new BufferedReader(getReader(sourceFile))) {
for (int i = 0; line > i; i++) {
String txt = br.readLine();
code = txt == null ? "" : txt.trim();
}
} catch (IOException ioErr) {
ioErr.printStackTrace();
- } finally {
- IOUtils.closeQuietly(br);
}
return code;
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/TextPadRenderer.java b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/TextPadRenderer.java
index 79843a2dc7b..ad6f51f4319 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/TextPadRenderer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/TextPadRenderer.java
@@ -49,9 +49,6 @@ public String defaultFileExtension() {
return "txt";
}
- /**
- * {@inheritDoc}
- */
@Override
public void renderFileViolations(Iterator violations) throws IOException {
Writer writer = getWriter();
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/TextRenderer.java b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/TextRenderer.java
index 372d013092c..aaf03fdb115 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/TextRenderer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/TextRenderer.java
@@ -28,16 +28,6 @@ public String defaultFileExtension() {
return "txt";
}
- /**
- * {@inheritDoc}
- */
- @Override
- public void start() throws IOException {
- }
-
- /**
- * {@inheritDoc}
- */
@Override
public void renderFileViolations(Iterator violations) throws IOException {
Writer writer = getWriter();
@@ -53,9 +43,6 @@ public void renderFileViolations(Iterator violations) throws IOEx
}
}
- /**
- * {@inheritDoc}
- */
@Override
public void end() throws IOException {
Writer writer = getWriter();
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/VBHTMLRenderer.java b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/VBHTMLRenderer.java
index 2af6da261a0..3c944a331ae 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/VBHTMLRenderer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/VBHTMLRenderer.java
@@ -30,17 +30,11 @@ public String defaultFileExtension() {
return "vb.html";
}
- /**
- * {@inheritDoc}
- */
@Override
public void start() throws IOException {
getWriter().write(header());
}
- /**
- * {@inheritDoc}
- */
@Override
public void renderFileViolations(Iterator violations) throws IOException {
if (!violations.hasNext()) {
@@ -87,9 +81,6 @@ public void renderFileViolations(Iterator violations) throws IOEx
}
}
- /**
- * {@inheritDoc}
- */
@Override
public void end() throws IOException {
Writer writer = getWriter();
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/XMLRenderer.java b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/XMLRenderer.java
index 7dd7de67687..52495551701 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/renderers/XMLRenderer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/renderers/XMLRenderer.java
@@ -11,6 +11,7 @@
import java.util.Iterator;
import net.sourceforge.pmd.PMD;
+import net.sourceforge.pmd.PMDVersion;
import net.sourceforge.pmd.Report;
import net.sourceforge.pmd.RuleViolation;
import net.sourceforge.pmd.properties.StringProperty;
@@ -42,9 +43,6 @@ public String defaultFileExtension() {
return "xml";
}
- /**
- * {@inheritDoc}
- */
@Override
public void start() throws IOException {
String encoding = getProperty(ENCODING);
@@ -63,9 +61,6 @@ public void start() throws IOException {
writer.write(buf.toString());
}
- /**
- * {@inheritDoc}
- */
@Override
public void renderFileViolations(Iterator violations) throws IOException {
Writer writer = getWriter();
@@ -118,9 +113,6 @@ public void renderFileViolations(Iterator violations) throws IOEx
}
}
- /**
- * {@inheritDoc}
- */
@Override
public void end() throws IOException {
Writer writer = getWriter();
@@ -181,7 +173,7 @@ private void createVersionAttr(StringBuilder buffer) {
buffer.append(" reportNodesByPackage = new TreeMap<>();
+
public YAHTMLRenderer() {
// YA = Yet Another?
super(NAME, "Yet Another HTML format.");
@@ -31,15 +41,211 @@ public String defaultFileExtension() {
return "html";
}
- /**
- * {@inheritDoc}
- */
+ private void addViolation(RuleViolation violation) {
+ String packageName = violation.getPackageName();
+
+ // report each part of the package name: e.g. net.sf.pmd.test will create nodes for
+ // net, net.sf, net.sf.pmd, and net.sf.pmd.test
+ int index = packageName.indexOf('.', 0);
+ while (index > -1) {
+ String currentPackage = packageName.substring(0, index);
+ ReportNode reportNode = reportNodesByPackage.get(currentPackage);
+ if (reportNode == null) {
+ reportNode = new ReportNode(currentPackage);
+ reportNodesByPackage.put(currentPackage, reportNode);
+ }
+ reportNode.incrementViolations();
+
+ int oldIndex = index;
+ index = packageName.indexOf('.', index + 1);
+ if (index == -1 && oldIndex != packageName.length()) {
+ index = packageName.length();
+ }
+ }
+
+ // add one node per class collecting the actual violations
+ String fqClassName = packageName + "." + violation.getClassName();
+ ReportNode classNode = reportNodesByPackage.get(fqClassName);
+ if (classNode == null) {
+ classNode = new ReportNode(packageName, violation.getClassName());
+ reportNodesByPackage.put(fqClassName, classNode);
+ }
+ classNode.addRuleViolation(violation);
+
+ // count the overall violations in the root node
+ ReportNode rootNode = reportNodesByPackage.get(ReportNode.ROOT_NODE_NAME);
+ if (rootNode == null) {
+ rootNode = new ReportNode("Aggregate");
+ reportNodesByPackage.put(ReportNode.ROOT_NODE_NAME, rootNode);
+ }
+ rootNode.incrementViolations();
+ }
+
@Override
public void end() throws IOException {
String outputDir = getProperty(OUTPUT_DIR);
- ReportTree tree = report.getViolationTree();
- tree.getRootNode().accept(new ReportHTMLPrintVisitor(outputDir == null ? ".." : outputDir));
+
+ Iterator violations = report.iterator();
+ while (violations.hasNext()) {
+ addViolation(violations.next());
+ }
+
+ renderIndex(outputDir);
+ renderClasses(outputDir);
+
writer.write("The HTML files are located "
+ (outputDir == null ? "above the project directory" : "in '" + outputDir + '\'') + ".
" + PMD.EOL);
}
+
+ private void renderIndex(String outputDir) throws IOException {
+ try (PrintWriter out = new PrintWriter(new FileWriter(new File(outputDir, "index.html")))) {
+ out.println("");
+ out.println(" ");
+ out.println(" PMD ");
+ out.println(" ");
+ out.println(" ");
+ out.println(" Package View
");
+ out.println(" ");
+ out.println(" Package Class # ");
+ out.print(node.getPackageName());
+ out.print(" ");
+ if (node.hasViolations()) {
+ out.print("");
+ out.print(node.getClassName());
+ out.print("");
+ } else {
+ out.print(node.getClassName());
+ }
+ out.print(" ");
+ out.print(node.getViolationCount());
+ out.print("
");
+ out.println(" ");
+ out.println("");
+ }
+ }
+
+ private void renderClasses(String outputDir) throws IOException {
+ for (ReportNode node : reportNodesByPackage.values()) {
+ if (node.hasViolations()) {
+ try (PrintWriter out = new PrintWriter(new FileWriter(new File(outputDir, node.getClassName() + ".html")))) {
+ out.println("");
+ out.println(" ");
+ out.print(" PMD - ");
+ out.print(node.getClassName());
+ out.println(" ");
+ out.println(" ");
+ out.println(" ");
+ out.println(" Class View
");
+ out.print(" Class: ");
+ out.print(node.getClassName());
+ out.println("
");
+ out.println(" ");
+ out.println(" Method Violation ");
+ out.print(violation.getMethodName());
+ out.print(" ");
+ out.print("");
+
+ out.print(renderViolationRow("Rule:", violation.getRule().getName()));
+ out.print(renderViolationRow("Description:", violation.getDescription()));
+
+ if (StringUtils.isNotBlank(violation.getVariableName())) {
+ out.print(renderViolationRow("Variable:", violation.getVariableName()));
+ }
+
+ out.print(renderViolationRow("Line:", violation.getEndLine() > 0
+ ? violation.getBeginLine() + " and " + violation.getEndLine()
+ : String.valueOf(violation.getBeginLine())));
+
+ out.print("
");
+
+ out.print("
");
+ out.println(" ");
+ out.println("");
+ }
+ }
+ }
+ }
+
+ private String renderViolationRow(String name, String value) {
+ StringBuilder row = new StringBuilder(40 + name.length() + value.length());
+ row.append("")
+ .append(name)
+ .append(" ")
+ .append("")
+ .append(value)
+ .append(" ";
+
+ private final String packageName;
+ private final String className;
+ private int violationCount;
+ private final List violations = new LinkedList<>();
+
+ ReportNode(String packageName) {
+ this.packageName = packageName;
+ this.className = "-";
+ }
+
+ ReportNode(String packageName, String className) {
+ this.packageName = packageName;
+ this.className = className;
+ }
+
+ public void incrementViolations() {
+ violationCount++;
+ }
+
+ public void addRuleViolation(RuleViolation violation) {
+ violations.add(violation);
+ }
+
+ public String getPackageName() {
+ return packageName;
+ }
+
+ public String getClassName() {
+ return className;
+ }
+
+ public int getViolationCount() {
+ return violationCount + violations.size();
+ }
+
+ public List getViolations() {
+ return violations;
+ }
+
+ public boolean hasViolations() {
+ return !violations.isEmpty();
+ }
+
+ @Override
+ public String toString() {
+ return "ReportNode[packageName=" + packageName
+ + ",className=" + className
+ + ",violationCount=" + violationCount
+ + ",violations=" + violations.size()
+ + "]";
+ }
+ }
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/rules/RuleBuilder.java b/pmd-core/src/main/java/net/sourceforge/pmd/rules/RuleBuilder.java
new file mode 100644
index 00000000000..15d4bbc6355
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/rules/RuleBuilder.java
@@ -0,0 +1,219 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.rules;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.apache.commons.lang3.StringUtils;
+import org.w3c.dom.Element;
+
+import net.sourceforge.pmd.Rule;
+import net.sourceforge.pmd.RulePriority;
+import net.sourceforge.pmd.RuleSetReference;
+import net.sourceforge.pmd.lang.Language;
+import net.sourceforge.pmd.lang.LanguageRegistry;
+import net.sourceforge.pmd.lang.LanguageVersion;
+import net.sourceforge.pmd.properties.PropertyDescriptor;
+
+
+/**
+ * Builds a rule, validating its parameters throughout. The builder can define property descriptors, but not override
+ * them. For that, use {@link RuleFactory#decorateRule(Rule, RuleSetReference, Element)}.
+ *
+ * @author Clément Fournier
+ * @since 6.0.0
+ */
+public class RuleBuilder {
+
+ private List> definedProperties = new ArrayList<>();
+ private String name;
+ private String clazz;
+ private Language language;
+ private String minimumVersion;
+ private String maximumVersion;
+ private String since;
+ private String message;
+ private String externalInfoUrl;
+ private String description;
+ private List examples = new ArrayList<>(1);
+ private RulePriority priority;
+ private boolean isDeprecated;
+ private boolean isUsesDfa;
+ private boolean isUsesMultifile;
+ private boolean isUsesTyperesolution;
+
+ public RuleBuilder(String name, String clazz, String language) {
+ this.name = name;
+ language(language);
+ className(clazz);
+ }
+
+ public void usesDFA(boolean usesDFA) {
+ isUsesDfa = usesDFA;
+ }
+
+ public void usesMultifile(boolean usesMultifile) {
+ isUsesMultifile = usesMultifile;
+ }
+
+ public void usesTyperesolution(boolean usesTyperesolution) {
+ isUsesTyperesolution = usesTyperesolution;
+ }
+
+ private void language(String languageName) {
+ if (StringUtils.isBlank(languageName)) {
+ // Some languages don't need the attribute because the rule's
+ // constructor calls setLanguage, see e.g. AbstractJavaRule
+ return;
+ }
+
+ Language lang = LanguageRegistry.findLanguageByTerseName(languageName);
+ if (lang == null) {
+ throw new IllegalArgumentException(
+ "Unknown Language '" + languageName + "' for rule" + name + ", supported Languages are "
+ + LanguageRegistry.commaSeparatedTerseNamesForLanguage(LanguageRegistry.findWithRuleSupport()));
+ }
+ language = lang;
+ }
+
+ private void className(String className) {
+ if (StringUtils.isBlank(className)) {
+ throw new IllegalArgumentException("The 'class' field of rule can't be null, nor empty.");
+ }
+
+ this.clazz = className;
+ }
+
+ public void minimumLanguageVersion(String minimum) {
+ minimumVersion = minimum;
+ }
+
+ public void maximumLanguageVersion(String maximum) {
+ maximumVersion = maximum;
+ }
+
+ private void checkLanguageVersionsAreOrdered(Rule rule) {
+ if (rule.getMinimumLanguageVersion() != null && rule.getMaximumLanguageVersion() != null
+ && rule.getMinimumLanguageVersion().compareTo(rule.getMaximumLanguageVersion()) > 0) {
+ throw new IllegalArgumentException(
+ "The minimum Language Version '" + rule.getMinimumLanguageVersion().getTerseName()
+ + "' must be prior to the maximum Language Version '"
+ + rule.getMaximumLanguageVersion().getTerseName() + "' for Rule '" + name
+ + "'; perhaps swap them around?");
+ }
+ }
+
+ public void since(String sinceStr) {
+ if (StringUtils.isNotBlank(sinceStr)) {
+ since = sinceStr;
+ }
+ }
+
+ public void externalInfoUrl(String externalInfoUrl) {
+ this.externalInfoUrl = externalInfoUrl;
+ }
+
+ public void message(String message) {
+ this.message = message;
+ }
+
+ public void defineProperty(PropertyDescriptor descriptor) {
+ definedProperties.add(descriptor);
+ }
+
+
+ public void setDeprecated(boolean deprecated) {
+ isDeprecated = deprecated;
+ }
+
+
+ public void description(String description) {
+ this.description = description;
+ }
+
+
+ public void addExample(String example) {
+ examples.add(example);
+ }
+
+
+ public void priority(int priorityString) {
+ this.priority = RulePriority.valueOf(priorityString);
+ }
+
+ // Must be loaded after rule construction to know the Language
+ private void loadLanguageMinMaxVersions(Rule rule) {
+
+ if (minimumVersion != null) {
+ LanguageVersion minimumLanguageVersion = rule.getLanguage().getVersion(minimumVersion);
+ if (minimumLanguageVersion == null) {
+ throwUnknownLanguageVersionException("minimum", minimumVersion);
+ } else {
+ rule.setMinimumLanguageVersion(minimumLanguageVersion);
+ }
+ }
+
+ if (maximumVersion != null) {
+ LanguageVersion maximumLanguageVersion = rule.getLanguage().getVersion(maximumVersion);
+ if (maximumLanguageVersion == null) {
+ throwUnknownLanguageVersionException("maximum", maximumVersion);
+ } else {
+ rule.setMaximumLanguageVersion(maximumLanguageVersion);
+ }
+ }
+
+ checkLanguageVersionsAreOrdered(rule);
+ }
+
+ private void throwUnknownLanguageVersionException(String minOrMax, String unknownVersion) {
+ throw new IllegalArgumentException("Unknown " + minOrMax + " Language Version '" + unknownVersion
+ + "' for Language '" + language.getTerseName()
+ + "' for Rule " + name
+ + "; supported Language Versions are: "
+ + LanguageRegistry.commaSeparatedTerseNamesForLanguageVersion(language.getVersions()));
+ }
+
+ public Rule build() throws ClassNotFoundException, IllegalAccessException, InstantiationException {
+ Rule rule = (Rule) RuleBuilder.class.getClassLoader().loadClass(clazz).newInstance();
+
+ rule.setName(name);
+ rule.setRuleClass(clazz);
+
+ if (rule.getLanguage() == null) {
+ rule.setLanguage(language);
+ }
+
+ loadLanguageMinMaxVersions(rule);
+ rule.setSince(since);
+ rule.setMessage(message);
+ rule.setExternalInfoUrl(externalInfoUrl);
+ rule.setDeprecated(isDeprecated);
+ rule.setDescription(description);
+ rule.setPriority(priority == null ? RulePriority.LOW : priority);
+
+ for (String example : examples) {
+ rule.addExample(example);
+ }
+
+ if (isUsesDfa) {
+ rule.setDfa(isUsesDfa);
+ }
+ if (isUsesMultifile) {
+ rule.setMultifile(isUsesMultifile);
+ }
+ if (isUsesTyperesolution) {
+ rule.setTypeResolution(isUsesTyperesolution);
+ }
+
+ for (PropertyDescriptor descriptor : definedProperties) {
+ if (!rule.getPropertyDescriptors().contains(descriptor)) {
+ rule.definePropertyDescriptor(descriptor);
+ }
+ }
+
+ return rule;
+ }
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/rules/RuleFactory.java b/pmd-core/src/main/java/net/sourceforge/pmd/rules/RuleFactory.java
new file mode 100644
index 00000000000..65eeee6283b
--- /dev/null
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/rules/RuleFactory.java
@@ -0,0 +1,381 @@
+/**
+ * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
+ */
+
+package net.sourceforge.pmd.rules;
+
+import static net.sourceforge.pmd.properties.PropertyDescriptorField.DEFAULT_VALUE;
+
+import java.util.AbstractMap.SimpleEntry;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Map.Entry;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+import org.apache.commons.lang3.StringUtils;
+import org.w3c.dom.Attr;
+import org.w3c.dom.Element;
+import org.w3c.dom.NamedNodeMap;
+import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
+
+import net.sourceforge.pmd.Rule;
+import net.sourceforge.pmd.RulePriority;
+import net.sourceforge.pmd.RuleSetReference;
+import net.sourceforge.pmd.lang.rule.RuleReference;
+import net.sourceforge.pmd.properties.PropertyDescriptor;
+import net.sourceforge.pmd.properties.PropertyDescriptorField;
+import net.sourceforge.pmd.properties.PropertyTypeId;
+import net.sourceforge.pmd.properties.builders.PropertyDescriptorExternalBuilder;
+
+
+/**
+ * Builds rules from rule XML nodes.
+ *
+ * @author Clément Fournier
+ * @since 6.0.0
+ */
+public class RuleFactory {
+
+ private static final Logger LOG = Logger.getLogger(RuleFactory.class.getName());
+
+ private static final String DEPRECATED = "deprecated";
+ private static final String NAME = "name";
+ private static final String MESSAGE = "message";
+ private static final String EXTERNAL_INFO_URL = "externalInfoUrl";
+ private static final String MINIMUM_LANGUAGE_VERSION = "minimumLanguageVersion";
+ private static final String MAXIMUM_LANGUAGE_VERSION = "maximumLanguageVersion";
+ private static final String SINCE = "since";
+ private static final String PROPERTIES = "properties";
+ private static final String PRIORITY = "priority";
+ private static final String EXAMPLE = "example";
+ private static final String DESCRIPTION = "description";
+ private static final String PROPERTY = "property";
+ private static final String CLASS = "class";
+
+ private static final List REQUIRED_ATTRIBUTES = Collections.unmodifiableList(Arrays.asList(NAME, CLASS));
+
+ /**
+ * Decorates a referenced rule with the metadata that are overridden in the given rule element.
+ *
+ * Declaring a property in the overriding element throws an exception (the property must exist in the referenced
+ * rule).
+ *
+ * @param referencedRule Referenced rule
+ * @param ruleSetReference the ruleset, where the referenced rule is defined
+ * @param ruleElement Element overriding some metadata about the rule
+ *
+ * @return A rule reference to the referenced rule
+ */
+ public RuleReference decorateRule(Rule referencedRule, RuleSetReference ruleSetReference, Element ruleElement) {
+ RuleReference ruleReference = new RuleReference(referencedRule, ruleSetReference);
+
+ if (ruleElement.hasAttribute(DEPRECATED)) {
+ ruleReference.setDeprecated(Boolean.parseBoolean(ruleElement.getAttribute(DEPRECATED)));
+ }
+ if (ruleElement.hasAttribute(NAME)) {
+ ruleReference.setName(ruleElement.getAttribute(NAME));
+ }
+ if (ruleElement.hasAttribute(MESSAGE)) {
+ ruleReference.setMessage(ruleElement.getAttribute(MESSAGE));
+ }
+ if (ruleElement.hasAttribute(EXTERNAL_INFO_URL)) {
+ ruleReference.setExternalInfoUrl(ruleElement.getAttribute(EXTERNAL_INFO_URL));
+ }
+
+ for (int i = 0; i < ruleElement.getChildNodes().getLength(); i++) {
+ Node node = ruleElement.getChildNodes().item(i);
+ if (node.getNodeType() == Node.ELEMENT_NODE) {
+ switch (node.getNodeName()) {
+ case DESCRIPTION:
+ ruleReference.setDescription(parseTextNode(node));
+ break;
+ case EXAMPLE:
+ ruleReference.addExample(parseTextNode(node));
+ break;
+ case PRIORITY:
+ ruleReference.setPriority(RulePriority.valueOf(Integer.parseInt(parseTextNode(node))));
+ break;
+ case PROPERTIES:
+ setPropertyValues(ruleReference, (Element) node);
+ break;
+ default:
+ throw new IllegalArgumentException("Unexpected element <" + node.getNodeName()
+ + "> encountered as child of element for Rule "
+ + ruleReference.getName());
+ }
+ }
+ }
+
+ return ruleReference;
+ }
+
+ /**
+ * Parses a rule element and returns a new rule instance.
+ *
+ * Notes: The ruleset name is not set here. Exceptions raised from this method indicate invalid XML structure,
+ * with regards to the expected schema, while RuleBuilder validates the semantics.
+ *
+ * @param ruleElement The rule element to parse
+ *
+ * @return A new instance of the rule described by this element
+ * @throws IllegalArgumentException if the element doesn't describe a valid rule.
+ */
+ public Rule buildRule(Element ruleElement) {
+ checkRequiredAttributesArePresent(ruleElement);
+
+ String name = ruleElement.getAttribute(NAME);
+
+ RuleBuilder builder = new RuleBuilder(name,
+ ruleElement.getAttribute(CLASS),
+ ruleElement.getAttribute("language"));
+
+ if (ruleElement.hasAttribute(MINIMUM_LANGUAGE_VERSION)) {
+ builder.minimumLanguageVersion(ruleElement.getAttribute(MINIMUM_LANGUAGE_VERSION));
+ }
+
+ if (ruleElement.hasAttribute(MAXIMUM_LANGUAGE_VERSION)) {
+ builder.maximumLanguageVersion(ruleElement.getAttribute(MAXIMUM_LANGUAGE_VERSION));
+ }
+
+ if (ruleElement.hasAttribute(SINCE)) {
+ builder.since(ruleElement.getAttribute(SINCE));
+ }
+
+ builder.message(ruleElement.getAttribute(MESSAGE));
+ builder.externalInfoUrl(ruleElement.getAttribute(EXTERNAL_INFO_URL));
+ builder.setDeprecated(hasAttributeSetTrue(ruleElement, DEPRECATED));
+ builder.usesDFA(hasAttributeSetTrue(ruleElement, "dfa"));
+ builder.usesTyperesolution(hasAttributeSetTrue(ruleElement, "typeResolution"));
+ // Disabled until it's safe
+ // builder.usesMultifile(hasAttributeSetTrue(ruleElement, "multifile"));
+
+ Element propertiesElement = null;
+
+ final NodeList nodeList = ruleElement.getChildNodes();
+ for (int i = 0; i < nodeList.getLength(); i++) {
+ Node node = nodeList.item(i);
+ if (node.getNodeType() != Node.ELEMENT_NODE) {
+ continue;
+ }
+
+ switch (node.getNodeName()) {
+ case DESCRIPTION:
+ builder.description(parseTextNode(node));
+ break;
+ case EXAMPLE:
+ builder.addExample(parseTextNode(node));
+ break;
+ case PRIORITY:
+ builder.priority(Integer.parseInt(parseTextNode(node).trim()));
+ break;
+ case PROPERTIES:
+ parsePropertiesForDefinitions(builder, node);
+ propertiesElement = (Element) node;
+ break;
+ default:
+ throw new IllegalArgumentException("Unexpected element <" + node.getNodeName()
+ + "> encountered as child of element for Rule "
+ + name);
+ }
+ }
+
+ Rule rule;
+ try {
+ rule = builder.build();
+ } catch (ClassNotFoundException | IllegalAccessException | InstantiationException e) {
+ LOG.log(Level.SEVERE, "Error instantiating a rule", e);
+ throw new RuntimeException(e);
+ }
+
+ if (propertiesElement != null) {
+ setPropertyValues(rule, propertiesElement);
+ }
+
+ return rule;
+ }
+
+ private void checkRequiredAttributesArePresent(Element ruleElement) {
+ // add an attribute name here to make it required
+
+ for (String att : REQUIRED_ATTRIBUTES) {
+ if (!ruleElement.hasAttribute(att)) {
+ throw new IllegalArgumentException("Missing '" + att + "' attribute");
+ }
+ }
+ }
+
+ /**
+ * Parses a properties element looking only for the values of the properties defined or overridden.
+ *
+ * @param propertiesNode Node to parse
+ *
+ * @return A map of property names to their value
+ */
+ private Map getPropertyValuesFrom(Element propertiesNode) {
+ Map overridenProperties = new HashMap<>();
+
+ for (int i = 0; i < propertiesNode.getChildNodes().getLength(); i++) {
+ Node node = propertiesNode.getChildNodes().item(i);
+ if (node.getNodeType() == Node.ELEMENT_NODE && PROPERTY.equals(node.getNodeName())) {
+ Entry overridden = getPropertyValue((Element) node);
+ overridenProperties.put(overridden.getKey(), overridden.getValue());
+ }
+ }
+
+ return overridenProperties;
+ }
+
+ /**
+ * Parses the properties node and adds property definitions to the builder. Doesn't care for value overriding, that
+ * will be handled after the rule instantiation.
+ *
+ * @param builder Rule builder
+ * @param propertiesNode Node to parse
+ */
+ private void parsePropertiesForDefinitions(RuleBuilder builder, Node propertiesNode) {
+ for (int i = 0; i < propertiesNode.getChildNodes().getLength(); i++) {
+ Node node = propertiesNode.getChildNodes().item(i);
+ if (node.getNodeType() == Node.ELEMENT_NODE && PROPERTY.equals(node.getNodeName())
+ && isPropertyDefinition((Element) node)) {
+ PropertyDescriptor descriptor = parsePropertyDefinition((Element) node);
+ builder.defineProperty(descriptor);
+ }
+ }
+ }
+
+ /**
+ * Gets a mapping of property name to its value from the given property element.
+ *
+ * @param propertyElement Property element
+ *
+ * @return An entry of property name to its value
+ */
+ private Entry getPropertyValue(Element propertyElement) {
+ String name = propertyElement.getAttribute(PropertyDescriptorField.NAME.attributeName());
+ return new SimpleEntry<>(name, valueFrom(propertyElement));
+ }
+
+ /**
+ * Overrides the rule's properties with the values defined in the element.
+ *
+ * @param rule The rule
+ * @param propertiesElt The {@literal } element
+ */
+ private void setPropertyValues(Rule rule, Element propertiesElt) {
+ Map overridden = getPropertyValuesFrom(propertiesElt);
+
+ for (Entry e : overridden.entrySet()) {
+ PropertyDescriptor descriptor = rule.getPropertyDescriptor(e.getKey());
+ if (descriptor == null) {
+ throw new IllegalArgumentException(
+ "Cannot set non-existent property '" + e.getKey() + "' on Rule " + rule.getName());
+ }
+
+ setRulePropertyCapture(rule, descriptor, e.getValue());
+ }
+ }
+
+ private void setRulePropertyCapture(Rule rule, PropertyDescriptor descriptor, String value) {
+ rule.setProperty(descriptor, descriptor.valueFrom(value));
+ }
+
+ /**
+ * Finds out if the property element defines a property.
+ *
+ * @param node Property element
+ *
+ * @return True if this element defines a new property, false if this is just stating a value
+ */
+ private static boolean isPropertyDefinition(Element node) {
+ return node.hasAttribute(PropertyDescriptorField.TYPE.attributeName());
+ }
+
+ /**
+ * Parses a property definition node and returns the defined property descriptor.
+ *
+ * @param propertyElement Property node to parse
+ *
+ * @return The property descriptor
+ */
+ private static PropertyDescriptor parsePropertyDefinition(Element propertyElement) {
+ String typeId = propertyElement.getAttribute(PropertyDescriptorField.TYPE.attributeName());
+
+ PropertyDescriptorExternalBuilder pdFactory = PropertyTypeId.factoryFor(typeId);
+ if (pdFactory == null) {
+ throw new IllegalArgumentException("No property descriptor factory for type: " + typeId);
+ }
+
+ Map values = new HashMap<>();
+ NamedNodeMap atts = propertyElement.getAttributes();
+
+ /// populate a map of values for an individual descriptor
+ for (int i = 0; i < atts.getLength(); i++) {
+ Attr a = (Attr) atts.item(i);
+ values.put(PropertyDescriptorField.getConstant(a.getName()), a.getValue());
+ }
+
+ if (StringUtils.isBlank(values.get(DEFAULT_VALUE))) {
+ NodeList children = propertyElement.getElementsByTagName(DEFAULT_VALUE.attributeName());
+ if (children.getLength() == 1) {
+ values.put(DEFAULT_VALUE, children.item(0).getTextContent());
+ } else {
+ throw new IllegalArgumentException("No value defined!");
+ }
+ }
+
+ // casting is not pretty but prevents the interface from having this method
+ return pdFactory.build(values);
+ }
+
+ /** Gets the string value from a property node. */
+ private static String valueFrom(Element propertyNode) {
+ String strValue = propertyNode.getAttribute(DEFAULT_VALUE.attributeName());
+
+ if (StringUtils.isNotBlank(strValue)) {
+ return strValue;
+ }
+
+ final NodeList nodeList = propertyNode.getChildNodes();
+
+ for (int i = 0; i < nodeList.getLength(); i++) {
+ Node node = nodeList.item(i);
+ if (node.getNodeType() == Node.ELEMENT_NODE && "value".equals(node.getNodeName())) {
+ return parseTextNode(node);
+ }
+ }
+ return null;
+ }
+
+ private static boolean hasAttributeSetTrue(Element element, String attributeId) {
+ return element.hasAttribute(attributeId) && "true".equalsIgnoreCase(element.getAttribute(attributeId));
+ }
+
+ /**
+ * Parse a String from a textually type node.
+ *
+ * @param node The node.
+ *
+ * @return The String.
+ */
+ private static String parseTextNode(Node node) {
+ final int nodeCount = node.getChildNodes().getLength();
+ if (nodeCount == 0) {
+ return "";
+ }
+
+ StringBuilder buffer = new StringBuilder();
+
+ for (int i = 0; i < nodeCount; i++) {
+ Node childNode = node.getChildNodes().item(i);
+ if (childNode.getNodeType() == Node.CDATA_SECTION_NODE || childNode.getNodeType() == Node.TEXT_NODE) {
+ buffer.append(childNode.getNodeValue());
+ }
+ }
+ return buffer.toString();
+ }
+}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/ClasspathClassLoader.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/ClasspathClassLoader.java
index fd9d057e0b4..841baa81e5f 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/ClasspathClassLoader.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/ClasspathClassLoader.java
@@ -17,7 +17,6 @@
import java.util.logging.Level;
import java.util.logging.Logger;
-import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.StringUtils;
/**
@@ -30,15 +29,29 @@
public class ClasspathClassLoader extends URLClassLoader {
private static final Logger LOG = Logger.getLogger(ClasspathClassLoader.class.getName());
-
+
static {
registerAsParallelCapable();
}
+ public ClasspathClassLoader(List files, ClassLoader parent) throws IOException {
+ super(fileToURL(files), parent);
+ }
+
public ClasspathClassLoader(String classpath, ClassLoader parent) throws IOException {
super(initURLs(classpath), parent);
}
+ private static URL[] fileToURL(List files) throws IOException {
+
+ List urlList = new ArrayList<>();
+
+ for (File f : files) {
+ urlList.add(f.toURI().toURL());
+ }
+ return urlList.toArray(new URL[0]);
+ }
+
private static URL[] initURLs(String classpath) throws IOException {
if (classpath == null) {
throw new IllegalArgumentException("classpath argument cannot be null");
@@ -51,7 +64,7 @@ private static URL[] initURLs(String classpath) throws IOException {
// Treat as classpath
addClasspathURLs(urls, classpath);
}
- return urls.toArray(new URL[urls.size()]);
+ return urls.toArray(new URL[0]);
}
private static void addClasspathURLs(final List urls, final String classpath) throws MalformedURLException {
@@ -64,9 +77,7 @@ private static void addClasspathURLs(final List urls, final String classpat
}
private static void addFileURLs(List urls, URL fileURL) throws IOException {
- BufferedReader in = null;
- try {
- in = new BufferedReader(new InputStreamReader(fileURL.openStream()));
+ try (BufferedReader in = new BufferedReader(new InputStreamReader(fileURL.openStream()))) {
String line;
while ((line = in.readLine()) != null) {
LOG.log(Level.FINE, "Read classpath entry line: <{0}>", line);
@@ -76,8 +87,6 @@ private static void addFileURLs(List urls, URL fileURL) throws IOException
urls.add(createURLFromPath(line));
}
}
- } finally {
- IOUtils.closeQuietly(in);
}
}
@@ -86,9 +95,6 @@ private static URL createURLFromPath(String path) throws MalformedURLException {
return file.getAbsoluteFile().toURI().toURL();
}
- /**
- * {@inheritDoc}
- */
@Override
public String toString() {
return new StringBuilder(getClass().getSimpleName())
@@ -96,4 +102,27 @@ public String toString() {
.append(StringUtils.join(getURLs(), ":"))
.append("] parent: ").append(getParent()).append(']').toString();
}
+
+ @Override
+ protected Class loadClass(final String name, final boolean resolve) throws ClassNotFoundException {
+ synchronized (getClassLoadingLock(name)) {
+ // First, check if the class has already been loaded
+ Class c = findLoadedClass(name);
+ if (c == null) {
+ try {
+ // checking local
+ c = findClass(name);
+ } catch (final ClassNotFoundException | SecurityException e) {
+ // checking parent
+ // This call to loadClass may eventually call findClass again, in case the parent doesn't find anything.
+ c = super.loadClass(name, resolve);
+ }
+ }
+
+ if (resolve) {
+ resolveClass(c);
+ }
+ return c;
+ }
+ }
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/CollectionUtil.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/CollectionUtil.java
index 3bf817ca6ae..4592e487e93 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/CollectionUtil.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/CollectionUtil.java
@@ -10,8 +10,10 @@
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
+import java.util.Iterator;
import java.util.List;
import java.util.Map;
+import java.util.Objects;
import java.util.Set;
/**
@@ -161,6 +163,26 @@ public static Map invertedMapFrom(Map source) {
return map;
}
+
+ /**
+ * Consumes all the elements of the iterator and
+ * returns a list containing them. The iterator is
+ * then unusable
+ *
+ * @param it An iterator
+ *
+ * @return a list containing the elements remaining
+ * on the iterator
+ */
+ public static List toList(Iterator it) {
+ List list = new ArrayList<>();
+ while (it.hasNext()) {
+ list.add(it.next());
+ }
+ return list;
+ }
+
+
/**
* Returns true if the objects are array instances and each of their
* elements compares via equals as well.
@@ -170,7 +192,7 @@ public static Map invertedMapFrom(Map source) {
* @param otherValue
* Object
* @return boolean
- * @deprecated {@see Objects#deepEquals(Object, Object)}
+ * @deprecated {@link Objects#deepEquals(Object, Object)}
*/
@Deprecated
public static boolean arraysAreEqual(Object value, Object otherValue) {
@@ -192,7 +214,7 @@ public static boolean arraysAreEqual(Object value, Object otherValue) {
* @param thatArray
* Object[]
* @return boolean
- * @deprecated {@see Arrays#deepEquals(Object[], Object[])}
+ * @deprecated {@link Arrays#deepEquals(Object[], Object[])}
*/
@Deprecated
public static boolean valuesAreTransitivelyEqual(Object[] thisArray, Object[] thatArray) {
@@ -221,7 +243,7 @@ public static boolean valuesAreTransitivelyEqual(Object[] thisArray, Object[] th
* @param otherValue
* Object
* @return boolean
- * @deprecated {@see Objects#deepEquals(Object, Object)}
+ * @deprecated {@link Objects#deepEquals(Object, Object)}
*/
@Deprecated
@SuppressWarnings("PMD.CompareObjectsWithEquals")
@@ -271,7 +293,7 @@ public static boolean isNotEmpty(Object[] items) {
* @param a
* @param b
* @return boolean
- * @deprecated {@see Arrays#deepEquals(Object[], Object[])}
+ * @deprecated {@link Arrays#deepEquals(Object[], Object[])}
*/
@Deprecated
public static boolean areSemanticEquals(T[] a, T[] b) {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/CompoundIterator.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/CompoundIterator.java
index 543d6c3fcc0..0bd0d9d794e 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/CompoundIterator.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/CompoundIterator.java
@@ -29,17 +29,11 @@ public CompoundIterator(Iterator... iterators) {
this.index = 0;
}
- /**
- * {@inheritDoc}
- */
@Override
public boolean hasNext() {
return getNextIterator() != null;
}
- /**
- * {@inheritDoc}
- */
@Override
public T next() {
Iterator iterator = getNextIterator();
@@ -50,9 +44,6 @@ public T next() {
}
}
- /**
- * {@inheritDoc}
- */
@Override
public void remove() {
Iterator iterator = getNextIterator();
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/NumericConstants.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/NumericConstants.java
index 8f42b4f95c7..e472814db8e 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/NumericConstants.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/NumericConstants.java
@@ -4,7 +4,7 @@
package net.sourceforge.pmd.util;
-public class NumericConstants {
+public final class NumericConstants {
public static final Integer ZERO = 0;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/ResourceLoader.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/ResourceLoader.java
index 87748290ae1..27587aa57d2 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/ResourceLoader.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/ResourceLoader.java
@@ -12,12 +12,11 @@
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLConnection;
+import java.util.Objects;
import net.sourceforge.pmd.RuleSetNotFoundException;
-/**
- */
-public final class ResourceLoader {
+public class ResourceLoader {
public static final int TIMEOUT;
@@ -31,86 +30,93 @@ public final class ResourceLoader {
TIMEOUT = timeoutProperty;
}
- // Only static methods, so we shouldn't allow an instance to be created
+ private final ClassLoader classLoader;
+
/**
* Constructor for ResourceLoader.
*/
- private ResourceLoader() {
+ public ResourceLoader() {
+ this(ResourceLoader.class.getClassLoader());
}
/**
- * Method to find a file, first by finding it as a file (either by the
- * absolute or relative path), then as a URL, and then finally seeing if it
- * is on the classpath.
- *
- * Caller is responsible for closing the {@link InputStream}.
- *
- * @param name
- * String
- * @return InputStream
- * @throws RuleSetNotFoundException
+ * Constructor for ResourceLoader.
*/
- public static InputStream loadResourceAsStream(String name) throws RuleSetNotFoundException {
- InputStream stream = loadResourceAsStream(name, ResourceLoader.class.getClassLoader());
- if (stream == null) {
- throw new RuleSetNotFoundException("Can't find resource " + name
- + ". Make sure the resource is a valid file or URL or is on the CLASSPATH");
- }
- return stream;
+ public ResourceLoader(final ClassLoader cl) {
+ this.classLoader = Objects.requireNonNull(cl);
}
/**
- * Uses the ClassLoader passed in to attempt to load the resource if it's
- * not a File or a URL
+ * Attempts to load the resource from file, a URL or the claspath
*
* Caller is responsible for closing the {@link InputStream}.
*
- * @param name
- * String
- * @param loader
- * ClassLoader
+ * @param name The resource to attempt and load
* @return InputStream
* @throws RuleSetNotFoundException
*/
- public static InputStream loadResourceAsStream(String name, ClassLoader loader) throws RuleSetNotFoundException {
- File file = new File(name);
+ public InputStream loadResourceAsStream(final String name) throws RuleSetNotFoundException {
+ // Search file locations first
+ final File file = new File(name);
if (file.exists()) {
try {
return new FileInputStream(file);
- } catch (FileNotFoundException e) {
+ } catch (final FileNotFoundException e) {
// if the file didn't exist, we wouldn't be here
+ throw new RuntimeException(e); // somehow the file vanished between checking for existence and opening
}
- } else {
+ }
+
+ // Maybe it's a url?
+ try {
+ final HttpURLConnection connection = (HttpURLConnection) new URL(name).openConnection();
+ connection.setConnectTimeout(TIMEOUT);
+ connection.setReadTimeout(TIMEOUT);
+ return connection.getInputStream();
+ } catch (final Exception e) {
try {
- HttpURLConnection connection = (HttpURLConnection) new URL(name).openConnection();
- connection.setConnectTimeout(TIMEOUT);
- connection.setReadTimeout(TIMEOUT);
- return connection.getInputStream();
- } catch (Exception e) {
- try {
- /*
- * Don't use getResourceAsStream to void reusing connections between threads
- * See https://github.com/pmd/pmd/issues/234
- */
- URL resource = loader.getResource(name);
- if (resource == null) {
- // Don't throw RuleSetNotFoundException, keep API compatibility
- return null;
- } else {
- final URLConnection connection = resource.openConnection();
- // This avoids reusing the underlaying file, if the resource is loaded from a Jar file.
- // The file is closed with the input stream then thus not leaving a leaked resource behind.
- // See https://github.com/pmd/pmd/issues/364 and https://github.com/pmd/pmd/issues/337
- connection.setUseCaches(false);
- final InputStream inputStream = connection.getInputStream();
- return inputStream;
- }
- } catch (IOException e1) {
- // Ignored
- }
+ return loadClassPathResourceAsStream(name);
+ } catch (final IOException ignored) {
+ // We will throw our own exception, with a different message
}
}
+
throw new RuleSetNotFoundException("Can't find resource " + name
+ ". Make sure the resource is a valid file or URL or is on the CLASSPATH");
}
+
+ public InputStream loadClassPathResourceAsStream(final String name) throws IOException {
+ /*
+ * Don't use getResourceAsStream to avoid reusing connections between threads
+ * See https://github.com/pmd/pmd/issues/234
+ */
+ final URL resource = classLoader.getResource(name);
+ if (resource == null) {
+ // Don't throw RuleSetNotFoundException, keep API compatibility
+ return null;
+ } else {
+ final URLConnection connection = resource.openConnection();
+ // This avoids reusing the underlying file, if the resource is loaded from a Jar file.
+ // The file is closed with the input stream then thus not leaving a leaked resource behind.
+ // See https://github.com/pmd/pmd/issues/364 and https://github.com/pmd/pmd/issues/337
+ connection.setUseCaches(false);
+ return connection.getInputStream();
+ }
+ }
+
+ public InputStream loadClassPathResourceAsStreamOrThrow(final String name) throws RuleSetNotFoundException {
+ InputStream is = null;
+ try {
+ is = loadClassPathResourceAsStream(name);
+ } catch (final IOException ignored) {
+ // ignored
+ }
+
+ if (is == null) {
+ throw new RuleSetNotFoundException("Can't find resource " + name
+ + ". Make sure the resource is on the CLASSPATH");
+ }
+
+ return is;
+ }
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/StringUtil.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/StringUtil.java
index 57bc4666bc1..84caeac6cea 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/StringUtil.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/StringUtil.java
@@ -52,7 +52,7 @@ public static String percentageString(double val, int numDecimals) {
* @param prefixes
*
* @return boolean
- * @deprecated {@see StringUtils#startsWithAny(CharSequence, CharSequence...)}
+ * @deprecated {@link StringUtils#startsWithAny(CharSequence, CharSequence...)}
*/
@Deprecated
public static boolean startsWithAny(String text, String... prefixes) {
@@ -112,7 +112,7 @@ public static String withoutPrefixes(String text, String... prefixes) {
* @param value String
*
* @return boolean
- * @deprecated {@see StringUtils#isNotBlank(CharSequence)}
+ * @deprecated {@link StringUtils#isNotBlank(CharSequence)}
*/
@Deprecated
public static boolean isNotEmpty(String value) {
@@ -128,7 +128,7 @@ public static boolean isNotEmpty(String value) {
* @param value String to test
*
* @return true if the value is empty, false otherwise.
- * @deprecated {@see StringUtils#isBlank(CharSequence)}
+ * @deprecated {@link StringUtils#isBlank(CharSequence)}
*/
@Deprecated
public static boolean isEmpty(String value) {
@@ -142,7 +142,7 @@ public static boolean isEmpty(String value) {
* @param value String to test
*
* @return True if the argument is null or the empty string
- * @deprecated {@see StringUtils#isEmpty(CharSequence)}
+ * @deprecated {@link StringUtils#isEmpty(CharSequence)}
*/
@Deprecated
public static boolean isMissing(String value) {
@@ -179,7 +179,7 @@ public static boolean areSemanticEquals(String a, String b) {
* @param newString String
*
* @return String
- * @deprecated {@see StringUtils#replace(String, String, String)}
+ * @deprecated {@link StringUtils#replace(String, String, String)}
*/
@Deprecated
public static String replaceString(final String original, final String oldString, final String newString) {
@@ -207,7 +207,6 @@ public static String replaceString(final String original, final String oldString
* @param supportUTF8 override the default setting, whether special characters should be replaced with entities (
* false) or should be included as is ( true).
*
- * @see #appendXmlEscaped(StringBuilder, String)
*/
public static void appendXmlEscaped(StringBuilder buf, String src, boolean supportUTF8) {
char c;
@@ -267,7 +266,7 @@ public static String escapeWhitespace(Object o) {
* @param newString String
*
* @return String
- * @deprecated {@see StringUtils#replace(String, String, String)} or {@see StringUtils#replaceChars(String, char, char)}
+ * @deprecated {@link StringUtils#replace(String, String, String)} or {@link StringUtils#replaceChars(String, char, char)}
*/
@Deprecated
public static String replaceString(final String original, char oldChar, final String newString) {
@@ -300,7 +299,7 @@ public static String replaceString(final String original, char oldChar, final St
* @param delimiter char
*
* @return String[]
- * @deprecated {@see StringUtils#split(String, char)}
+ * @deprecated {@link StringUtils#split(String, char)}
*/
@Deprecated
public static String[] substringsOf(String source, char delimiter) {
@@ -348,7 +347,7 @@ public static String[] substringsOf(String source, char delimiter) {
* @param separator char
*
* @return String[]
- * @deprecated {@see StringUtils#split(String, String)}
+ * @deprecated {@link StringUtils#split(String, String)}
*/
@Deprecated
public static String[] substringsOf(String str, String separator) {
@@ -371,7 +370,7 @@ public static String[] substringsOf(String str, String separator) {
index = str.indexOf(separator, currPos);
}
list.add(str.substring(currPos));
- return list.toArray(new String[list.size()]);
+ return list.toArray(new String[0]);
}
@@ -382,7 +381,7 @@ public static String[] substringsOf(String str, String separator) {
* @param sb StringBuffer
* @param iter Iterator
* @param separator String
- * @deprecated {@see StringUtils#join(Iterator, String)}
+ * @deprecated {@link StringUtils#join(Iterator, String)}
*/
@Deprecated
public static void asStringOn(StringBuffer sb, Iterator iter, String separator) {
@@ -407,7 +406,7 @@ public static void asStringOn(StringBuffer sb, Iterator iter, String separato
* @param sb StringBuilder
* @param items Object[]
* @param separator String
- * @deprecated {@see StringUtils#join(Iterable, String)}
+ * @deprecated {@link StringUtils#join(Iterable, String)}
*/
@Deprecated
public static void asStringOn(StringBuilder sb, Object[] items, String separator) {
@@ -519,7 +518,7 @@ public static String[] trimStartOn(String[] strings, int trimDepth) {
* @param length The desired minimum length of the resulting padded String
*
* @return The resulting left padded String
- * @deprecated {@see StringUtils#leftPad(String, int)}
+ * @deprecated {@link StringUtils#leftPad(String, int)}
*/
@Deprecated
public static String lpad(String s, int length) {
@@ -604,4 +603,55 @@ public static String asString(Object[] items, String separator) {
public static String[] getEmptyStrings() {
return EMPTY_STRINGS;
}
+
+
+ /**
+ * Converts the given string to Camel case,
+ * that is, removing all spaces, and capitalising
+ * the first letter of each word except the first.
+ *
+ *
If the first word starts with an uppercase
+ * letter, it's kept as is. This method can thus
+ * be used for Pascal case too.
+ *
+ * @param name The string to convert
+ *
+ * @return The string converted to Camel case
+ */
+ public static String toCamelCase(String name) {
+ return toCamelCase(name, false);
+ }
+
+
+ /**
+ * Converts the given string to Camel case,
+ * that is, removing all spaces, and capitalising
+ * the first letter of each word except the first.
+ *
+ *
The second parameter can be used to force the
+ * words to be converted to lowercase before capitalising.
+ * This can be useful if eg the first word contains
+ * several uppercase letters.
+ *
+ * @param name The string to convert
+ * @param forceLowerCase Whether to force removal of all upper
+ * case letters except on word start
+ *
+ * @return The string converted to Camel case
+ */
+ public static String toCamelCase(String name, boolean forceLowerCase) {
+ StringBuilder sb = new StringBuilder();
+ boolean isFirst = true;
+ for (String word : name.trim().split("\\s++")) {
+ String pretreated = forceLowerCase ? word.toLowerCase(Locale.ROOT) : word;
+ if (isFirst) {
+ sb.append(pretreated);
+ isFirst = false;
+ } else {
+ sb.append(StringUtils.capitalize(pretreated));
+ }
+ }
+ return sb.toString();
+ }
+
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/database/DBMSMetadata.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/database/DBMSMetadata.java
index 634c3154f9a..4dfde3d00b9 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/database/DBMSMetadata.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/database/DBMSMetadata.java
@@ -332,7 +332,6 @@ public List getSourceObjectList() {
public List getSourceObjectList(List languages, List schemas,
List sourceCodeTypes, List sourceCodeNames) {
- ResultSet sourceCodeObjects = null;
List sourceObjectsList = new ArrayList<>();
List searchLanguages = languages;
@@ -388,57 +387,14 @@ public List getSourceObjectList(List languages, List procedure catalog (may be null)
- * PROCEDURE_SCHEM String => procedure schema
- * (may be null) PROCEDURE_NAME String =>
- * procedure name reserved for future use
- * reserved for future use reserved for future
- * use REMARKS String => explanatory comment on
- * the procedure PROCEDURE_TYPE short => kind of
- * procedure: procedureResultUnknown - Cannot
- * determine if a return value will be returned
- * procedureNoResult - Does not return a return
- * value procedureReturnsResult - Returns a
- * return value SPECIFIC_NAME String => The name
- * which uniquely identifies this procedure
- * within its schema.
- */
- while (sourceCodeObjects.next()) {
- LOGGER.finest(String.format("Found schema=%s,object_type=%s,object_name=%s",
- sourceCodeObjects.getString("PROCEDURE_SCHEM"),
- sourceCodeObjects.getString("PROCEDURE_TYPE"),
- sourceCodeObjects.getString("PROCEDURE_NAME")));
-
- sourceObjectsList
- .add(new SourceObject(sourceCodeObjects.getString("PROCEDURE_SCHEM"),
- sourceCodeObjects.getString("PROCEDURE_TYPE"),
- sourceCodeObjects.getString("PROCEDURE_NAME"), null));
+ try (PreparedStatement sourceCodeObjectsStatement = getConnection()
+ .prepareStatement(returnSourceCodeObjectsStatement)) {
+ for (String language : searchLanguages) {
+ for (String schema : searchSchemas) {
+ for (String sourceCodeType : searchSourceCodeTypes) {
+ for (String sourceCodeName : searchSourceCodeNames) {
+ sourceObjectsList.addAll(findSourceObjects(sourceCodeObjectsStatement, language, schema,
+ sourceCodeType, sourceCodeName));
}
}
}
@@ -453,74 +409,7 @@ public List getSourceObjectList(List languages, List schemasList = dburi.getSchemasList();
for (String schema : schemasList) {
for (String sourceCodeName : dburi.getSourceCodeNamesList()) {
- /*
- * public ResultSet getProcedures(String catalog ,
- * String schemaPattern , String procedureNamePattern)
- * throws SQLException
- */
- sourceCodeObjects = metadata.getProcedures(null, schema, sourceCodeName);
- /*
- * From Javadoc .... Each procedure description has the
- * the following columns: PROCEDURE_CAT String =>
- * procedure catalog (may be null) PROCEDURE_SCHEM
- * String => procedure schema (may be null)
- * PROCEDURE_NAME String => procedure name reserved for
- * future use reserved for future use reserved for
- * future use REMARKS String => explanatory comment on
- * the procedure PROCEDURE_TYPE short => kind of
- * procedure: procedureResultUnknown - Cannot determine
- * if a return value will be returned procedureNoResult
- * - Does not return a return value
- * procedureReturnsResult - Returns a return value
- * SPECIFIC_NAME String => The name which uniquely
- * identifies this procedure within its schema.
- *
- * Oracle getProcedures actually returns these 8
- * columns:- ResultSet "Matched Procedures" has 8
- * columns and contains ...
- * [PROCEDURE_CAT,PROCEDURE_SCHEM,PROCEDURE_NAME,NULL,
- * NULL,NULL,REMARKS,PROCEDURE_TYPE
- * ,null,PHPDEMO,ADD_JOB_HISTORY,null,null,null,
- * Standalone procedure or function,1
- * ,FETCHPERFPKG,PHPDEMO,BULKSELECTPRC,null,null,null,
- * Packaged function,2
- * ,FETCHPERFPKG,PHPDEMO,BULKSELECTPRC,null,null,null,
- * Packaged procedure,1
- * ,null,PHPDEMO,CITY_LIST,null,null,null,Standalone
- * procedure or function,1
- * ,null,PHPDEMO,EDDISCOUNT,null,null,null,Standalone
- * procedure or function,2
- * ,SELPKG_BA,PHPDEMO,EMPSELBULK,null,null,null,Packaged
- * function,2
- * ,SELPKG_BA,PHPDEMO,EMPSELBULK,null,null,null,Packaged
- * procedure,1
- * ,INSPKG,PHPDEMO,INSFORALL,null,null,null,Packaged
- * procedure,1
- * ,null,PHPDEMO,MYDOFETCH,null,null,null,Standalone
- * procedure or function,2
- * ,null,PHPDEMO,MYPROC1,null,null,null,Standalone
- * procedure or function,1
- * ,null,PHPDEMO,MYPROC2,null,null,null,Standalone
- * procedure or function,1
- * ,null,PHPDEMO,MYXAQUERY,null,null,null,Standalone
- * procedure or function,1
- * ,null,PHPDEMO,POLICY_VPDPARTS,null,null,null,
- * Standalone procedure or function,2
- * ,FETCHPERFPKG,PHPDEMO,REFCURPRC,null,null,null,
- * Packaged procedure,1
- * ,null,PHPDEMO,SECURE_DML,null,null,null,Standalone
- * procedure or function,1 ... ]
- */
- while (sourceCodeObjects.next()) {
- LOGGER.finest(String.format("Located schema=%s,object_type=%s,object_name=%s\n",
- sourceCodeObjects.getString("PROCEDURE_SCHEM"),
- sourceCodeObjects.getString("PROCEDURE_TYPE"),
- sourceCodeObjects.getString("PROCEDURE_NAME")));
-
- sourceObjectsList.add(new SourceObject(sourceCodeObjects.getString("PROCEDURE_SCHEM"),
- sourceCodeObjects.getString("PROCEDURE_TYPE"),
- sourceCodeObjects.getString("PROCEDURE_NAME"), null));
- }
+ sourceObjectsList.addAll(findSourceObjectFromMetaData(metadata, schema, sourceCodeName));
}
}
}
@@ -532,4 +421,130 @@ public List getSourceObjectList(List languages, List findSourceObjectFromMetaData(DatabaseMetaData metadata,
+ String schema, String sourceCodeName) throws SQLException {
+ List sourceObjectsList = new ArrayList<>();
+ /*
+ * public ResultSet getProcedures(String catalog ,
+ * String schemaPattern , String procedureNamePattern)
+ * throws SQLException
+ */
+ try (ResultSet sourceCodeObjects = metadata.getProcedures(null, schema, sourceCodeName)) {
+ /*
+ * From Javadoc .... Each procedure description has the
+ * the following columns: PROCEDURE_CAT String =>
+ * procedure catalog (may be null) PROCEDURE_SCHEM
+ * String => procedure schema (may be null)
+ * PROCEDURE_NAME String => procedure name reserved for
+ * future use reserved for future use reserved for
+ * future use REMARKS String => explanatory comment on
+ * the procedure PROCEDURE_TYPE short => kind of
+ * procedure: procedureResultUnknown - Cannot determine
+ * if a return value will be returned procedureNoResult
+ * - Does not return a return value
+ * procedureReturnsResult - Returns a return value
+ * SPECIFIC_NAME String => The name which uniquely
+ * identifies this procedure within its schema.
+ *
+ * Oracle getProcedures actually returns these 8
+ * columns:- ResultSet "Matched Procedures" has 8
+ * columns and contains ...
+ * [PROCEDURE_CAT,PROCEDURE_SCHEM,PROCEDURE_NAME,NULL,
+ * NULL,NULL,REMARKS,PROCEDURE_TYPE
+ * ,null,PHPDEMO,ADD_JOB_HISTORY,null,null,null,
+ * Standalone procedure or function,1
+ * ,FETCHPERFPKG,PHPDEMO,BULKSELECTPRC,null,null,null,
+ * Packaged function,2
+ * ,FETCHPERFPKG,PHPDEMO,BULKSELECTPRC,null,null,null,
+ * Packaged procedure,1
+ * ,null,PHPDEMO,CITY_LIST,null,null,null,Standalone
+ * procedure or function,1
+ * ,null,PHPDEMO,EDDISCOUNT,null,null,null,Standalone
+ * procedure or function,2
+ * ,SELPKG_BA,PHPDEMO,EMPSELBULK,null,null,null,Packaged
+ * function,2
+ * ,SELPKG_BA,PHPDEMO,EMPSELBULK,null,null,null,Packaged
+ * procedure,1
+ * ,INSPKG,PHPDEMO,INSFORALL,null,null,null,Packaged
+ * procedure,1
+ * ,null,PHPDEMO,MYDOFETCH,null,null,null,Standalone
+ * procedure or function,2
+ * ,null,PHPDEMO,MYPROC1,null,null,null,Standalone
+ * procedure or function,1
+ * ,null,PHPDEMO,MYPROC2,null,null,null,Standalone
+ * procedure or function,1
+ * ,null,PHPDEMO,MYXAQUERY,null,null,null,Standalone
+ * procedure or function,1
+ * ,null,PHPDEMO,POLICY_VPDPARTS,null,null,null,
+ * Standalone procedure or function,2
+ * ,FETCHPERFPKG,PHPDEMO,REFCURPRC,null,null,null,
+ * Packaged procedure,1
+ * ,null,PHPDEMO,SECURE_DML,null,null,null,Standalone
+ * procedure or function,1 ... ]
+ */
+ while (sourceCodeObjects.next()) {
+ LOGGER.finest(String.format("Located schema=%s,object_type=%s,object_name=%s\n",
+ sourceCodeObjects.getString("PROCEDURE_SCHEM"),
+ sourceCodeObjects.getString("PROCEDURE_TYPE"),
+ sourceCodeObjects.getString("PROCEDURE_NAME")));
+
+ sourceObjectsList.add(new SourceObject(sourceCodeObjects.getString("PROCEDURE_SCHEM"),
+ sourceCodeObjects.getString("PROCEDURE_TYPE"),
+ sourceCodeObjects.getString("PROCEDURE_NAME"), null));
+ }
+ }
+ return sourceObjectsList;
+ }
+
+ private List findSourceObjects(PreparedStatement sourceCodeObjectsStatement,
+ String language, String schema, String sourceCodeType, String sourceCodeName) throws SQLException {
+ List sourceObjectsList = new ArrayList<>();
+ sourceCodeObjectsStatement.setString(1, language);
+ sourceCodeObjectsStatement.setString(2, schema);
+ sourceCodeObjectsStatement.setString(3, sourceCodeType);
+ sourceCodeObjectsStatement.setString(4, sourceCodeName);
+ LOGGER.finer(String.format(
+ "searching for language=\"%s\", schema=\"%s\", sourceCodeType=\"%s\", sourceCodeNames=\"%s\" ",
+ language, schema, sourceCodeType, sourceCodeName));
+
+ /*
+ * public ResultSet getProcedures(String catalog
+ * , String schemaPattern , String
+ * procedureNamePattern) throws SQLException
+ */
+ try (ResultSet sourceCodeObjects = sourceCodeObjectsStatement.executeQuery()) {
+
+ /*
+ * From Javadoc .... Each procedure description
+ * has the the following columns: PROCEDURE_CAT
+ * String => procedure catalog (may be null)
+ * PROCEDURE_SCHEM String => procedure schema
+ * (may be null) PROCEDURE_NAME String =>
+ * procedure name reserved for future use
+ * reserved for future use reserved for future
+ * use REMARKS String => explanatory comment on
+ * the procedure PROCEDURE_TYPE short => kind of
+ * procedure: procedureResultUnknown - Cannot
+ * determine if a return value will be returned
+ * procedureNoResult - Does not return a return
+ * value procedureReturnsResult - Returns a
+ * return value SPECIFIC_NAME String => The name
+ * which uniquely identifies this procedure
+ * within its schema.
+ */
+ while (sourceCodeObjects.next()) {
+ LOGGER.finest(String.format("Found schema=%s,object_type=%s,object_name=%s",
+ sourceCodeObjects.getString("PROCEDURE_SCHEM"),
+ sourceCodeObjects.getString("PROCEDURE_TYPE"),
+ sourceCodeObjects.getString("PROCEDURE_NAME")));
+
+ sourceObjectsList
+ .add(new SourceObject(sourceCodeObjects.getString("PROCEDURE_SCHEM"),
+ sourceCodeObjects.getString("PROCEDURE_TYPE"),
+ sourceCodeObjects.getString("PROCEDURE_NAME"), null));
+ }
+ }
+ return sourceObjectsList;
+ }
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/database/DBType.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/database/DBType.java
index 27b7e6975d8..56d8a978a08 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/database/DBType.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/database/DBType.java
@@ -15,8 +15,6 @@
import java.util.logging.Level;
import java.util.logging.Logger;
-import org.apache.commons.io.IOUtils;
-
/**
* Encapsulate the settings needed to access database source code.
*
@@ -159,7 +157,6 @@ private Properties loadDBProperties(String matchString) throws IOException {
LOGGER.entering(DBType.class.getCanonicalName(), matchString);
// Locale locale = Control.g;
ResourceBundle resourceBundle = null;
- InputStream stream = null;
if (LOGGER.isLoggable(Level.FINEST)) {
LOGGER.finest("class_path+" + System.getProperty("java.class.path"));
@@ -170,12 +167,11 @@ private Properties loadDBProperties(String matchString) throws IOException {
* properties suffix File path without properties suffix Resource
* without class prefix Resource with class prefix
*/
- try {
- File propertiesFile = new File(matchString);
- if (LOGGER.isLoggable(Level.FINEST)) {
- LOGGER.finest("Attempting File no file suffix: " + matchString);
- }
- stream = new FileInputStream(propertiesFile);
+ File propertiesFile = new File(matchString);
+ if (LOGGER.isLoggable(Level.FINEST)) {
+ LOGGER.finest("Attempting File no file suffix: " + matchString);
+ }
+ try (InputStream stream = new FileInputStream(propertiesFile)) {
resourceBundle = new PropertyResourceBundle(stream);
propertiesSource = propertiesFile.getAbsolutePath();
LOGGER.finest("FileSystemWithoutExtension");
@@ -184,9 +180,8 @@ private Properties loadDBProperties(String matchString) throws IOException {
LOGGER.finest("notFoundOnFilesystemWithoutExtension");
LOGGER.finest("Attempting File with added file suffix: " + matchString + ".properties");
}
- try {
- File propertiesFile = new File(matchString + ".properties");
- stream = new FileInputStream(propertiesFile);
+ try (InputStream stream = new FileInputStream(propertiesFile)) {
+ propertiesFile = new File(matchString + ".properties");
resourceBundle = new PropertyResourceBundle(stream);
propertiesSource = propertiesFile.getAbsolutePath();
LOGGER.finest("FileSystemWithExtension");
@@ -214,8 +209,6 @@ private Properties loadDBProperties(String matchString) throws IOException {
}
}
}
- } finally {
- IOUtils.closeQuietly(stream);
}
// Properties in this matched resource
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/database/SourceObject.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/database/SourceObject.java
index 7b1d6f20252..5f73974de85 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/database/SourceObject.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/database/SourceObject.java
@@ -4,6 +4,7 @@
package net.sourceforge.pmd.util.database;
+import java.util.Locale;
import java.util.logging.Logger;
import net.sourceforge.pmd.cpd.SourceCode;
@@ -130,21 +131,21 @@ public String getSuffixFromType() {
LOG.entering(CLASS_NAME, "getSuffixFromType", this);
if (null == type || type.isEmpty()) {
return "";
- } else if (type.toUpperCase().indexOf("JAVA") >= 0) {
+ } else if (type.toUpperCase(Locale.ROOT).indexOf("JAVA") >= 0) {
return ".java";
- } else if (type.toUpperCase().indexOf("TRIGGER") >= 0) {
+ } else if (type.toUpperCase(Locale.ROOT).indexOf("TRIGGER") >= 0) {
return ".trg";
- } else if (type.toUpperCase().indexOf("FUNCTION") >= 0) {
+ } else if (type.toUpperCase(Locale.ROOT).indexOf("FUNCTION") >= 0) {
return ".fnc";
- } else if (type.toUpperCase().indexOf("PROCEDURE") >= 0) {
+ } else if (type.toUpperCase(Locale.ROOT).indexOf("PROCEDURE") >= 0) {
return ".prc";
- } else if (type.toUpperCase().indexOf("PACKAGE_BODY") >= 0) {
+ } else if (type.toUpperCase(Locale.ROOT).indexOf("PACKAGE_BODY") >= 0) {
return ".pkb";
- } else if (type.toUpperCase().indexOf("PACKAGE") >= 0) {
+ } else if (type.toUpperCase(Locale.ROOT).indexOf("PACKAGE") >= 0) {
return ".pks";
- } else if (type.toUpperCase().indexOf("TYPE_BODY") >= 0) {
+ } else if (type.toUpperCase(Locale.ROOT).indexOf("TYPE_BODY") >= 0) {
return ".tpb";
- } else if (type.toUpperCase().indexOf("TYPE") >= 0) {
+ } else if (type.toUpperCase(Locale.ROOT).indexOf("TYPE") >= 0) {
return ".tps";
} else {
return "";
@@ -157,8 +158,7 @@ public String getSuffixFromType() {
* parser is used.
*/
public String getPseudoFileName() {
- String falseFilePath = String.format("/Database/%s/%s/%s%s", getSchema(), getType(), getName(),
+ return String.format("/Database/%s/%s/%s%s", getSchema(), getType(), getName(),
getSuffixFromType());
- return falseFilePath;
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/datasource/FileDataSource.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/datasource/FileDataSource.java
index a3691033fc6..6c52cd2e29b 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/datasource/FileDataSource.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/datasource/FileDataSource.java
@@ -8,6 +8,8 @@
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
+import java.nio.file.Path;
+import java.nio.file.Paths;
/**
* DataSource implementation to read data from a file.
@@ -16,7 +18,7 @@ public class FileDataSource implements DataSource {
private static final String FILE_SEPARATOR = System.getProperty("file.separator");
- private File file;
+ private final File file;
/**
* @param file
@@ -37,14 +39,27 @@ public String getNiceFileName(boolean shortNames, String inputFileName) {
}
private String glomName(boolean shortNames, String inputFileName, File file) {
- if (shortNames && inputFileName.indexOf(',') == -1) {
- if (new File(inputFileName).isDirectory()) {
- return trimAnyPathSep(file.getPath().substring(inputFileName.length()));
- } else {
- if (inputFileName.indexOf(FILE_SEPARATOR.charAt(0)) == -1) {
- return inputFileName;
+ if (shortNames) {
+ if (inputFileName != null) {
+ for (final String prefix : inputFileName.split(",")) {
+ final Path prefPath = Paths.get(prefix).toAbsolutePath();
+ final String prefPathString = prefPath.toString();
+ final String absoluteFilePath = file.getAbsolutePath();
+
+ if (absoluteFilePath.startsWith(prefPathString)) {
+ if (prefPath.toFile().isDirectory()) {
+ return trimAnyPathSep(absoluteFilePath.substring(prefPathString.length()));
+ } else {
+ if (inputFileName.indexOf(FILE_SEPARATOR.charAt(0)) == -1) {
+ return inputFileName;
+ }
+ return trimAnyPathSep(absoluteFilePath.substring(prefPathString.lastIndexOf(FILE_SEPARATOR)));
+ }
+ }
}
- return trimAnyPathSep(inputFileName.substring(inputFileName.lastIndexOf(FILE_SEPARATOR)));
+ } else {
+ // if the 'master' file is not specified, just use the file name
+ return file.getName();
}
}
@@ -59,4 +74,45 @@ private String trimAnyPathSep(String name) {
return name.startsWith(FILE_SEPARATOR) ? name.substring(1) : name;
}
+
+ @Override
+ public String toString() {
+ return new StringBuilder(FileDataSource.class.getSimpleName())
+ .append('[')
+ .append(file.getPath())
+ .append(']')
+ .toString();
+ }
+
+ @Override
+ public int hashCode() {
+ final int prime = 31;
+ int result = 1;
+ result = prime * result + ((file == null) ? 0 : file.hashCode());
+ return result;
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (this == obj) {
+ return true;
+ }
+ if (obj == null) {
+ return false;
+ }
+ if (getClass() != obj.getClass()) {
+ return false;
+ }
+ FileDataSource other = (FileDataSource) obj;
+ if (file == null) {
+ if (other.file != null) {
+ return false;
+ }
+ } else if (!file.equals(other.file)) {
+ return false;
+ }
+ return true;
+ }
+
+
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/datasource/ReaderDataSource.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/datasource/ReaderDataSource.java
index fe8d819a59d..a05632dbeab 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/datasource/ReaderDataSource.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/datasource/ReaderDataSource.java
@@ -17,7 +17,7 @@ public class ReaderDataSource implements DataSource {
/**
* Reader
*/
- private Reader reader;
+ private final Reader reader;
/**
* Real or pseudo filename or path name.
@@ -86,6 +86,10 @@ public void setDataSourceName(String dataSourceName) {
@Override
public String toString() {
- return dataSourceName;
+ return new StringBuilder(ReaderDataSource.class.getSimpleName())
+ .append('[')
+ .append(dataSourceName)
+ .append(']')
+ .toString();
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/datasource/ZipDataSource.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/datasource/ZipDataSource.java
index 7667f7705a9..f24ea8b051f 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/datasource/ZipDataSource.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/datasource/ZipDataSource.java
@@ -13,8 +13,8 @@
* DataSource implementation to read data from an entry in a zip or jar file.
*/
public class ZipDataSource implements DataSource {
- private ZipFile zipFile;
- private ZipEntry zipEntry;
+ private final ZipFile zipFile;
+ private final ZipEntry zipEntry;
/**
* @param zipFile
@@ -37,4 +37,53 @@ public String getNiceFileName(boolean shortNames, String inputFileName) {
// FIXME: this could probably be done better
return zipFile.getName() + ":" + zipEntry.getName();
}
+
+ @Override
+ public String toString() {
+ return new StringBuilder(ZipDataSource.class.getSimpleName())
+ .append('[')
+ .append(zipFile.getName())
+ .append('!')
+ .append(zipEntry.getName())
+ .append(']')
+ .toString();
+ }
+
+ @Override
+ public int hashCode() {
+ final int prime = 31;
+ int result = 1;
+ result = prime * result + ((zipEntry == null) ? 0 : zipEntry.getName().hashCode());
+ result = prime * result + ((zipFile == null) ? 0 : zipFile.getName().hashCode());
+ return result;
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (this == obj) {
+ return true;
+ }
+ if (obj == null) {
+ return false;
+ }
+ if (getClass() != obj.getClass()) {
+ return false;
+ }
+ ZipDataSource other = (ZipDataSource) obj;
+ if (zipEntry == null) {
+ if (other.zipEntry != null) {
+ return false;
+ }
+ } else if (!zipEntry.getName().equals(other.zipEntry.getName())) {
+ return false;
+ }
+ if (zipFile == null) {
+ if (other.zipFile != null) {
+ return false;
+ }
+ } else if (!zipFile.getName().equals(other.zipFile.getName())) {
+ return false;
+ }
+ return true;
+ }
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/CodeEditorTextPane.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/CodeEditorTextPane.java
index cfa96661a81..ac13ce6ef5f 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/CodeEditorTextPane.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/CodeEditorTextPane.java
@@ -8,6 +8,7 @@
import net.sourceforge.pmd.lang.ast.Node;
+@Deprecated // to be removed with PMD 7.0.0
public class CodeEditorTextPane extends JTextPane implements LineGetter {
private String[] getLines() {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/CreateXMLRulePanel.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/CreateXMLRulePanel.java
index 006f421e530..fe8475bfc51 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/CreateXMLRulePanel.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/CreateXMLRulePanel.java
@@ -8,7 +8,6 @@
import java.awt.GridBagLayout;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
-
import javax.swing.JButton;
import javax.swing.JLabel;
import javax.swing.JPanel;
@@ -24,6 +23,7 @@
* This class is responsible for creating the contentpanel for the Create Rule
* XML Frame.
*/
+@Deprecated // to be removed with PMD 7.0.0
public class CreateXMLRulePanel extends JPanel implements ActionListener {
private JTextField rulenameField = new JTextField(30);
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/DFAPanel.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/DFAPanel.java
index 9430ef18298..2e7dec8bf99 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/DFAPanel.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/DFAPanel.java
@@ -10,7 +10,6 @@
import java.awt.FontMetrics;
import java.awt.Graphics;
import java.util.List;
-
import javax.swing.BorderFactory;
import javax.swing.DefaultListModel;
import javax.swing.JComponent;
@@ -29,6 +28,7 @@
import net.sourceforge.pmd.lang.dfa.VariableAccess;
import net.sourceforge.pmd.util.StringUtil;
+@Deprecated // to be removed with PMD 7.0.0
public class DFAPanel extends JComponent implements ListSelectionListener {
public static class DFACanvas extends JPanel {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/Designer.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/Designer.java
index dceb47a3c12..c3c683ec44b 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/Designer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/Designer.java
@@ -35,7 +35,6 @@
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
-
import javax.swing.AbstractAction;
import javax.swing.AbstractButton;
import javax.swing.ActionMap;
@@ -93,7 +92,6 @@
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
-import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.StringUtils;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
@@ -102,6 +100,7 @@
import net.sourceforge.pmd.PMD;
import net.sourceforge.pmd.PMDConfiguration;
+import net.sourceforge.pmd.PMDVersion;
import net.sourceforge.pmd.RuleContext;
import net.sourceforge.pmd.RuleSet;
import net.sourceforge.pmd.RuleSetFactory;
@@ -124,6 +123,7 @@
import net.sourceforge.pmd.lang.symboltable.ScopedNode;
import net.sourceforge.pmd.lang.xpath.Initializer;
+@Deprecated // to be removed with PMD 7.0.0
public class Designer implements ClipboardOwner {
private boolean exitOnClose = true;
@@ -134,7 +134,7 @@ public class Designer implements ClipboardOwner {
private final JTextArea xpathQueryArea = new JTextArea(15, 30);
private final ButtonGroup xpathVersionButtonGroup = new ButtonGroup();
private final TreeWidget symbolTableTreeWidget = new TreeWidget(new Object[0]);
- private final JFrame frame = new JFrame("PMD Rule Designer (v " + PMD.VERSION + ')');
+ private final JFrame frame = new JFrame("PMD Rule Designer (v " + PMDVersion.VERSION + ')');
private final DFAPanel dfaPanel = new DFAPanel();
private final JRadioButtonMenuItem[] languageVersionMenuItems = new JRadioButtonMenuItem[getSupportedLanguageVersions().length];
private static final String SETTINGS_FILE_NAME = System.getProperty("user.home")
@@ -221,7 +221,7 @@ private static LanguageVersion[] getSupportedLanguageVersions() {
}
}
}
- return languageVersions.toArray(new LanguageVersion[languageVersions.size()]);
+ return languageVersions.toArray(new LanguageVersion[0]);
}
private LanguageVersion getLanguageVersion() {
@@ -311,7 +311,7 @@ public String label() {
@Override
public Enumeration children() {
- Enumeration e = new Enumeration() {
+ return new Enumeration() {
int i = 0;
@Override
@@ -324,7 +324,6 @@ public ExceptionNode nextElement() {
return kids[i++];
}
};
- return e;
}
@Override
@@ -394,7 +393,7 @@ public Enumeration children() {
getChildAt(0); // force it to build kids
}
- Enumeration e = new Enumeration() {
+ return new Enumeration() {
int i = 0;
@Override
@@ -407,7 +406,6 @@ public ASTTreeNode nextElement() {
return kids[i++];
}
};
- return e;
}
@Override
@@ -911,6 +909,7 @@ public void actionPerformed(ActionEvent evt) {
undoManager.undo();
}
} catch (CannotUndoException e) {
+ throw new RuntimeException(e);
}
}
});
@@ -924,6 +923,7 @@ public void actionPerformed(ActionEvent evt) {
undoManager.redo();
}
} catch (CannotRedoException e) {
+ throw new RuntimeException(e);
}
}
});
@@ -987,15 +987,14 @@ private static String getXmlString(Node node) throws TransformerException {
@Override
public void lostOwnership(Clipboard clipboard, Transferable contents) {
+ // ignored
}
private void loadSettings() {
- InputStream stream = null;
- try {
- File file = new File(SETTINGS_FILE_NAME);
- if (file.exists()) {
+ File file = new File(SETTINGS_FILE_NAME);
+ if (file.exists()) {
+ try (InputStream stream = new FileInputStream(file)) {
DocumentBuilder builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
- stream = new FileInputStream(file);
Document document = builder.parse(stream);
Element settingsElement = document.getDocumentElement();
Element codeElement = (Element) settingsElement.getElementsByTagName("code").item(0);
@@ -1016,15 +1015,13 @@ private void loadSettings() {
break;
}
}
+ } catch (ParserConfigurationException e) {
+ e.printStackTrace();
+ } catch (IOException e) {
+ e.printStackTrace();
+ } catch (SAXException e) {
+ e.printStackTrace();
}
- } catch (ParserConfigurationException e) {
- e.printStackTrace();
- } catch (IOException e) {
- e.printStackTrace();
- } catch (SAXException e) {
- e.printStackTrace();
- } finally {
- IOUtils.closeQuietly(stream);
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/LineGetter.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/LineGetter.java
index fcd7743007b..4e657341fc6 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/LineGetter.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/designer/LineGetter.java
@@ -4,6 +4,7 @@
package net.sourceforge.pmd.util.designer;
+@Deprecated // to be removed with PMD 7.0.0
public interface LineGetter {
String getLine(int number);
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/filter/AbstractDelegateFilter.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/filter/AbstractDelegateFilter.java
index 96ad9cb7c4a..eea8ddf9a3f 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/filter/AbstractDelegateFilter.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/filter/AbstractDelegateFilter.java
@@ -15,6 +15,7 @@ public abstract class AbstractDelegateFilter implements Filter {
protected Filter filter;
public AbstractDelegateFilter() {
+ // default constructor
}
public AbstractDelegateFilter(Filter filter) {
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/filter/FileExtensionFilter.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/filter/FileExtensionFilter.java
index f0b18afc68c..ef6e5bae516 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/filter/FileExtensionFilter.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/filter/FileExtensionFilter.java
@@ -5,6 +5,7 @@
package net.sourceforge.pmd.util.filter;
import java.io.File;
+import java.util.Locale;
public class FileExtensionFilter implements Filter {
protected final String[] extensions;
@@ -25,7 +26,7 @@ public FileExtensionFilter(boolean ignoreCase, String... extensions) {
this.ignoreCase = ignoreCase;
if (ignoreCase) {
for (int i = 0; i < this.extensions.length; i++) {
- this.extensions[i] = this.extensions[i].toUpperCase();
+ this.extensions[i] = this.extensions[i].toUpperCase(Locale.ROOT);
}
}
}
@@ -36,7 +37,7 @@ public boolean filter(File file) {
if (!accept) {
for (String extension : extensions) {
String name = file.getName();
- if (ignoreCase ? name.toUpperCase().endsWith(extension) : name.endsWith(extension)) {
+ if (ignoreCase ? name.toUpperCase(Locale.ROOT).endsWith(extension) : name.endsWith(extension)) {
accept = true;
break;
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/filter/Filters.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/filter/Filters.java
index 9e8fecd3095..7bd9b0c6304 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/filter/Filters.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/filter/Filters.java
@@ -14,7 +14,7 @@
* Utility class for working with Filters. Contains builder style methods, apply
* methods, as well as mechanisms for adapting Filters and FilenameFilters.
*/
-public class Filters {
+public final class Filters {
private Filters() { }
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/filter/RegexStringFilter.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/filter/RegexStringFilter.java
index 606416d5494..93fa19c2a98 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/filter/RegexStringFilter.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/filter/RegexStringFilter.java
@@ -67,7 +67,7 @@ protected void optimize() {
} else {
try {
this.pattern = Pattern.compile(this.regex);
- } catch (PatternSyntaxException e) {
+ } catch (PatternSyntaxException ignored) {
// If the regular expression is invalid, then pattern will be
// null.
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/log/AntLogHandler.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/log/AntLogHandler.java
index fe15dba4440..26c29b702a2 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/log/AntLogHandler.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/log/AntLogHandler.java
@@ -6,12 +6,18 @@
import java.io.PrintWriter;
import java.io.StringWriter;
+import java.lang.reflect.Field;
+import java.lang.reflect.Method;
import java.util.logging.Formatter;
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.LogRecord;
+import org.apache.tools.ant.BuildListener;
+import org.apache.tools.ant.DefaultLogger;
import org.apache.tools.ant.Project;
+import org.apache.tools.ant.XmlLogger;
+import org.apache.tools.ant.taskdefs.RecorderEntry;
/**
* AntLogHandler sends log messages to an Ant Task, so the regular Ant logging
@@ -22,12 +28,63 @@
public class AntLogHandler extends Handler {
private Project project;
+ private static final Level DEFAULT_LEVEL = Level.WARNING;
+
private static final Formatter FORMATTER = new PmdLogFormatter();
+ // Maps from ant's Project.MSG_* to java.util.logging.Level
+ private static final Level[] LOG_LEVELS = {
+ Level.SEVERE, // Project.MSG_ERR=0
+ Level.WARNING, // Project.MSG_WARN=1
+ Level.INFO, // Project.MSG_INFO=2
+ Level.CONFIG, // Project.MSG_VERBOSE=3
+ Level.FINEST, // Project.MSG_DEBUG=4
+ };
+
public AntLogHandler(Project project) {
this.project = project;
}
+ public Level getAntLogLevel() {
+ for (final BuildListener l : project.getBuildListeners()) {
+ Field declaredField = null;
+ try {
+ if (l instanceof DefaultLogger) {
+ declaredField = DefaultLogger.class.getDeclaredField("msgOutputLevel");
+ } else if (l instanceof XmlLogger) {
+ declaredField = XmlLogger.class.getDeclaredField("msgOutputLevel");
+ } else if (l instanceof RecorderEntry) {
+ declaredField = RecorderEntry.class.getDeclaredField("loglevel");
+ } else if (l.getClass().getName().equals("org.gradle.api.internal.project.ant.AntLoggingAdapter")) {
+ return determineGradleLogLevel(l);
+ } else {
+ try {
+ declaredField = l.getClass().getDeclaredField("logLevel");
+ if (declaredField.getType() != Integer.class && declaredField.getType() != int.class) {
+ declaredField = null;
+ project.log("Unsupported build listener: " + l.getClass(), Project.MSG_DEBUG);
+ }
+ } catch (final NoSuchFieldException e) {
+ project.log("Unsupported build listener: " + l.getClass(), Project.MSG_DEBUG);
+ }
+ }
+
+ if (declaredField != null) {
+ declaredField.setAccessible(true);
+ return LOG_LEVELS[declaredField.getInt(l)];
+ }
+
+ } catch (final ReflectiveOperationException ignored) {
+ // Just ignore it
+ }
+ }
+
+ project.log("Could not determine ant log level, no supported build listeners found. "
+ + "Log level is set to " + DEFAULT_LEVEL, Project.MSG_WARN);
+
+ return DEFAULT_LEVEL;
+ }
+
@Override
public void publish(LogRecord logRecord) {
// Map the log levels from java.util.logging to Ant
@@ -62,9 +119,49 @@ public void publish(LogRecord logRecord) {
@Override
public void close() throws SecurityException {
+ // nothing to do
}
@Override
public void flush() {
+ // nothing to do
+ }
+
+ private Level determineGradleLogLevel(BuildListener l) {
+ try {
+ project.log("Detected gradle AntLoggingAdapter", Project.MSG_DEBUG);
+ Field loggerField = l.getClass().getDeclaredField("logger");
+ loggerField.setAccessible(true);
+ // org.gradle.internal.logging.slf4j.OutputEventListenerBackedLogger
+ Object logger = loggerField.get(l);
+
+ Class gradleLogLevel = l.getClass().getClassLoader().loadClass("org.gradle.api.logging.LogLevel");
+
+ Method isLevelAtMostMethod = logger.getClass().getDeclaredMethod("isLevelAtMost", gradleLogLevel);
+ isLevelAtMostMethod.setAccessible(true);
+
+ Object[] logLevels = gradleLogLevel.getEnumConstants();
+ // the log levels in gradle are declared in the order DEBUG, INFO, LIFECYCLE, WARN, QUIET, ERROR
+ Level[] mapping = new Level[] {
+ Level.FINEST, // DEBUG
+ Level.CONFIG, // INFO
+ Level.INFO, // LIFECYCLE
+ Level.WARNING, // WARN
+ Level.SEVERE, // QUIET
+ Level.SEVERE, // ERROR
+ };
+
+ for (int i = 0; i < Math.min(logLevels.length, mapping.length); i++) {
+ boolean enabled = (boolean) isLevelAtMostMethod.invoke(logger, logLevels[i]);
+ if (enabled) {
+ project.log("Current log level: " + logLevels[i] + " -> " + mapping[i], Project.MSG_DEBUG);
+ return mapping[i];
+ }
+ }
+ } catch (ReflectiveOperationException ignored) {
+ // ignored
+ }
+ project.log("Could not determine log level, falling back to default: " + DEFAULT_LEVEL, Project.MSG_WARN);
+ return DEFAULT_LEVEL;
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/log/ConsoleLogHandler.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/log/ConsoleLogHandler.java
index 1092dddb5d7..8e61d3d27b7 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/log/ConsoleLogHandler.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/log/ConsoleLogHandler.java
@@ -14,7 +14,9 @@
* Log to the console using a basic formatter.
*
* @author Wouter Zelle
+ * @deprecated This class will be complety removed in 7.0.0
*/
+@Deprecated
public class ConsoleLogHandler extends Handler {
private static final Formatter FORMATTER = new PmdLogFormatter();
@@ -35,9 +37,11 @@ public void publish(LogRecord logRecord) {
@Override
public void close() throws SecurityException {
+ // nothing to do
}
@Override
public void flush() {
+ System.out.flush();
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/log/ScopedLogHandlersManager.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/log/ScopedLogHandlersManager.java
index c6e26b6dda6..53cb8249449 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/log/ScopedLogHandlersManager.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/log/ScopedLogHandlersManager.java
@@ -36,7 +36,9 @@ public ScopedLogHandlersManager(Level level, Handler... handlers) {
}
for (Handler handler : newHandlers) {
logger.addHandler(handler);
+ handler.setLevel(level);
}
+ logger.setUseParentHandlers(false);
}
public void close() {
@@ -47,5 +49,6 @@ public void close() {
logger.addHandler(handler);
}
logger.setLevel(oldLogLevel);
+ logger.setUseParentHandlers(true);
}
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/Viewer.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/Viewer.java
index 2ae10bbaa47..a040cef667f 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/Viewer.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/Viewer.java
@@ -13,7 +13,8 @@
* @author Boris Gruschko ( boris at gruschko.org )
* @version $Id$
*/
-public class Viewer {
+@Deprecated // to be removed with PMD 7.0.0
+public final class Viewer {
private Viewer() { }
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/ASTPanel.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/ASTPanel.java
index 778b4c25586..190ce66c797 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/ASTPanel.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/ASTPanel.java
@@ -10,7 +10,6 @@
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
-
import javax.swing.BorderFactory;
import javax.swing.JPanel;
import javax.swing.JPopupMenu;
@@ -35,7 +34,7 @@
* @author Boris Gruschko ( boris at gruschko.org )
* @version $Id$
*/
-
+@Deprecated // to be removed with PMD 7.0.0
public class ASTPanel extends JPanel implements ViewerModelListener, TreeSelectionListener {
private ViewerModel model;
private JTree tree;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/ActionCommands.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/ActionCommands.java
index 17d67665c2b..6f9f13dfc4a 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/ActionCommands.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/ActionCommands.java
@@ -9,7 +9,7 @@
*
* @author Boris Gruschko ( boris at gruschko.org )
*/
-
+@Deprecated // to be removed with PMD 7.0.0
public final class ActionCommands {
public static final String COMPILE_ACTION = "Compile";
public static final String EVALUATE_ACTION = "Evaluate";
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/EvaluationResultsPanel.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/EvaluationResultsPanel.java
index de6dd42be04..d6089da4ba2 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/EvaluationResultsPanel.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/EvaluationResultsPanel.java
@@ -6,7 +6,6 @@
import java.awt.BorderLayout;
import java.util.Vector;
-
import javax.swing.JList;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
@@ -25,6 +24,7 @@
* @author Boris Gruschko ( boris at gruschko.org )
* @version $Id$
*/
+@Deprecated // to be removed with PMD 7.0.0
public class EvaluationResultsPanel extends JPanel implements ViewerModelListener {
private ViewerModel model;
private JList list;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/MainFrame.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/MainFrame.java
index f6ef38715b4..c7cf8dbc699 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/MainFrame.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/MainFrame.java
@@ -8,7 +8,6 @@
import java.awt.FlowLayout;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
-
import javax.swing.ButtonGroup;
import javax.swing.JButton;
import javax.swing.JFrame;
@@ -21,7 +20,7 @@
import javax.swing.SwingConstants;
import javax.swing.WindowConstants;
-import net.sourceforge.pmd.PMD;
+import net.sourceforge.pmd.PMDVersion;
import net.sourceforge.pmd.lang.LanguageRegistry;
import net.sourceforge.pmd.lang.LanguageVersion;
import net.sourceforge.pmd.lang.ast.ParseException;
@@ -35,7 +34,7 @@
*
* @author Boris Gruschko ( boris at gruschko.org )
*/
-
+@Deprecated // to be removed with PMD 7.0.0
public class MainFrame extends JFrame implements ActionListener, ViewerModelListener {
private ViewerModel model;
private SourceCodePanel sourcePanel;
@@ -53,7 +52,7 @@ public class MainFrame extends JFrame implements ActionListener, ViewerModelList
* constructs and shows the frame
*/
public MainFrame() {
- super(NLS.nls("MAIN.FRAME.TITLE") + " (v " + PMD.VERSION + ')');
+ super(NLS.nls("MAIN.FRAME.TITLE") + " (v " + PMDVersion.VERSION + ')');
init();
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/ParseExceptionHandler.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/ParseExceptionHandler.java
index c78b268c453..46a6411d20c 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/ParseExceptionHandler.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/ParseExceptionHandler.java
@@ -8,7 +8,6 @@
import java.awt.FlowLayout;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
-
import javax.swing.BorderFactory;
import javax.swing.JButton;
import javax.swing.JDialog;
@@ -25,7 +24,7 @@
* @author Boris Gruschko ( boris at gruschko.org )
* @version $Id$
*/
-
+@Deprecated // to be removed with PMD 7.0.0
public class ParseExceptionHandler extends JDialog implements ActionListener {
private Exception exc;
private JButton okBtn;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/SourceCodePanel.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/SourceCodePanel.java
index 35f6126627e..b5e1e6ba883 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/SourceCodePanel.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/SourceCodePanel.java
@@ -6,7 +6,6 @@
import java.awt.BorderLayout;
import java.awt.Color;
-
import javax.swing.BorderFactory;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
@@ -27,7 +26,7 @@
* @author Boris Gruschko ( boris at gruschko.org )
* @version $Id$
*/
-
+@Deprecated // to be removed with PMD 7.0.0
public class SourceCodePanel extends JPanel implements ViewerModelListener {
private ViewerModel model;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/XPathPanel.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/XPathPanel.java
index 3cf6b421b40..4c0fe0e7426 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/XPathPanel.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/XPathPanel.java
@@ -5,7 +5,6 @@
package net.sourceforge.pmd.util.viewer.gui;
import java.awt.Dimension;
-
import javax.swing.BorderFactory;
import javax.swing.JScrollPane;
import javax.swing.JTabbedPane;
@@ -23,7 +22,7 @@
* @author Boris Gruschko ( boris at gruschko.org )
* @version $Id$
*/
-
+@Deprecated // to be removed with PMD 7.0.0
public class XPathPanel extends JTabbedPane implements ViewerModelListener {
private ViewerModel model;
private JTextArea xPathArea;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/ASTNodePopupMenu.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/ASTNodePopupMenu.java
index 0b124b53b6b..bc4c2655529 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/ASTNodePopupMenu.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/ASTNodePopupMenu.java
@@ -15,6 +15,7 @@
* @author Boris Gruschko ( boris at gruschko.org )
* @version $Id$
*/
+@Deprecated // to be removed with PMD 7.0.0
public class ASTNodePopupMenu extends JPopupMenu {
private ViewerModel model;
private Node node;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/AttributesSubMenu.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/AttributesSubMenu.java
index 54dd1862b14..0dc6331bd3c 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/AttributesSubMenu.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/AttributesSubMenu.java
@@ -5,7 +5,6 @@
package net.sourceforge.pmd.util.viewer.gui.menu;
import java.text.MessageFormat;
-
import javax.swing.JMenu;
import net.sourceforge.pmd.lang.ast.Node;
@@ -21,6 +20,7 @@
* @author Boris Gruschko ( boris at gruschko.org )
* @version $Id$
*/
+@Deprecated // to be removed with PMD 7.0.0
public class AttributesSubMenu extends JMenu {
private ViewerModel model;
private Node node;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/SimpleNodeSubMenu.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/SimpleNodeSubMenu.java
index d3323aec769..5c084d991ec 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/SimpleNodeSubMenu.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/SimpleNodeSubMenu.java
@@ -5,7 +5,6 @@
package net.sourceforge.pmd.util.viewer.gui.menu;
import java.text.MessageFormat;
-
import javax.swing.JMenu;
import net.sourceforge.pmd.lang.ast.Node;
@@ -18,6 +17,7 @@
* @author Boris Gruschko ( boris at gruschko.org )
* @version $Id$
*/
+@Deprecated // to be removed with PMD 7.0.0
public class SimpleNodeSubMenu extends JMenu {
private ViewerModel model;
private Node node;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/XPathFragmentAddingItem.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/XPathFragmentAddingItem.java
index aac92d912f7..11b0003fb88 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/XPathFragmentAddingItem.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/gui/menu/XPathFragmentAddingItem.java
@@ -6,7 +6,6 @@
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
-
import javax.swing.JMenuItem;
import net.sourceforge.pmd.util.viewer.model.ViewerModel;
@@ -17,6 +16,7 @@
* @author Boris Gruschko ( boris at gruschko.org )
* @version $Id$
*/
+@Deprecated // to be removed with PMD 7.0.0
public class XPathFragmentAddingItem extends JMenuItem implements ActionListener {
private ViewerModel model;
private String fragment;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ASTModel.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ASTModel.java
index de0f82f7de8..72abb21646e 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ASTModel.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ASTModel.java
@@ -6,7 +6,6 @@
import java.util.ArrayList;
import java.util.List;
-
import javax.swing.event.TreeModelEvent;
import javax.swing.event.TreeModelListener;
import javax.swing.tree.TreeModel;
@@ -20,7 +19,7 @@
* @author Boris Gruschko ( boris at gruschko.org )
* @version $Id$
*/
-
+@Deprecated // to be removed with PMD 7.0.0
public class ASTModel implements TreeModel {
private Node root;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/AttributeToolkit.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/AttributeToolkit.java
index cc03f0949f7..aedb293b715 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/AttributeToolkit.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/AttributeToolkit.java
@@ -12,8 +12,8 @@
* @author Boris Gruschko ( boris at gruschko.org )
* @version $Id$
*/
-
-public class AttributeToolkit {
+@Deprecated // to be removed with PMD 7.0.0
+public final class AttributeToolkit {
private AttributeToolkit() { }
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/SimpleNodeTreeNodeAdapter.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/SimpleNodeTreeNodeAdapter.java
index 6190948ba07..c7dd5b4683c 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/SimpleNodeTreeNodeAdapter.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/SimpleNodeTreeNodeAdapter.java
@@ -8,7 +8,6 @@
import java.util.Collections;
import java.util.Enumeration;
import java.util.List;
-
import javax.swing.tree.TreeNode;
import net.sourceforge.pmd.lang.ast.Node;
@@ -19,7 +18,7 @@
* @author Boris Gruschko ( boris at gruschko.org )
* @version $Id$
*/
-
+@Deprecated // to be removed with PMD 7.0.0
public class SimpleNodeTreeNodeAdapter implements TreeNode {
private Node node;
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ViewerModel.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ViewerModel.java
index 93ef74f1f77..4369b7d8ae3 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ViewerModel.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ViewerModel.java
@@ -20,6 +20,7 @@
import net.sourceforge.pmd.lang.ast.ParseException;
import net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator;
+@Deprecated // to be removed with PMD 7.0.0
public class ViewerModel {
private static final Logger LOGGER = Logger.getLogger(ViewerModel.class.getName());
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ViewerModelEvent.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ViewerModelEvent.java
index 0c36a588e13..ab8f8122169 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ViewerModelEvent.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ViewerModelEvent.java
@@ -11,6 +11,7 @@
*
* @author Boris Gruschko ( boris at gruschko.org )
*/
+@Deprecated // to be removed with PMD 7.0.0
public class ViewerModelEvent {
/**
* reason in the case of code recompilation
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ViewerModelListener.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ViewerModelListener.java
index e79e2a51157..a38a3826ab8 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ViewerModelListener.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/model/ViewerModelListener.java
@@ -10,6 +10,7 @@
* @author Boris Gruschko ( boris at gruschko.org )
* @version $Id$
*/
+@Deprecated // to be removed with PMD 7.0.0
public interface ViewerModelListener {
void viewerModelChanged(ViewerModelEvent e);
}
diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/util/NLS.java b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/util/NLS.java
index ed703f9899b..5848281e396 100644
--- a/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/util/NLS.java
+++ b/pmd-core/src/main/java/net/sourceforge/pmd/util/viewer/util/NLS.java
@@ -12,7 +12,8 @@
* @author Boris Gruschko ( boris at gruschko.org )
* @version $Id$
*/
-public class NLS {
+@Deprecated // to be removed with PMD 7.0.0
+public final class NLS {
private static final ResourceBundle BUNDLE;
static {
diff --git a/pmd-core/src/main/resources/ruleset_2_0_0.xsd b/pmd-core/src/main/resources/ruleset_2_0_0.xsd
index d05e3269b4e..2af324694a0 100644
--- a/pmd-core/src/main/resources/ruleset_2_0_0.xsd
+++ b/pmd-core/src/main/resources/ruleset_2_0_0.xsd
@@ -8,83 +8,58 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
-
-
-
-
-
-
+
+
+
+
-
-
+
+
+
+
-
-
-
-
+
+
diff --git a/pmd-core/src/main/resources/ruleset_3_0_0.dtd b/pmd-core/src/main/resources/ruleset_3_0_0.dtd
deleted file mode 100644
index d13028e111c..00000000000
--- a/pmd-core/src/main/resources/ruleset_3_0_0.dtd
+++ /dev/null
@@ -1,33 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/pmd-core/src/main/resources/ruleset_3_0_0.xsd b/pmd-core/src/main/resources/ruleset_3_0_0.xsd
deleted file mode 100644
index f45924922bc..00000000000
--- a/pmd-core/src/main/resources/ruleset_3_0_0.xsd
+++ /dev/null
@@ -1,91 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/pmd-core/src/main/resources/rulesets/internal/all-ecmascript.xml b/pmd-core/src/main/resources/rulesets/internal/all-ecmascript.xml
index f83e1c08f07..e208b7cbb1b 100644
--- a/pmd-core/src/main/resources/rulesets/internal/all-ecmascript.xml
+++ b/pmd-core/src/main/resources/rulesets/internal/all-ecmascript.xml
@@ -3,10 +3,17 @@
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
Every ECMAScript Rule in PMD
-
diff --git a/pmd-core/src/main/resources/rulesets/internal/all-java.xml b/pmd-core/src/main/resources/rulesets/internal/all-java.xml
index c5c86dda10c..569b015ced2 100644
--- a/pmd-core/src/main/resources/rulesets/internal/all-java.xml
+++ b/pmd-core/src/main/resources/rulesets/internal/all-java.xml
@@ -3,33 +3,33 @@
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
Every Java Rule in PMD
- .*/ant/java/EncodingTestClass.java
+ .*/net/sourceforge/pmd/cpd/badandgood/BadFile.java
+
+
+ .*/net/sourceforge/pmd/lang/java/ast/jdkversiontests/assert_test5.java
+ .*/net/sourceforge/pmd/lang/java/ast/jdkversiontests/assert_test5_a.java
+ .*/net/sourceforge/pmd/lang/java/ast/jdkversiontests/assert_test7.java
+ .*/net/sourceforge/pmd/lang/java/ast/jdkversiontests/jdk14_enum.java
+ .*/net/sourceforge/pmd/lang/java/ast/jdkversiontests/jdk9_invalid_identifier.java
+ .*/net/sourceforge/pmd/lang/java/ast/jdkversiontests/java10/LocalVariableTypeInference_varAsAnnotationName.java
+ .*/net/sourceforge/pmd/lang/java/ast/jdkversiontests/java10/LocalVariableTypeInference_varAsEnumName.java
+ .*/net/sourceforge/pmd/lang/java/ast/jdkversiontests/java10/LocalVariableTypeInference_varAsTypeIdentifier.java
+
+
diff --git a/pmd-core/src/main/resources/rulesets/internal/dogfood-goal.xml b/pmd-core/src/main/resources/rulesets/internal/dogfood-goal.xml
deleted file mode 100644
index ff49b78093b..00000000000
--- a/pmd-core/src/main/resources/rulesets/internal/dogfood-goal.xml
+++ /dev/null
@@ -1,119 +0,0 @@
-
-
- Dogfood goal, delete this when we reach it.
-
-
- .*net/sourceforge/pmd/lang/ast/JavaCharStream.java
- .*net/sourceforge/pmd/lang/ast/SimpleCharStream.java
- .*net/sourceforge/pmd/lang/ast/TokenMgrError.java
- .*lang/(java|jsp|cpp)/ast/.*Parser.java
- .*lang/(java|jsp|cpp)/ast/.*ParserConstants.java
- .*lang/(java|jsp|cpp)/ast/.*ParserTokenManager.java
- .*lang/(java|jsp|cpp)/ast/.*ParserTreeConstants.java
- .*lang/(java|jsp|cpp)/ast/.*ParserVisitor.java
- .*lang/(java|jsp|cpp)/ast/JJT.*ParserState.java
- .*lang/(java|jsp|cpp)/ast/ParseException.java
- .*lang/(java|jsp|cpp)/ast/Token.java
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/pmd-core/src/main/resources/rulesets/internal/dogfood.xml b/pmd-core/src/main/resources/rulesets/internal/dogfood.xml
deleted file mode 100644
index 6c0db0f1bd3..00000000000
--- a/pmd-core/src/main/resources/rulesets/internal/dogfood.xml
+++ /dev/null
@@ -1,212 +0,0 @@
-
-
- Rules to check PMD itself. This RuleSet is written to include all Rules,
- and exclude those which we know are explicitly decided as not applicable to PMD itself.
- This is the most encompassing form of RuleSet.
-
-
- .*net/sourceforge/pmd/lang/ast/JavaCharStream.java
- .*net/sourceforge/pmd/lang/ast/SimpleCharStream.java
- .*net/sourceforge/pmd/lang/ast/TokenMgrError.java
- .*lang/(java|jsp|cpp)/ast/.*Parser.java
- .*lang/(java|jsp|cpp)/ast/.*ParserConstants.java
- .*lang/(java|jsp|cpp)/ast/.*ParserTokenManager.java
- .*lang/(java|jsp|cpp)/ast/.*ParserTreeConstants.java
- .*lang/(java|jsp|cpp)/ast/.*ParserVisitor.java
- .*lang/(java|jsp|cpp)/ast/JJT.*ParserState.java
- .*lang/(java|jsp|cpp)/ast/ParseException.java
- .*lang/(java|jsp|cpp)/ast/Token.java
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/pmd-core/src/main/resources/rulesets/internal/pmdspecific.xml b/pmd-core/src/main/resources/rulesets/internal/pmdspecific.xml
deleted file mode 100644
index fa8730ff4cd..00000000000
--- a/pmd-core/src/main/resources/rulesets/internal/pmdspecific.xml
+++ /dev/null
@@ -1,62 +0,0 @@
-
-
-
- These rules check for problems that are specific to the PMD codebase and may not be applicable to other projects.
-
-
- replace o.getClass().equals(MyClass.class) with o instanceof MyClass. Make sure MyClass doesn't have descendants
- 3
-
-
-
-
-
-
-
-
-
-
- replace MyClass.class.equals(o.getClass()) with o instanceof MyClass. Make sure MyClass doesn't have descendants
- 3
-
-
-
-
-
-
-
-
-
-
diff --git a/pmd-core/src/main/resources/rulesets/internal/regress-dogfood-goal.xml b/pmd-core/src/main/resources/rulesets/internal/regress-dogfood-goal.xml
deleted file mode 100644
index c7d472daffc..00000000000
--- a/pmd-core/src/main/resources/rulesets/internal/regress-dogfood-goal.xml
+++ /dev/null
@@ -1,15 +0,0 @@
-
-
-
- Rules to check PMD itself.
-
- .*/xml/.*.java
-
-
-
-
-
diff --git a/pmd-core/src/main/resources/rulesets/internal/regress-dogfood.xml b/pmd-core/src/main/resources/rulesets/internal/regress-dogfood.xml
deleted file mode 100644
index 1b1f8cee07d..00000000000
--- a/pmd-core/src/main/resources/rulesets/internal/regress-dogfood.xml
+++ /dev/null
@@ -1,18 +0,0 @@
-
-
-
- Rules to check PMD itself.
-
- .*/xml/.*.java
-
-
-
-
-
diff --git a/pmd-core/src/main/resources/rulesets/releases/33.xml b/pmd-core/src/main/resources/rulesets/releases/33.xml
index a7cec977773..08d1dcd8bfb 100644
--- a/pmd-core/src/main/resources/rulesets/releases/33.xml
+++ b/pmd-core/src/main/resources/rulesets/releases/33.xml
@@ -3,7 +3,7 @@
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
This ruleset contains links to rules that are new in PMD v3.3
diff --git a/pmd-core/src/main/resources/rulesets/releases/34.xml b/pmd-core/src/main/resources/rulesets/releases/34.xml
index 522db0729a3..8b61c84fcbb 100644
--- a/pmd-core/src/main/resources/rulesets/releases/34.xml
+++ b/pmd-core/src/main/resources/rulesets/releases/34.xml
@@ -3,7 +3,7 @@
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
This ruleset contains links to rules that are new in PMD v3.4
diff --git a/pmd-core/src/main/resources/rulesets/releases/35.xml b/pmd-core/src/main/resources/rulesets/releases/35.xml
index cebee04b68c..7753b454c6e 100644
--- a/pmd-core/src/main/resources/rulesets/releases/35.xml
+++ b/pmd-core/src/main/resources/rulesets/releases/35.xml
@@ -3,7 +3,7 @@
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
This ruleset contains links to rules that are new in PMD v3.5
diff --git a/pmd-core/src/main/resources/rulesets/releases/36.xml b/pmd-core/src/main/resources/rulesets/releases/36.xml
index 4b50e2792bc..8f60abd5944 100644
--- a/pmd-core/src/main/resources/rulesets/releases/36.xml
+++ b/pmd-core/src/main/resources/rulesets/releases/36.xml
@@ -3,7 +3,7 @@
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
This ruleset contains links to rules that are new in PMD v3.6
diff --git a/pmd-core/src/main/resources/rulesets/releases/37-jsp.xml b/pmd-core/src/main/resources/rulesets/releases/37-jsp.xml
index 5fe02d9e81a..96bf1f2492a 100644
--- a/pmd-core/src/main/resources/rulesets/releases/37-jsp.xml
+++ b/pmd-core/src/main/resources/rulesets/releases/37-jsp.xml
@@ -3,7 +3,7 @@
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
This ruleset contains links to JSP rules that are new in PMD v3.7
diff --git a/pmd-core/src/main/resources/rulesets/releases/37.xml b/pmd-core/src/main/resources/rulesets/releases/37.xml
index cc5672cadc5..b037858e3a4 100644
--- a/pmd-core/src/main/resources/rulesets/releases/37.xml
+++ b/pmd-core/src/main/resources/rulesets/releases/37.xml
@@ -3,7 +3,7 @@
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
This ruleset contains links to rules that are new in PMD v3.7
diff --git a/pmd-core/src/main/resources/rulesets/releases/38.xml b/pmd-core/src/main/resources/rulesets/releases/38.xml
index 0a59caaa3bf..b0528c8caa9 100644
--- a/pmd-core/src/main/resources/rulesets/releases/38.xml
+++ b/pmd-core/src/main/resources/rulesets/releases/38.xml
@@ -3,7 +3,7 @@
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
This ruleset contains links to rules that are new in PMD v3.8
diff --git a/pmd-core/src/main/resources/rulesets/releases/39.xml b/pmd-core/src/main/resources/rulesets/releases/39.xml
index 30a6eebf7ea..4e0e276d67c 100644
--- a/pmd-core/src/main/resources/rulesets/releases/39.xml
+++ b/pmd-core/src/main/resources/rulesets/releases/39.xml
@@ -3,7 +3,7 @@
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
This ruleset contains links to rules that are new in PMD v3.9
diff --git a/pmd-core/src/main/resources/rulesets/releases/40rc1.xml b/pmd-core/src/main/resources/rulesets/releases/40rc1.xml
index 5f335ee5f99..132f866adf3 100644
--- a/pmd-core/src/main/resources/rulesets/releases/40rc1.xml
+++ b/pmd-core/src/main/resources/rulesets/releases/40rc1.xml
@@ -3,7 +3,7 @@
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
This ruleset contains links to rules that are new in PMD v4.0rc1
diff --git a/pmd-core/src/main/resources/rulesets/releases/41.xml b/pmd-core/src/main/resources/rulesets/releases/41.xml
index d8308b0d75a..e04c7862e88 100644
--- a/pmd-core/src/main/resources/rulesets/releases/41.xml
+++ b/pmd-core/src/main/resources/rulesets/releases/41.xml
@@ -3,7 +3,7 @@
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
This ruleset contains links to rules that are new in PMD v4.1
diff --git a/pmd-core/src/main/resources/rulesets/releases/42.xml b/pmd-core/src/main/resources/rulesets/releases/42.xml
index b5658742eca..01fe98bc027 100644
--- a/pmd-core/src/main/resources/rulesets/releases/42.xml
+++ b/pmd-core/src/main/resources/rulesets/releases/42.xml
@@ -3,7 +3,7 @@
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
This ruleset contains links to rules that are new in PMD v4.2
diff --git a/pmd-core/src/main/resources/rulesets/releases/50.xml b/pmd-core/src/main/resources/rulesets/releases/50.xml
index 759dce17e93..6be499cf4c0 100644
--- a/pmd-core/src/main/resources/rulesets/releases/50.xml
+++ b/pmd-core/src/main/resources/rulesets/releases/50.xml
@@ -3,7 +3,7 @@
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
This ruleset contains links to rules that are new in PMD v5.0
diff --git a/pmd-core/src/main/resources/rulesets/releases/501.xml b/pmd-core/src/main/resources/rulesets/releases/501.xml
index 7c8daab9c3d..46101afc690 100644
--- a/pmd-core/src/main/resources/rulesets/releases/501.xml
+++ b/pmd-core/src/main/resources/rulesets/releases/501.xml
@@ -3,7 +3,7 @@
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
This ruleset contains links to rules that are new in PMD v5.0.1
diff --git a/pmd-core/src/main/resources/rulesets/releases/510.xml b/pmd-core/src/main/resources/rulesets/releases/510.xml
index 62349ba42b3..82e6c2530e8 100644
--- a/pmd-core/src/main/resources/rulesets/releases/510.xml
+++ b/pmd-core/src/main/resources/rulesets/releases/510.xml
@@ -3,7 +3,7 @@
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
This ruleset contains links to rules that are new in PMD v5.1.0
@@ -31,14 +31,14 @@ This ruleset contains links to rules that are new in PMD v5.1.0
diff --git a/pmd-core/src/main/resources/rulesets/releases/512.xml b/pmd-core/src/main/resources/rulesets/releases/512.xml
index 79a98457d2c..d22d43ac4ab 100644
--- a/pmd-core/src/main/resources/rulesets/releases/512.xml
+++ b/pmd-core/src/main/resources/rulesets/releases/512.xml
@@ -3,7 +3,7 @@
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
This ruleset contains links to rules that are new in PMD v5.1.2
diff --git a/pmd-core/src/main/resources/rulesets/releases/520.xml b/pmd-core/src/main/resources/rulesets/releases/520.xml
index 566e47d79e6..0d85130cd4d 100644
--- a/pmd-core/src/main/resources/rulesets/releases/520.xml
+++ b/pmd-core/src/main/resources/rulesets/releases/520.xml
@@ -3,7 +3,7 @@
+ xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">