[maven-release-plugin] prepare release pmd_releases/6.2.0

Prepare pmd release 6.2.0
Merge branch 'pr-986'
2018-03-26 09:23:14 +02:00 · 2018-03-26 09:17:36 +02:00 · 2018-03-26 09:03:24 +02:00 · 2018-03-25 23:39:14 -03:00 · 2018-03-25 23:37:37 -03:00 · 2018-03-25 14:06:43 +08:00
606 changed files with 15002 additions and 6105 deletions
@@ -3,13 +3,13 @@ sudo: false
 addons:
  apt:
    packages:
-      - oracle-java8-installer
+      - oracle-java9-installer
  ssh_known_hosts:
    - web.sourceforge.net

 language: java

-jdk: oraclejdk8
+jdk: oraclejdk9

 env:
  global:
@@ -58,6 +58,7 @@ notifications:
  email:
    recipients:
    - andreas.dangel@adangel.org
+    - pmd-commits@lists.sourceforge.net
    on_success: always
    on_failure: always
 cache:
@@ -14,6 +14,7 @@ fi
 #
 # for java9: enable all modules.
 # coveralls plugin seems to need java.xml.bind module
-# echo "MAVEN_OPTS='-Xms1g -Xmx1g --add-modules java.se.ee'" > ${HOME}/.mavenrc
+echo "MAVEN_OPTS='-Xms1g -Xmx1g --add-modules java.se.ee'" > ${HOME}/.mavenrc

-./mvnw clean test jacoco:report coveralls:report -Pcoveralls -B -V
+./mvnw clean install -DskipTests=true -Dmaven.javadoc.skip=true -B -V
+./mvnw test jacoco:report coveralls:report -Pcoveralls -B -V
@@ -25,11 +25,7 @@ function push_docs() {
 VERSION=$(./mvnw -q -Dexec.executable="echo" -Dexec.args='${project.version}' --non-recursive org.codehaus.mojo:exec-maven-plugin:1.5.0:exec | tail -1)
 echo "Building PMD ${VERSION} on branch ${TRAVIS_BRANCH}"

-# determine java 7 path
-JAVA7_HOME=$(jdk_switcher home openjdk7)
-
-# TODO : Once we release PMD 6.0.0 and have a compatible PMD plugin, enable PMD once again
-MVN_BUILD_FLAGS="-B -V -Djava7.home=${JAVA7_HOME} -Dpmd.skip=true"
+MVN_BUILD_FLAGS="-B -V"

 if travis_isPullRequest; then

@@ -14,7 +14,7 @@ fi
 #
 # for java9: enable all modules.
 # sonar plugin seems to need java.xml.bind module
-# echo "MAVEN_OPTS='-Xms1g -Xmx1g --add-modules java.se.ee'" > ${HOME}/.mavenrc
+echo "MAVEN_OPTS='-Xms1g -Xmx1g --add-modules java.se.ee'" > ${HOME}/.mavenrc

 # Run the build, truncate output due to Travis log limits
 ./mvnw clean org.jacoco:jacoco-maven-plugin:prepare-agent package sonar:sonar -Dsonar.host.url=https://sonarcloud.io -Dsonar.login=${SONAR_TOKEN} -B -V
@@ -29,10 +29,11 @@ When filing a bug report, please provide as much information as possible, so tha

 ## Documentation

-There is some documentation available under <https://pmd.github.io>. Feel free to create a bug report if
-documentation is missing, incomplete or outdated.
+There is some documentation available under <https://pmd.github.io/pmd>. Feel free to create a bug report if
+documentation is missing, incomplete or outdated. See [Bug reports](#bug-reports).

-The documentation is generated as a maven site, the source is available at: <https://github.com/pmd/pmd/tree/master/src/site>
+The documentation is generated as a Jekyll site, the source is available at: <https://github.com/pmd/pmd/tree/master/docs>. You can find build instructions there.
+For more on contributing documentation check <https://pmd.github.io/pmd/pmd_devdocs_writing_documentation.html>

 ## Questions

@@ -86,7 +86,7 @@ git commit -a -m "Prepare pmd release ${RELEASE_VERSION}"
 (
    echo "Committing current changes (pmd.github.io)"
    cd ../pmd.github.io
-    git add _posts/$(date -u +%d-%m-%Y)-PMD-${RELEASE_VERSION}.md
+    git add _posts/$(date -u +%Y-%m-%d)-PMD-${RELEASE_VERSION}.md
    git commit -a -m "Prepare pmd release ${RELEASE_VERSION}"
    git push
 )
@@ -107,24 +107,26 @@ echo
 cat <<EOF
 PMD ${RELEASE_VERSION} released

-* minor version with lots of bug fixes
-* Release Notes: https://pmd.github.io/pmd-${RELEASE_VERSION}/pmd_release_notes.html
 * Downloads: https://github.com/pmd/pmd/releases/tag/pmd_releases%2F${RELEASE_VERSION}
-* Fixed Bugs: https://sourceforge.net/p/pmd/bugs/milestone/PMD-${RELEASE_VERSION}/
 * Documentation: https://pmd.github.io/pmd-${RELEASE_VERSION}/
+
+And Copy-Paste the release notes
 EOF
 echo
 echo "Press enter to continue..."
 read

 echo
-echo "Check the milestone on sourceforge:"
-echo "<https://sourceforge.net/p/pmd/bugs/milestones>"
+echo "Check the milestone on github:"
+echo "<https://github.com/pmd/pmd/milestones>"
+echo " --> move any open issues to the next milestone, close the current milestone"
+echo " --> Maybe there are some milestones on sourceforge, too: <https://sourceforge.net/p/pmd/bugs/milestones>."
 echo
 echo
 echo
 echo "Prepare Next development version:"
 echo "*   Move version/release info from **docs/pages/release_notes.md** to **docs/pages/release_notes_old.md**."
+echo "*   Update version/date info in **docs/_config.yml**."
 echo "*   Update version/release info in **docs/pages/release_notes.md**."
 echo
 cat <<EOF
@@ -170,7 +172,12 @@ echo
 echo "Send out an announcement mail to the mailing list:"
 echo "To: PMD Developers List <pmd-devel@lists.sourceforge.net>"
 echo "Subject: [ANNOUNCE] PMD ${RELEASE_VERSION} Released"
-echo "Body: !!Copy Changelog!!"
+echo
+echo "    *   Downloads: https://github.com/pmd/pmd/releases/tag/pmd_releases%2F${RELEASE_VERSION}"
+echo "    *   Documentation: https://pmd.github.io/pmd-${RELEASE_VERSION}/"
+echo
+echo "    And Copy-Paste the release notes"
+echo
 echo
 echo
 echo "------------------------------------------"
@@ -1,8 +1,8 @@
 repository: pmd/pmd

 pmd:
-    version: 6.0.1
-    date: 2018-01-21
+    version: 6.2.0
+    date: 2018-03-26

 output: web
 # this property is useful for conditional filtering of content that is separate from the PDF.
@@ -15,30 +15,66 @@ entries:
      url: /tocpage
      output: pdf
      type: frontmatter
-  - title: User Documentation
+  - title: About
    output: web, pdf
    folderitems:
    - title: Introduction
      url: /index.html
      output: web, pdf
      type: homepage
-    - title: Release Notes
+    - title: Release notes
      url: /pmd_release_notes.html
      output: web, pdf
-    - title: Getting Started
+    - title: Getting help
+      url: /pmd_about_help.html
+      output: web, pdf
+  - title: User Documentation
+    output: web, pdf
+    folderitems:
+    - title: Getting started
      url: /pmd_userdocs_getting_started.html
      output: web, pdf
-    - title: Understanding Rulesets
+    - title: Understanding rulesets
      url: /pmd_userdocs_understanding_rulesets.html
      output: web, pdf
-    - title: Best Pratices
+    - title: Making rulesets
+      url: /pmd_userdocs_making_rulesets.html
+      output: web, pdf
+    - title: Using rule properties
+      url: /pmd_userdocs_using_properties.html
+      output: web, pdf
+    - title: Best practices
      url: /pmd_userdocs_best_practices.html
      output: web, pdf
-    - title: Copy-Paste Detection
-      url: /pmd_userdocs_cpd.html
+    - title: Suppressing warnings
+      url: /pmd_userdocs_suppressing_warnings.html
      output: web, pdf
-    - title: Suppressing
-      url: /pmd_userdocs_suppressing.html
+    - title: null
+      output: web, pdf
+      subfolders:
+      - title: Extending PMD
+        output: web, pdf
+        subfolderitems:
+        - title: Writing a rule
+          url: /pmd_userdocs_extending_writing_pmd_rules.html
+          output: web, pdf
+        - title: Writing XPath rules
+          url: /pmd_userdocs_extending_writing_xpath_rules.html
+          output: web, pdf
+        - title: Defining rule properties
+          url: /pmd_userdocs_extending_defining_properties.html
+          output: web, pdf
+        - title: Using and defining code metrics
+          url: /pmd_userdocs_extending_metrics_howto.html
+          output: web, pdf
+        - title: Rule guidelines
+          url: /pmd_userdocs_extending_rule_guidelines.html
+          output: web, pdf
+        - title: Testing your rules
+          url: /pmd_userdocs_extending_testing.html
+          output: web, pdf
+    - title: Copy-paste detection
+      url: /pmd_userdocs_cpd.html
      output: web, pdf
    - title: null
      output: web, pdf
@@ -46,42 +82,18 @@ entries:
      - title: Tools / Integrations
        output: web, pdf
        subfolderitems:
-        - title: Maven PMD Plugin
+        - title: Maven PMD plugin
          output: web, pdf
          url: /pmd_userdocs_tools_maven.html
        - title: Ant
          output: web, pdf
          url: /pmd_userdocs_tools_ant.html
+        - title: CI integrations
+          output: web, pdf
+          url: /pmd_userdocs_tools_ci.html
        - title: Other Tools / Integrations
          output: web, pdf
          url: /pmd_userdocs_tools.html
-    - title: FAQ
-      url: /pmd_userdocs_faq.html
-      output: web, pdf
-    - title: Getting Help
-      url: /pmd_userdocs_help.html
-      output: web, pdf
-    - title: PMD in the press
-      url: /pmd_userdocs_news.html
-      output: web, pdf
-    - title: Products/books related to PMD
-      url: /pmd_userdocs_products.html
-      output: web, pdf
-    - title: Similar Projects
-      url: /pmd_userdocs_similarprojects.html
-      output: web, pdf
-    - title: License
-      url: /license.html
-      output: web, pdf
-    - title: Credits
-      url: /pmd_userdocs_credits.html
-      output: web, pdf
-    - title: What does 'PMD' mean?
-      url: /pmd_userdocs_meaning.html
-      output: web, pdf
-    - title: Old Release Notes
-      url: /pmd_release_notes_old.html
-      output: web, pdf
  - title: Rule Reference
    output: web, pdf
    folderitems:
@@ -289,64 +301,82 @@ entries:
  - title: Developer Documentation
    output: web, pdf
    folderitems:
-    - title: Developer Resources
+    - title: Developer resources
      url: /pmd_devdocs_development.html
      output: web, pdf
-    - title: Writing Documentation
-      url: /pmd_devdocs_writing_documentation.html
-      output: web, pdf
-    - title: Code Style
-      url: /pmd_devdocs_codestyle.html
-      output: web, pdf
-    - title: Setting up your IDE
-      url: /pmd_devdocs_setting_up_ide.html
-      output: web, pdf
-    - title: Pull Requests
-      url: /pmd_devdocs_pull_requests.html
-      output: web, pdf
    - title: Building PMD from source
      url: /pmd_devdocs_building.html
      output: web, pdf
-    - title: Testing / Test Framework
-      url: /pmd_devdocs_testing.html
+    - title: Contributing
+      url: /pmd_devdocs_contributing.html
      output: web, pdf
-    - title: Releasing
-      url: /pmd_devdocs_releasing.html
-      output: web, pdf
-    - title: Architecture
-      url: /pmd_devdocs_architecture.html
+    - title: Writing documentation
+      url: /pmd_devdocs_writing_documentation.html
      output: web, pdf
    - title: Roadmap
      url: /pmd_devdocs_roadmap.html
      output: web, pdf
-    - title: How PMD Works
+    - title: How PMD works
      url: /pmd_devdocs_how_pmd_works.html
      output: web, pdf
-    - title: Writing a Rule
-      url: /pmd_devdocs_writing_pmd_rules.html
+    - title: null
      output: web, pdf
-    - title: Writing XPath Rules
-      url: /pmd_devdocs_writing_xpath_rules.html
+      subfolders:
+      - title: Major contributions
+        output: web, pdf
+        subfolderitems:
+        - title: Adding a new language
+          url: /pmd_devdocs_major_adding_new_language.html
+          output: web, pdf
+        - title: Adding a new CPD language
+          url: /pmd_devdocs_major_adding_new_cpd_language.html
+          output: web, pdf
+        - title: Adding metrics support to a language
+          url: /pmd_devdocs_major_adding_new_metrics_framework.html
+          output: web, pdf
+  - title: Project documentation
+    output: web, pdf
+    folderitems:
+    - title: null
      output: web, pdf
-    - title: Using code metrics in custom rules
-      url: /pmd_devdocs_metrics_howto.html
+      subfolders:
+      - title: Trivia about PMD
+        output: web, pdf
+        subfolderitems:
+        - title: PMD in the press
+          url: /pmd_projectdocs_trivia_news.html
+          output: web, pdf
+        - title: Products & books related to PMD
+          url: /pmd_projectdocs_trivia_products.html
+          output: web, pdf
+        - title: Similar projects
+          url: /pmd_projectdocs_trivia_similarprojects.html
+          output: web, pdf
+        - title: What does 'PMD' mean?
+          url: /pmd_projectdocs_trivia_meaning.html
+          output: web, pdf
+    - title: FAQ
+      url: /pmd_projectdocs_faq.html
      output: web, pdf
-    - title: Making Rulesets
-      url: /pmd_devdocs_making_rulesets.html
+    - title: License
+      url: /license.html
      output: web, pdf
-    - title: Rule Guidelines
-      url: /pmd_devdocs_rule_guidelines.html
+    - title: Credits
+      url: /pmd_projectdocs_credits.html
      output: web, pdf
-    - title: Working with properties
-      url: /pmd_devdocs_working_with_properties.html
+    - title: Old release notes
+      url: /pmd_release_notes_old.html
      output: web, pdf
-    - title: Adding a New Language
-      url: /pmd_devdocs_adding_new_language.html
-      output: web, pdf
-    - title: Adding a New CPD Language
-      url: /pmd_devdocs_adding_new_cpd_language.html
-      output: web, pdf
-    - title: Adding metrics support to a language
-      url: /pmd_devdocs_adding_metrics_support_to_language.html
+    - title: null
      output: web, pdf
+      subfolders:
+      - title: Project management
+        output: web, pdf
+        subfolderitems:
+        - title: Release process
+          url: /pmd_projectdocs_committers_releasing.html
+          output: web, pdf
+        - title: Merging pull requests
+          url: /pmd_projectdocs_committers_merging_pull_requests.html
+          output: web, pdf

@@ -1,6 +1,6 @@
 ---
 title: Getting Help
-permalink: pmd_userdocs_help.html
+permalink: pmd_about_help.html
 author: Andreas Dangel <andreas.dangel@adangel.org>
 last_updated: September 2017
 ---
@@ -1,10 +0,0 @@
---
-title: Architecture
-sidebar: pmd_sidebar
-permalink: pmd_devdocs_architecture.html
-folder: pmd/devdocs
---
-
-PMD high-level building blocks
-
-TODO
@@ -4,6 +4,9 @@ permalink: pmd_devdocs_building.html
 author: Tom Copeland, Xavier Le Vourch <xlv@users.sourceforge.net>
 ---

+<!-- Gives visibility -->
+{%include note.html content="TODO add IDE specific indications" %}
+
 # Compiling PMD

 *   JDK 9 or higher
@@ -1,10 +0,0 @@
---
-title: Code Style
-sidebar: pmd_sidebar
-permalink: pmd_devdocs_codestyle.html
-folder: pmd/devdocs
---
-
-TODO
-
-*   Checkstyle
@@ -0,0 +1,24 @@
+---
+title: Contributing to PMD
+sidebar: pmd_sidebar
+permalink: pmd_devdocs_contributing.html
+folder: pmd/devdocs
+---
+
+## Contributing via pull requests
+
+First off, thanks for taking the time to contribute!
+
+*   Please create your pull request against the `master` branch. We will rebase/merge it to the maintenance
+    branches, if necessary. Just fork the [pmd repo](https://github.com/pmd/pmd/) and
+    create a [pull request](https://github.com/pmd/pmd/pulls).
+
+*   We are using [checkstyle](http://checkstyle.sourceforge.net/) to enforce a common code style.
+    The check is integrated into the default build - so, make sure, you can [build PMD](pmd_devdocs_building.html)
+    without errors.
+
+    The following section goes into more details about our Checkstyle configuration.
+
+## Code style
+
+*   Checkstyle
@@ -1,15 +1,13 @@
 ---
-title: PMD How to Add a New CPD Language
-short_title: Add a New CPD Language
+title: How to add a new CPD language
+short_title: Add a new CPD language
 tags: [customizing]
-summary: How to Add a New CPD Language
+summary: How to add a new CPD language
 last_updated: July 3, 2016
-permalink: pmd_devdocs_adding_new_cpd_language.html
+permalink: pmd_devdocs_major_adding_new_cpd_language.html
 author: Romain PELISSE <belaran@gmail.com>
 ---

-# How to Add a New Language to CPD
-
 If you wish CPD to parse a unsupported language, you can easily develop a new parser for CPD. All you need to is implements the following interface:

 *   net.sourceforge.pmd.cpd.Language
@@ -1,15 +1,14 @@
 ---
-title: PMD Adding a New Language
-short_title: Adding a New Language
+title: Adding PMD support for a new language
+short_title: Adding a new language
 tags: [customizing]
-summary: Adding a New Language to PMD
+summary: "How to add a new language to PMD."
 last_updated: July 3, 2016
 sidebar: pmd_sidebar
-permalink: pmd_devdocs_adding_new_language.html
+permalink: pmd_devdocs_major_adding_new_language.html
 folder: pmd/devdocs
 ---

-# How to Add a New Language to PMD

 ## 1.  Start with a new sub-module.
 *    See pmd-java or pmd-vm for examples.
@@ -6,7 +6,7 @@ summary: "PMD's Java module has an extensive framework for the calculation of me
 to implement and use new code metrics very simply. Most of the functionality of this framework is abstracted in such
 a way that any PMD supported language can implement such a framework without too much trouble. Here's how."
 last_updated: December 2017
-permalink: pmd_devdocs_adding_metrics_support_to_language.html
+permalink: pmd_devdocs_major_adding_new_metrics_framework.html
 author: Clément Fournier <clement.fournier76@gmail.com>
 ---

@@ -6,7 +6,9 @@ author: >
    Juan Martín Sotuyo Dodero <juansotuyo@gmail.com>, Andreas Dangel <adangel@users.sourceforge.net>
 ---

+TODO:

+* Update
 * Future direction
 * projects, plans
 * Google Summer of Code
@@ -1,6 +0,0 @@
---
-title: Setting up your IDE
-sidebar: pmd_sidebar
-permalink: pmd_devdocs_setting_up_ide.html
-folder: pmd/devdocs
---
@@ -1,5 +1,5 @@
 ---
-title: Writing Documentation
+title: Writing documentation
 last_update: August 2017
 permalink: pmd_devdocs_writing_documentation.html
 keywords: documentation, jekyll, markdown
@@ -17,13 +17,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:
+```
+<rule ...>
+ <description>
+ <![CDATA[
+   Full description, can contain markup
+
+   And paragraphs
+ ]]>
+ </description>
+ ...
+</rule>
+```
+
 ## Building

 There are two ways, to execute jekyll:
@@ -1,27 +1,11 @@
 ---
-title: Pull-Request Merge
-permalink: pmd_devdocs_pull_requests.html
+title: Merging pull requests
+permalink: pmd_projectdocs_committers_merging_pull_requests.html
 last_updated: August 2017
 author: Andreas Dangel <andreas.dangel@adangel.org>
 ---

-## Contributing via pull requests
-
-First off, thanks for taking the time to contribute!
-
-*   Please create your pull request against the `master` branch. We will rebase/merge it to the maintenance
-    branches, if necessary. Just fork the [pmd repo](https://github.com/pmd/pmd/) and
-    create a [pull request](https://github.com/pmd/pmd/pulls).
-
-*   We are using [checkstyle](http://checkstyle.sourceforge.net/) to enforce a common code style.
-    The check is integrated into the default build - so, make sure, you can [build PMD](pmd_devdocs_building.html)
-    without errors.
-
-    See [code style](pmd_devdocs_codestyle.html) for more info.
-
-## Merging pull requests
-
-### Example 1: Merging PR #123 into master
+## Example 1: Merging PR #123 into master

 1.  Review the pull request

@@ -81,12 +65,12 @@ First off, thanks for taking the time to contribute!
    `git branch -d pr-123`.


-### Example 2: Merging PR #124 into a maintenance branch
+## 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
+### 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
@@ -107,7 +91,7 @@ PMD version 5.8.0, so that we can create a bugfix release 5.8.1.
    git commit -m "prepare next version 5.8.1-SNAPSHOT"
    ```

-#### Merging the PR
+### Merging the PR

 1.  As above: Review the PR

@@ -143,7 +127,7 @@ PMD version 5.8.0, so that we can create a bugfix release 5.8.1.
    You need to manually close the pull request. Leave a comment, that it has been
    rebased onto the maintenance branch.

-#### Merging into master
+### 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):
@@ -164,7 +148,7 @@ We could avoid this by merging only the temporary branch \"pr-124\" into each ma
 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
+### 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
@@ -1,6 +1,6 @@
 ---
 title: Releasing
-permalink: pmd_devdocs_releasing.html
+permalink: pmd_projectdocs_committers_releasing.html
 author: Romain Pelisse <rpelisse@users.sourceforge.net>, Andreas Dangel <adangel@users.sourceforge.net>
 ---

@@ -1,6 +1,6 @@
 ---
 title: Credits
-permalink: pmd_userdocs_credits.html
+permalink: pmd_projectdocs_credits.html
 author: Tom Copeland <tom@infoether.org>
 ---

@@ -1,7 +1,7 @@
 ---
 title: FAQ
 sidebar: pmd_sidebar
-permalink: pmd_userdocs_faq.html
+permalink: pmd_projectdocs_faq.html
 folder: pmd/userdocs
 ---

@@ -1,6 +1,6 @@
 ---
 title: What does 'PMD' mean?
-permalink: pmd_userdocs_meaning.html
+permalink: pmd_projectdocs_trivia_meaning.html
 author: David Dixon-Peugh
 ---

@@ -1,6 +1,6 @@
 ---
 title: PMD in the press
-permalink: pmd_userdocs_news.html
+permalink: pmd_projectdocs_trivia_news.html
 author: Tom Copeland <tom@infoether.org>
 ---

@@ -1,6 +1,6 @@
 ---
 title: Products/books related to PMD
-permalink: pmd_userdocs_products.html
+permalink: pmd_projectdocs_trivia_products.html
 author: Tom Copeland <tom@infoether.org>
 ---

@@ -1,6 +1,6 @@
 ---
 title: Similar projects
-permalink: pmd_userdocs_similarprojects.html
+permalink: pmd_projectdocs_trivia_similarprojects.html
 author: Tom Copeland <tom@infoether.org>, David Dixon-Peugh <ddp@apache.org>
 ---

@@ -16,6 +16,7 @@ author: Tom Copeland <tom@infoether.org>, David Dixon-Peugh <ddp@apache.org>
    Uses Java Modeling Language annotations.
 *   <a href="http://findbugs.sourceforge.net/">FindBugs</a> - works on bytecode, uses BCEL.  Source code uses
    templates, nifty stuff!
+*   <a href="https://spotbugs.github.io/">SpotBugs</a> - SpotBugs is the spiritual successor of FindBugs, carrying on from the point where it left off with support of its community. 
 *   <a href="http://www.hammurapi.biz/hammurapi-biz/ef/xmenu/hammurapi-group/products/hammurapi/index.html">Hammurapi</a> -
    Uses ANTLR, excellent documentation, lots of rules
 *   <a href="http://grothoff.org/christian/xtc/jamit/">Jamit</a> - bytecode analyzer, nice graphs
@@ -30,6 +30,7 @@ folder: pmd/rules
 *   [JUnitUseExpected](pmd_rules_java_bestpractices.html#junituseexpected): In JUnit4, use the @Test(expected) annotation to denote tests that should throw exceptions.
 *   [LooseCoupling](pmd_rules_java_bestpractices.html#loosecoupling): The use of implementation types (i.e., HashSet) as object references limits your ability to use a...
 *   [MethodReturnsInternalArray](pmd_rules_java_bestpractices.html#methodreturnsinternalarray): Exposing internal arrays to the caller violates object encapsulation since elements can be remove...
+*   [MissingOverride](pmd_rules_java_bestpractices.html#missingoverride): Annotating overridden methods with @Override ensures at compile time that            the method r...
 *   [OneDeclarationPerLine](pmd_rules_java_bestpractices.html#onedeclarationperline): Java allows the use of several variables declaration of the same type on one line. However, itcan...
 *   [PositionLiteralsFirstInCaseInsensitiveComparisons](pmd_rules_java_bestpractices.html#positionliteralsfirstincaseinsensitivecomparisons): Position literals first in comparisons, if the second argument is null then NullPointerExceptions...
 *   [PositionLiteralsFirstInComparisons](pmd_rules_java_bestpractices.html#positionliteralsfirstincomparisons): Position literals first in comparisons, if the second argument is null then NullPointerExceptions...
@@ -68,6 +69,7 @@ folder: pmd/rules
 *   [ClassNamingConventions](pmd_rules_java_codestyle.html#classnamingconventions): Class names should always begin with an upper case character.
 *   [CommentDefaultAccessModifier](pmd_rules_java_codestyle.html#commentdefaultaccessmodifier): To avoid mistakes if we want that a Method, Constructor, Field or Nested class have a default acc...
 *   [ConfusingTernary](pmd_rules_java_codestyle.html#confusingternary): Avoid negation within an "if" expression with an "else" clause.  For example, rephrase:'if (x != ...
+*   [ControlStatementBraces](pmd_rules_java_codestyle.html#controlstatementbraces): Enforce a policy for braces on control statements. It is recommended to use braces on 'if ... els...
 *   [DefaultPackage](pmd_rules_java_codestyle.html#defaultpackage): Use explicit scoping instead of accidental usage of default package private level.The rule allows...
 *   [DontImportJavaLang](pmd_rules_java_codestyle.html#dontimportjavalang): Avoid importing anything from the package 'java.lang'.  These classes are automatically imported ...
 *   [DuplicateImports](pmd_rules_java_codestyle.html#duplicateimports): Duplicate or overlapping import statements should be avoided.
@@ -75,10 +77,10 @@ folder: pmd/rules
 *   [ExtendsObject](pmd_rules_java_codestyle.html#extendsobject): No need to explicitly extend Object.
 *   [FieldDeclarationsShouldBeAtStartOfClass](pmd_rules_java_codestyle.html#fielddeclarationsshouldbeatstartofclass): Fields should be declared at the top of the class, before any method declarations, constructors, ...
 *   [ForLoopShouldBeWhileLoop](pmd_rules_java_codestyle.html#forloopshouldbewhileloop): Some for loops can be simplified to while loops, this makes them more concise.
-*   [ForLoopsMustUseBraces](pmd_rules_java_codestyle.html#forloopsmustusebraces): Avoid using 'for' statements without using curly braces. If the code formatting or indentation is...
+*   [ForLoopsMustUseBraces](pmd_rules_java_codestyle.html#forloopsmustusebraces): <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> Avoid using 'for' statements without using curly braces. If the code formatting or indentation is...
 *   [GenericsNaming](pmd_rules_java_codestyle.html#genericsnaming): Names for references to generic values should be limited to a single uppercase letter.
-*   [IfElseStmtsMustUseBraces](pmd_rules_java_codestyle.html#ifelsestmtsmustusebraces): Avoid using if..else statements without using surrounding braces. If the code formatting or inden...
-*   [IfStmtsMustUseBraces](pmd_rules_java_codestyle.html#ifstmtsmustusebraces): Avoid using if statements without using braces to surround the code block. If the code formatting...
+*   [IfElseStmtsMustUseBraces](pmd_rules_java_codestyle.html#ifelsestmtsmustusebraces): <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> Avoid using if..else statements without using surrounding braces. If the code formatting or inden...
+*   [IfStmtsMustUseBraces](pmd_rules_java_codestyle.html#ifstmtsmustusebraces): <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> Avoid using if statements without using braces to surround the code block. If the code formatting...
 *   [LocalHomeNamingConvention](pmd_rules_java_codestyle.html#localhomenamingconvention): The Local Home interface of a Session EJB should be suffixed by 'LocalHome'.
 *   [LocalInterfaceSessionNamingConvention](pmd_rules_java_codestyle.html#localinterfacesessionnamingconvention): The Local Interface of a Session EJB should be suffixed by 'Local'.
 *   [LocalVariableCouldBeFinal](pmd_rules_java_codestyle.html#localvariablecouldbefinal): A local variable assigned only once can be declared final.
@@ -98,6 +100,7 @@ folder: pmd/rules
 *   [ShortVariable](pmd_rules_java_codestyle.html#shortvariable): Fields, local variables, or parameter names that are very short are not helpful to the reader.
 *   [SuspiciousConstantFieldName](pmd_rules_java_codestyle.html#suspiciousconstantfieldname): Field names using all uppercase characters - Sun's Java naming conventions indicating constants -...
 *   [TooManyStaticImports](pmd_rules_java_codestyle.html#toomanystaticimports): If you overuse the static import feature, it can make your program unreadable and unmaintainable,...
+*   [UnnecessaryAnnotationValueElement](pmd_rules_java_codestyle.html#unnecessaryannotationvalueelement): Avoid the use of value in annotations when it's the only element.
 *   [UnnecessaryConstructor](pmd_rules_java_codestyle.html#unnecessaryconstructor): This rule detects when a constructor is not necessary; i.e., when there is only one constructor,i...
 *   [UnnecessaryFullyQualifiedName](pmd_rules_java_codestyle.html#unnecessaryfullyqualifiedname): Import statements allow the use of non-fully qualified names.  The use of a fully qualified namew...
 *   [UnnecessaryLocalBeforeReturn](pmd_rules_java_codestyle.html#unnecessarylocalbeforereturn): Avoid the creation of unnecessary local variables
@@ -106,7 +109,7 @@ folder: pmd/rules
 *   [UselessParentheses](pmd_rules_java_codestyle.html#uselessparentheses): Useless parentheses should be removed.
 *   [UselessQualifiedThis](pmd_rules_java_codestyle.html#uselessqualifiedthis): Look for qualified this usages in the same class.
 *   [VariableNamingConventions](pmd_rules_java_codestyle.html#variablenamingconventions): A variable naming conventions rule - customize this to your liking.  Currently, itchecks for fina...
-*   [WhileLoopsMustUseBraces](pmd_rules_java_codestyle.html#whileloopsmustusebraces): Avoid using 'while' statements without using braces to surround the code block. If the code forma...
+*   [WhileLoopsMustUseBraces](pmd_rules_java_codestyle.html#whileloopsmustusebraces): <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> Avoid using 'while' statements without using braces to surround the code block. If the code forma...

 ## Design

@@ -117,7 +120,7 @@ folder: pmd/rules
 *   [AvoidDeeplyNestedIfStmts](pmd_rules_java_design.html#avoiddeeplynestedifstmts): Avoid creating deeply nested if-then statements since they are harder to read and error-prone to ...
 *   [AvoidRethrowingException](pmd_rules_java_design.html#avoidrethrowingexception): Catch blocks that merely rethrow a caught exception only add to code size and runtime complexity.
 *   [AvoidThrowingNewInstanceOfSameException](pmd_rules_java_design.html#avoidthrowingnewinstanceofsameexception): Catch blocks that merely rethrow a caught exception wrapped inside a new instance of the same typ...
-*   [AvoidThrowingNullPointerException](pmd_rules_java_design.html#avoidthrowingnullpointerexception): Avoid throwing NullPointerExceptions. These are confusing because most people will assume that th...
+*   [AvoidThrowingNullPointerException](pmd_rules_java_design.html#avoidthrowingnullpointerexception): Avoid throwing NullPointerExceptions manually. These are confusing because most people will assum...
 *   [AvoidThrowingRawExceptionTypes](pmd_rules_java_design.html#avoidthrowingrawexceptiontypes): Avoid throwing certain exception types. Rather than throw a raw RuntimeException, Throwable,Excep...
 *   [ClassWithOnlyPrivateConstructorsShouldBeFinal](pmd_rules_java_design.html#classwithonlyprivateconstructorsshouldbefinal): A class with only private constructors should be final, unless the private constructoris invoked ...
 *   [CollapsibleIfStatements](pmd_rules_java_design.html#collapsibleifstatements): Sometimes two consecutive 'if' statements can be consolidated by separating their conditions with...
@@ -213,7 +216,7 @@ folder: pmd/rules
 *   [DontImportSun](pmd_rules_java_errorprone.html#dontimportsun): Avoid importing anything from the 'sun.' packages.  These packages are not portable and are likel...
 *   [DontUseFloatTypeForLoopIndices](pmd_rules_java_errorprone.html#dontusefloattypeforloopindices): Don't use floating point for loop indices. If you must use floating point, use doubleunless you'r...
 *   [EmptyCatchBlock](pmd_rules_java_errorprone.html#emptycatchblock): Empty Catch Block finds instances where an exception is caught, but nothing is done.  In most cir...
-*   [EmptyFinalizer](pmd_rules_java_errorprone.html#emptyfinalizer): Empty finalize methods serve no purpose and should be removed.
+*   [EmptyFinalizer](pmd_rules_java_errorprone.html#emptyfinalizer): Empty finalize methods serve no purpose and should be removed. Note that Oracle has declared Obje...
 *   [EmptyFinallyBlock](pmd_rules_java_errorprone.html#emptyfinallyblock): Empty finally blocks serve no purpose and should be removed.
 *   [EmptyIfStmt](pmd_rules_java_errorprone.html#emptyifstmt): Empty If Statement finds instances where a condition is checked but nothing is done about it.
 *   [EmptyInitializer](pmd_rules_java_errorprone.html#emptyinitializer): Empty initializers serve no purpose and should be removed.
@@ -224,8 +227,8 @@ folder: pmd/rules
 *   [EmptyTryBlock](pmd_rules_java_errorprone.html#emptytryblock): Avoid empty try blocks - what's the point?
 *   [EmptyWhileStmt](pmd_rules_java_errorprone.html#emptywhilestmt): Empty While Statement finds all instances where a while statement does nothing.  If it is a timin...
 *   [EqualsNull](pmd_rules_java_errorprone.html#equalsnull): Tests for null should not use the equals() method. The '==' operator should be used instead.
-*   [FinalizeDoesNotCallSuperFinalize](pmd_rules_java_errorprone.html#finalizedoesnotcallsuperfinalize): If the finalize() is implemented, its last action should be to call super.finalize.
-*   [FinalizeOnlyCallsSuperFinalize](pmd_rules_java_errorprone.html#finalizeonlycallssuperfinalize): If the finalize() is implemented, it should do something besides just calling super.finalize().
+*   [FinalizeDoesNotCallSuperFinalize](pmd_rules_java_errorprone.html#finalizedoesnotcallsuperfinalize): If the finalize() is implemented, its last action should be to call super.finalize. Note that Ora...
+*   [FinalizeOnlyCallsSuperFinalize](pmd_rules_java_errorprone.html#finalizeonlycallssuperfinalize): If the finalize() is implemented, it should do something besides just calling super.finalize(). N...
 *   [FinalizeOverloaded](pmd_rules_java_errorprone.html#finalizeoverloaded): Methods named finalize() should not have parameters.  It is confusing and most likely an attempt ...
 *   [FinalizeShouldBeProtected](pmd_rules_java_errorprone.html#finalizeshouldbeprotected): When overriding the finalize(), the new method should be set as protected.  If made public, other...
 *   [IdempotentOperations](pmd_rules_java_errorprone.html#idempotentoperations): Avoid idempotent operations - they have no effect.
@@ -291,7 +294,7 @@ folder: pmd/rules

 *   [AddEmptyString](pmd_rules_java_performance.html#addemptystring): The conversion of literals to strings by concatenating them with empty strings is inefficient.It ...
 *   [AppendCharacterWithChar](pmd_rules_java_performance.html#appendcharacterwithchar): Avoid concatenating characters as strings in StringBuffer/StringBuilder.append methods.
-*   [AvoidArrayLoops](pmd_rules_java_performance.html#avoidarrayloops): Instead of manually copying data between two arrays, use the efficient System.arraycopy method in...
+*   [AvoidArrayLoops](pmd_rules_java_performance.html#avoidarrayloops): Instead of manually copying data between two arrays, use the efficient Arrays.copyOf or System.ar...
 *   [AvoidFileStream](pmd_rules_java_performance.html#avoidfilestream): The FileInputStream and FileOutputStream classes contains a finalizer method which will cause gar...
 *   [AvoidInstantiatingObjectsInLoops](pmd_rules_java_performance.html#avoidinstantiatingobjectsinloops): New objects created within loops should be checked to see if they can created outside them and re...
 *   [AvoidUsingShortType](pmd_rules_java_performance.html#avoidusingshorttype): Java uses the 'short' type to reduce memory usage, not to optimize calculation. In fact, the JVM ...
@@ -299,7 +302,7 @@ folder: pmd/rules
 *   [BooleanInstantiation](pmd_rules_java_performance.html#booleaninstantiation): Avoid instantiating Boolean objects; you can reference Boolean.TRUE, Boolean.FALSE, or call Boole...
 *   [ByteInstantiation](pmd_rules_java_performance.html#byteinstantiation): Calling new Byte() causes memory allocation that can be avoided by the static Byte.valueOf().It m...
 *   [ConsecutiveAppendsShouldReuse](pmd_rules_java_performance.html#consecutiveappendsshouldreuse): Consecutive calls to StringBuffer/StringBuilder .append should be chained, reusing the target obj...
-*   [ConsecutiveLiteralAppends](pmd_rules_java_performance.html#consecutiveliteralappends): Consecutively calling StringBuffer/StringBuilder.append with String literals
+*   [ConsecutiveLiteralAppends](pmd_rules_java_performance.html#consecutiveliteralappends): Consecutively calling StringBuffer/StringBuilder.append(...) with literals should be avoided.Sinc...
 *   [InefficientEmptyStringCheck](pmd_rules_java_performance.html#inefficientemptystringcheck): String.trim().length() is an inefficient way to check if a String is really empty, as itcreates a...
 *   [InefficientStringBuffering](pmd_rules_java_performance.html#inefficientstringbuffering): Avoid concatenating non-literals in a StringBuffer constructor or append() since intermediate buf...
 *   [InsufficientStringBufferDeclaration](pmd_rules_java_performance.html#insufficientstringbufferdeclaration): Failing to pre-size a StringBuffer or StringBuilder properly could cause it to re-size many times...
@@ -5,7 +5,7 @@ permalink: pmd_rules_java_bestpractices.html
 folder: pmd/rules/java
 sidebaractiveurl: /pmd_rules_java.html
 editmepath: ../pmd-java/src/main/resources/category/java/bestpractices.xml
-keywords: Best Practices, AbstractClassWithoutAbstractMethod, AccessorClassGeneration, AccessorMethodGeneration, ArrayIsStoredDirectly, AvoidPrintStackTrace, AvoidReassigningParameters, AvoidStringBufferField, AvoidUsingHardCodedIP, CheckResultSet, ConstantsInInterface, DefaultLabelNotLastInSwitchStmt, ForLoopCanBeForeach, GuardLogStatement, JUnit4SuitesShouldUseSuiteAnnotation, JUnit4TestShouldUseAfterAnnotation, JUnit4TestShouldUseBeforeAnnotation, JUnit4TestShouldUseTestAnnotation, JUnitAssertionsShouldIncludeMessage, JUnitTestContainsTooManyAsserts, JUnitTestsShouldIncludeAssert, JUnitUseExpected, LooseCoupling, MethodReturnsInternalArray, OneDeclarationPerLine, PositionLiteralsFirstInCaseInsensitiveComparisons, PositionLiteralsFirstInComparisons, PreserveStackTrace, ReplaceEnumerationWithIterator, ReplaceHashtableWithMap, ReplaceVectorWithList, SwitchStmtsShouldHaveDefault, SystemPrintln, UnusedFormalParameter, UnusedImports, UnusedLocalVariable, UnusedPrivateField, UnusedPrivateMethod, UseAssertEqualsInsteadOfAssertTrue, UseAssertNullInsteadOfAssertTrue, UseAssertSameInsteadOfAssertTrue, UseAssertTrueInsteadOfAssertEquals, UseCollectionIsEmpty, UseVarargs
+keywords: Best Practices, AbstractClassWithoutAbstractMethod, AccessorClassGeneration, AccessorMethodGeneration, ArrayIsStoredDirectly, AvoidPrintStackTrace, AvoidReassigningParameters, AvoidStringBufferField, AvoidUsingHardCodedIP, CheckResultSet, ConstantsInInterface, DefaultLabelNotLastInSwitchStmt, ForLoopCanBeForeach, GuardLogStatement, JUnit4SuitesShouldUseSuiteAnnotation, JUnit4TestShouldUseAfterAnnotation, JUnit4TestShouldUseBeforeAnnotation, JUnit4TestShouldUseTestAnnotation, JUnitAssertionsShouldIncludeMessage, JUnitTestContainsTooManyAsserts, JUnitTestsShouldIncludeAssert, JUnitUseExpected, LooseCoupling, MethodReturnsInternalArray, MissingOverride, OneDeclarationPerLine, PositionLiteralsFirstInCaseInsensitiveComparisons, PositionLiteralsFirstInComparisons, PreserveStackTrace, ReplaceEnumerationWithIterator, ReplaceHashtableWithMap, ReplaceVectorWithList, SwitchStmtsShouldHaveDefault, SystemPrintln, UnusedFormalParameter, UnusedImports, UnusedLocalVariable, UnusedPrivateField, UnusedPrivateMethod, UseAssertEqualsInsteadOfAssertTrue, UseAssertNullInsteadOfAssertTrue, UseAssertSameInsteadOfAssertTrue, UseAssertTrueInsteadOfAssertEquals, UseCollectionIsEmpty, UseVarargs
 ---
 ## AbstractClassWithoutAbstractMethod

@@ -783,6 +783,35 @@ public class SecureSystem {
 <rule ref="category/java/bestpractices.xml/MethodReturnsInternalArray" />
 ```

+## MissingOverride
+
+**Since:** PMD 6.2.0
+
+**Priority:** Medium (3)
+
+**Minimum Language Version:** Java 1.5
+
+Annotating overridden methods with @Override ensures at compile time that
+the method really overrides one, which helps refactoring and clarifies intent.
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.java.rule.bestpractices.MissingOverrideRule](https://github.com/pmd/pmd/blob/master/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/bestpractices/MissingOverrideRule.java)
+
+**Example(s):**
+
+``` java
+public class Foo implements Runnable {
+                // This method is overridden, and should have an @Override annotation
+                public void run() {
+
+                }
+            }
+```
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/java/bestpractices.xml/MissingOverride" />
+```
+
 ## OneDeclarationPerLine

 **Since:** PMD 5.0
@@ -1198,6 +1227,12 @@ public class Something {
 }
 ```

+**This rule has the following properties:**
+
+|Name|Default Value|Description|
+|----|-------------|-----------|
+|ignoredAnnotations|[lombok.Setter, lombok.Getter, lombok.Builder, lombok.Data, lombok.RequiredArgsConstructor, lombok.AllArgsConstructor, lombok.Value, lombok.NoArgsConstructor, java.lang.Deprecated, javafx.fxml.FXML]|Fully qualified names of the annotation types that should be ignored by this rule|
+
 **Use this rule by referencing it:**
 ``` xml
 <rule ref="category/java/bestpractices.xml/UnusedPrivateField" />
@@ -1221,6 +1256,12 @@ public class Something {
 }
 ```

+**This rule has the following properties:**
+
+|Name|Default Value|Description|
+|----|-------------|-----------|
+|ignoredAnnotations|[java.lang.Deprecated]|Fully qualified names of the annotation types that should be ignored by this rule|
+
 **Use this rule by referencing it:**
 ``` xml
 <rule ref="category/java/bestpractices.xml/UnusedPrivateMethod" />
@@ -5,7 +5,7 @@ permalink: pmd_rules_java_codestyle.html
 folder: pmd/rules/java
 sidebaractiveurl: /pmd_rules_java.html
 editmepath: ../pmd-java/src/main/resources/category/java/codestyle.xml
-keywords: Code Style, AbstractNaming, AtLeastOneConstructor, AvoidDollarSigns, AvoidFinalLocalVariable, AvoidPrefixingMethodParameters, AvoidProtectedFieldInFinalClass, AvoidProtectedMethodInFinalClassNotExtending, AvoidUsingNativeCode, BooleanGetMethodName, CallSuperInConstructor, ClassNamingConventions, CommentDefaultAccessModifier, ConfusingTernary, DefaultPackage, DontImportJavaLang, DuplicateImports, EmptyMethodInAbstractClassShouldBeAbstract, ExtendsObject, FieldDeclarationsShouldBeAtStartOfClass, ForLoopShouldBeWhileLoop, ForLoopsMustUseBraces, GenericsNaming, IfElseStmtsMustUseBraces, IfStmtsMustUseBraces, LocalHomeNamingConvention, LocalInterfaceSessionNamingConvention, LocalVariableCouldBeFinal, LongVariable, MDBAndSessionBeanNamingConvention, MethodArgumentCouldBeFinal, MethodNamingConventions, MIsLeadingVariableName, NoPackage, OnlyOneReturn, PackageCase, PrematureDeclaration, RemoteInterfaceNamingConvention, RemoteSessionInterfaceNamingConvention, ShortClassName, ShortMethodName, ShortVariable, SuspiciousConstantFieldName, TooManyStaticImports, UnnecessaryConstructor, UnnecessaryFullyQualifiedName, UnnecessaryLocalBeforeReturn, UnnecessaryModifier, UnnecessaryReturn, UselessParentheses, UselessQualifiedThis, VariableNamingConventions, WhileLoopsMustUseBraces
+keywords: Code Style, AbstractNaming, AtLeastOneConstructor, AvoidDollarSigns, AvoidFinalLocalVariable, AvoidPrefixingMethodParameters, AvoidProtectedFieldInFinalClass, AvoidProtectedMethodInFinalClassNotExtending, AvoidUsingNativeCode, BooleanGetMethodName, CallSuperInConstructor, ClassNamingConventions, CommentDefaultAccessModifier, ConfusingTernary, ControlStatementBraces, DefaultPackage, DontImportJavaLang, DuplicateImports, EmptyMethodInAbstractClassShouldBeAbstract, ExtendsObject, FieldDeclarationsShouldBeAtStartOfClass, ForLoopShouldBeWhileLoop, ForLoopsMustUseBraces, GenericsNaming, IfElseStmtsMustUseBraces, IfStmtsMustUseBraces, LocalHomeNamingConvention, LocalInterfaceSessionNamingConvention, LocalVariableCouldBeFinal, LongVariable, MDBAndSessionBeanNamingConvention, MethodArgumentCouldBeFinal, MethodNamingConventions, MIsLeadingVariableName, NoPackage, OnlyOneReturn, PackageCase, PrematureDeclaration, RemoteInterfaceNamingConvention, RemoteSessionInterfaceNamingConvention, ShortClassName, ShortMethodName, ShortVariable, SuspiciousConstantFieldName, TooManyStaticImports, UnnecessaryAnnotationValueElement, UnnecessaryConstructor, UnnecessaryFullyQualifiedName, UnnecessaryLocalBeforeReturn, UnnecessaryModifier, UnnecessaryReturn, UselessParentheses, UselessQualifiedThis, VariableNamingConventions, WhileLoopsMustUseBraces
 ---
 ## AbstractNaming

@@ -462,6 +462,65 @@ boolean bar(int x, int y) {
 <rule ref="category/java/codestyle.xml/ConfusingTernary" />
 ```

+## ControlStatementBraces
+
+**Since:** PMD 6.2.0
+
+**Priority:** Medium (3)
+
+Enforce a policy for braces on control statements. It is recommended to use braces on 'if ... else'
+statements and loop statements, even if they are optional. This usually makes the code clearer, and
+helps prepare the future when you need to add another statement. That said, this rule lets you control
+which statements are required to have braces via properties.
+
+From 6.2.0 on, this rule supersedes WhileLoopMustUseBraces, ForLoopMustUseBraces, IfStmtMustUseBraces,
+and IfElseStmtMustUseBraces.
+
+```
+//WhileStatement[$checkWhileStmt and not(Statement/Block) and not($allowEmptyLoop and Statement/EmptyStatement)]
+                |
+                //ForStatement[$checkForStmt and not(Statement/Block) and not($allowEmptyLoop and Statement/EmptyStatement)]
+                |
+                //DoStatement[$checkDoWhileStmt and not(Statement/Block) and not($allowEmptyLoop and Statement/EmptyStatement)]
+                |
+                (: The violation is reported on the sub statement -- not the if statement :)
+                //Statement[$checkIfElseStmt and parent::IfStatement and not(child::Block or child::IfStatement)]
+                |
+                (: Reports case labels if one of their subordinate statements is not braced :)
+                //SwitchLabel[$checkCaseStmt]
+                             [count(following-sibling::BlockStatement except following-sibling::SwitchLabel[1]/following-sibling::BlockStatement) > 1
+                              or (some $stmt (: in only the block statements until the next label :)
+                                  in following-sibling::BlockStatement except following-sibling::SwitchLabel[1]/following-sibling::BlockStatement
+                                  satisfies not($stmt/Statement/Block))]
+```
+
+**Example(s):**
+
+``` java
+while (true)    // not recommended
+  x++;
+
+while (true) {  // preferred approach
+  x++;
+}
+```
+
+**This rule has the following properties:**
+
+|Name|Default Value|Description|
+|----|-------------|-----------|
+|checkIfElseStmt|true|Require that 'if ... else' statements use braces|
+|checkWhileStmt|true|Require that 'while' loops use braces|
+|checkForStmt|true|Require that 'for' loops should use braces|
+|checkDoWhileStmt|true|Require that 'do ... while' loops use braces|
+|checkCaseStmt|false|Require that cases of a switch have braces|
+|allowEmptyLoop|false|Allow loops with an empty statement, e.g. 'while(true);'|
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/java/codestyle.xml/ControlStatementBraces" />
+```
+
 ## DefaultPackage

 **Since:** PMD 3.4
@@ -682,6 +741,8 @@ public class Foo {

 ## ForLoopsMustUseBraces

+<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f;">Deprecated</span> 
+
 **Since:** PMD 0.7

 **Priority:** Medium (3)
@@ -749,6 +810,8 @@ public interface GenericDao<EF extends BaseModel, K extends Serializable> {

 ## IfElseStmtsMustUseBraces

+<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f;">Deprecated</span> 
+
 **Since:** PMD 0.2

 **Priority:** Medium (3)
@@ -784,6 +847,8 @@ if (foo)

 ## IfStmtsMustUseBraces

+<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f;">Deprecated</span> 
+
 **Since:** PMD 1.0

 **Priority:** Medium (3)
@@ -1431,6 +1496,53 @@ import static Yoko; // Too much !
 <rule ref="category/java/codestyle.xml/TooManyStaticImports" />
 ```

+## UnnecessaryAnnotationValueElement
+
+**Since:** PMD 6.2.0
+
+**Priority:** Medium (3)
+
+Avoid the use of value in annotations when it's the only element.
+
+**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.java.rule.codestyle.UnnecessaryAnnotationValueElementRule](https://github.com/pmd/pmd/blob/master/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/codestyle/UnnecessaryAnnotationValueElementRule.java)
+
+**Example(s):**
+
+``` java
+@TestClassAnnotation(value = "TEST")
+public class Foo {
+
+    @TestMemberAnnotation(value = "TEST")
+    private String y;
+
+    @TestMethodAnnotation(value = "TEST")
+    public void bar() {
+        int x = 42;
+        return;
+    }
+}
+
+// should be
+
+@TestClassAnnotation("TEST")
+public class Foo {
+
+    @TestMemberAnnotation("TEST")
+    private String y;
+
+    @TestMethodAnnotation("TEST")
+    public void bar() {
+        int x = 42;
+        return;
+    }
+}
+```
+
+**Use this rule by referencing it:**
+``` xml
+<rule ref="category/java/codestyle.xml/UnnecessaryAnnotationValueElement" />
+```
+
 ## UnnecessaryConstructor

 **Since:** PMD 1.0
@@ -1771,6 +1883,8 @@ public class Foo {

 ## WhileLoopsMustUseBraces

+<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f;">Deprecated</span> 
+
 **Since:** PMD 0.7

 **Priority:** Medium (3)