From b29ca6b5f676e92243186abdba84a7501baea1bd Mon Sep 17 00:00:00 2001
From: Michal Kordas <kontakt@michalkordas.com>
Date: Fri, 24 Apr 2015 21:30:42 +0200
Subject: [PATCH] Fix and suppress PMD violations from ShortClassName rule,
 issue #982

---
 config/import-control.xml                                  | 2 +-
 config/pmd.xml                                             | 7 ++++++-
 pom.xml                                                    | 2 +-
 src/main/java/com/puppycrawl/tools/checkstyle/Checker.java | 4 ++--
 .../tools/checkstyle/{Defn.java => Definitions.java}       | 6 +++---
 .../java/com/puppycrawl/tools/checkstyle/TreeWalker.java   | 2 +-
 .../tools/checkstyle/checks/TranslationCheck.java          | 4 ++--
 .../checkstyle/checks/imports/UnusedImportsCheckTest.java  | 2 +-
 .../checkstyle/imports/InputAvoidStarImportCheck.java      | 2 +-
 .../checkstyle/imports/InputAvoidStaticImportCheck.java    | 2 +-
 .../tools/checkstyle/imports/InputIllegalImportCheck.java  | 2 +-
 .../checkstyle/imports/InputRedundantImportCheck.java      | 2 +-
 .../tools/checkstyle/imports/InputUnusedImportsCheck.java  | 4 ++--
 13 files changed, 23 insertions(+), 18 deletions(-)
 rename src/main/java/com/puppycrawl/tools/checkstyle/{Defn.java => Definitions.java} (91%)

diff --git a/config/import-control.xml b/config/import-control.xml
index 47e9a842e..3b3e8dd49 100644
--- a/config/import-control.xml
+++ b/config/import-control.xml
@@ -42,7 +42,7 @@
 
   <subpackage name="checks">
     <allow pkg="com.puppycrawl.tools.checkstyle.checks"/>
-    <allow class="com.puppycrawl.tools.checkstyle.Defn"/>
+    <allow class="com.puppycrawl.tools.checkstyle.Definitions"/>
     <allow pkg="java.math"/>
 
     <subpackage name="indentation">
diff --git a/config/pmd.xml b/config/pmd.xml
index 6d10ba41d..937761207 100644
--- a/config/pmd.xml
+++ b/config/pmd.xml
@@ -164,9 +164,14 @@
     <exclude name="AbstractNaming"/>
     <exclude name="AvoidFieldNameMatchingMethodName"/>
     <exclude name="LongVariable"/>
-    <exclude name="ShortClassName"/>
     <exclude name="ShortVariable"/>
   </rule>
+  <rule ref="rulesets/java/naming.xml/ShortClassName">
+    <properties>
+      <!-- Main is good name for class containing main method, Tag as inner class name is also fine -->
+      <property name="violationSuppressXPath" value="//ClassOrInterfaceDeclaration[@Image='Main' or @Image='Tag']"/>
+    </properties>
+  </rule>
   <rule ref="rulesets/java/optimizations.xml">
     <!--produces more false-positives than real problems-->
     <exclude name="AvoidInstantiatingObjectsInLoops"/>
diff --git a/pom.xml b/pom.xml
index 7f0494124..315e9ccd9 100644
--- a/pom.xml
+++ b/pom.xml
@@ -613,7 +613,7 @@
 
           <regex><pattern>.*.DefaultConfiguration</pattern><branchRate>100</branchRate><lineRate>92</lineRate></regex>
           <regex><pattern>.*.DefaultLogger</pattern><branchRate>75</branchRate><lineRate>76</lineRate></regex>
-          <regex><pattern>.*.Defn</pattern><branchRate>100</branchRate><lineRate>0</lineRate></regex>
+          <regex><pattern>.*.Definitions</pattern><branchRate>100</branchRate><lineRate>0</lineRate></regex>
           <regex><pattern>.*.Main</pattern><branchRate>0</branchRate><lineRate>0</lineRate></regex>
           <regex><pattern>.*.PackageNamesLoader</pattern><branchRate>78</branchRate><lineRate>72</lineRate></regex>
           <regex><pattern>.*.PackageObjectFactory</pattern><branchRate>75</branchRate><lineRate>75</lineRate></regex>
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/Checker.java b/src/main/java/com/puppycrawl/tools/checkstyle/Checker.java
index 9038baf9d..f100a1fb4 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/Checker.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/Checker.java
@@ -275,13 +275,13 @@ public class Checker extends AutomaticBean implements MessageDispatcher
             catch (final FileNotFoundException fnfe) {
                 LOG.debug("FileNotFoundException occured.", fnfe);
                 fileMessages.add(new LocalizedMessage(0,
-                        Defn.CHECKSTYLE_BUNDLE, "general.fileNotFound", null,
+                        Definitions.CHECKSTYLE_BUNDLE, "general.fileNotFound", null,
                         null, this.getClass(), null));
             }
             catch (final IOException ioe) {
                 LOG.debug("IOException occured.", ioe);
                 fileMessages.add(new LocalizedMessage(0,
-                        Defn.CHECKSTYLE_BUNDLE, "general.exception",
+                        Definitions.CHECKSTYLE_BUNDLE, "general.exception",
                         new String[] {ioe.getMessage()}, null, this.getClass(),
                         null));
             }
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/Defn.java b/src/main/java/com/puppycrawl/tools/checkstyle/Definitions.java
similarity index 91%
rename from src/main/java/com/puppycrawl/tools/checkstyle/Defn.java
rename to src/main/java/com/puppycrawl/tools/checkstyle/Definitions.java
index cce9f034b..6a9f2a913 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/Defn.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/Definitions.java
@@ -22,12 +22,12 @@ package com.puppycrawl.tools.checkstyle;
  * Contains constant definitions common to the package.
  * @author Oliver Burn
  **/
-public final class Defn
+public final class Definitions
 {
     /**
-     * Do no allow <code>Defn</code> instances to be created.
+     * Do no allow <code>Definitions</code> instances to be created.
      **/
-    private Defn()
+    private Definitions()
     {
     }
 
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/TreeWalker.java b/src/main/java/com/puppycrawl/tools/checkstyle/TreeWalker.java
index 470f28b27..fb83aefff 100755
--- a/src/main/java/com/puppycrawl/tools/checkstyle/TreeWalker.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/TreeWalker.java
@@ -242,7 +242,7 @@ public final class TreeWalker
     {
         return new LocalizedMessage(
                 0,
-                Defn.CHECKSTYLE_BUNDLE,
+                Definitions.CHECKSTYLE_BUNDLE,
                 "general.exception",
                 new String[] {message },
                 getId(),
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/TranslationCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/TranslationCheck.java
index aa891bd39..59e4a100d 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/TranslationCheck.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/TranslationCheck.java
@@ -22,7 +22,7 @@ import com.google.common.collect.Lists;
 import com.google.common.collect.Maps;
 import com.google.common.collect.Sets;
 import com.google.common.io.Closeables;
-import com.puppycrawl.tools.checkstyle.Defn;
+import com.puppycrawl.tools.checkstyle.Definitions;
 import com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck;
 import com.puppycrawl.tools.checkstyle.api.LocalizedMessage;
 import com.puppycrawl.tools.checkstyle.api.MessageDispatcher;
@@ -227,7 +227,7 @@ public class TranslationCheck
         final LocalizedMessage message =
             new LocalizedMessage(
                 0,
-                Defn.CHECKSTYLE_BUNDLE,
+                Definitions.CHECKSTYLE_BUNDLE,
                 key,
                 args,
                 getId(),
diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/checks/imports/UnusedImportsCheckTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/checks/imports/UnusedImportsCheckTest.java
index 105234af6..3e86ca0ca 100644
--- a/src/test/java/com/puppycrawl/tools/checkstyle/checks/imports/UnusedImportsCheckTest.java
+++ b/src/test/java/com/puppycrawl/tools/checkstyle/checks/imports/UnusedImportsCheckTest.java
@@ -50,7 +50,7 @@ public class UnusedImportsCheckTest extends BaseCheckTestSupport
             "37:8: " + getCheckMessage(MSG_KEY, "com.puppycrawl.tools.checkstyle.Checker"),
             "38:8: " + getCheckMessage(MSG_KEY, "com.puppycrawl.tools.checkstyle.CheckerTest"),
             "39:8: " + getCheckMessage(MSG_KEY, "com.puppycrawl.tools.checkstyle.BaseFileSetCheckTestSupport"),
-            "40:8: " + getCheckMessage(MSG_KEY, "com.puppycrawl.tools.checkstyle.Defn"),
+            "40:8: " + getCheckMessage(MSG_KEY, "com.puppycrawl.tools.checkstyle.Definitions"),
             "41:8: " + getCheckMessage(MSG_KEY, "com.puppycrawl.tools.checkstyle.Input15Extensions"),
             "42:8: " + getCheckMessage(MSG_KEY, "com.puppycrawl.tools.checkstyle.ConfigurationLoaderTest"),
             "43:8: " + getCheckMessage(MSG_KEY, "com.puppycrawl.tools.checkstyle.CheckStyleTask"),
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/imports/InputAvoidStarImportCheck.java b/src/test/resources/com/puppycrawl/tools/checkstyle/imports/InputAvoidStarImportCheck.java
index d2a9830d1..b2011f072 100644
--- a/src/test/resources/com/puppycrawl/tools/checkstyle/imports/InputAvoidStarImportCheck.java
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/imports/InputAvoidStarImportCheck.java
@@ -38,7 +38,7 @@ import java.util.BitSet;
 import com.puppycrawl.tools.checkstyle.Checker;
 import com.puppycrawl.tools.checkstyle.CheckerTest;
 import com.puppycrawl.tools.checkstyle.BaseFileSetCheckTestSupport;
-import com.puppycrawl.tools.checkstyle.Defn;
+import com.puppycrawl.tools.checkstyle.Definitions;
 import com.puppycrawl.tools.checkstyle.Input15Extensions;
 import com.puppycrawl.tools.checkstyle.ConfigurationLoaderTest;
 import com.puppycrawl.tools.checkstyle.CheckStyleTask;
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/imports/InputAvoidStaticImportCheck.java b/src/test/resources/com/puppycrawl/tools/checkstyle/imports/InputAvoidStaticImportCheck.java
index 1307f755f..541d9ae0c 100644
--- a/src/test/resources/com/puppycrawl/tools/checkstyle/imports/InputAvoidStaticImportCheck.java
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/imports/InputAvoidStaticImportCheck.java
@@ -38,7 +38,7 @@ import java.util.BitSet;
 import com.puppycrawl.tools.checkstyle.Checker;
 import com.puppycrawl.tools.checkstyle.CheckerTest;
 import com.puppycrawl.tools.checkstyle.BaseFileSetCheckTestSupport;
-import com.puppycrawl.tools.checkstyle.Defn;
+import com.puppycrawl.tools.checkstyle.Definitions;
 import com.puppycrawl.tools.checkstyle.Input15Extensions;
 import com.puppycrawl.tools.checkstyle.ConfigurationLoaderTest;
 import com.puppycrawl.tools.checkstyle.CheckStyleTask;
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/imports/InputIllegalImportCheck.java b/src/test/resources/com/puppycrawl/tools/checkstyle/imports/InputIllegalImportCheck.java
index 5d2b4bd99..b64755e7d 100644
--- a/src/test/resources/com/puppycrawl/tools/checkstyle/imports/InputIllegalImportCheck.java
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/imports/InputIllegalImportCheck.java
@@ -38,7 +38,7 @@ import java.util.BitSet;
 import com.puppycrawl.tools.checkstyle.Checker;
 import com.puppycrawl.tools.checkstyle.CheckerTest;
 import com.puppycrawl.tools.checkstyle.BaseFileSetCheckTestSupport;
-import com.puppycrawl.tools.checkstyle.Defn;
+import com.puppycrawl.tools.checkstyle.Definitions;
 import com.puppycrawl.tools.checkstyle.Input15Extensions;
 import com.puppycrawl.tools.checkstyle.ConfigurationLoaderTest;
 import com.puppycrawl.tools.checkstyle.CheckStyleTask;
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/imports/InputRedundantImportCheck.java b/src/test/resources/com/puppycrawl/tools/checkstyle/imports/InputRedundantImportCheck.java
index 7f9975a64..8610793dc 100644
--- a/src/test/resources/com/puppycrawl/tools/checkstyle/imports/InputRedundantImportCheck.java
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/imports/InputRedundantImportCheck.java
@@ -38,7 +38,7 @@ import java.util.BitSet;
 import com.puppycrawl.tools.checkstyle.Checker;
 import com.puppycrawl.tools.checkstyle.CheckerTest;
 import com.puppycrawl.tools.checkstyle.BaseFileSetCheckTestSupport;
-import com.puppycrawl.tools.checkstyle.Defn;
+import com.puppycrawl.tools.checkstyle.Definitions;
 import com.puppycrawl.tools.checkstyle.Input15Extensions;
 import com.puppycrawl.tools.checkstyle.ConfigurationLoaderTest;
 import com.puppycrawl.tools.checkstyle.CheckStyleTask;
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/imports/InputUnusedImportsCheck.java b/src/test/resources/com/puppycrawl/tools/checkstyle/imports/InputUnusedImportsCheck.java
index cadf70a1e..11fb34d8e 100644
--- a/src/test/resources/com/puppycrawl/tools/checkstyle/imports/InputUnusedImportsCheck.java
+++ b/src/test/resources/com/puppycrawl/tools/checkstyle/imports/InputUnusedImportsCheck.java
@@ -37,7 +37,7 @@ import java.util.BitSet;
 import com.puppycrawl.tools.checkstyle.Checker;
 import com.puppycrawl.tools.checkstyle.CheckerTest;
 import com.puppycrawl.tools.checkstyle.BaseFileSetCheckTestSupport;
-import com.puppycrawl.tools.checkstyle.Defn;
+import com.puppycrawl.tools.checkstyle.Definitions;
 import com.puppycrawl.tools.checkstyle.Input15Extensions;
 import com.puppycrawl.tools.checkstyle.ConfigurationLoaderTest;
 import com.puppycrawl.tools.checkstyle.CheckStyleTask;
@@ -100,7 +100,7 @@ class InputUnusedImportsCheck
 
     /**
      * First is a class with a method with arguments {@link Checker#method1(CheckerTest)}.
-     * Next is a class with typed method {@link BaseFileSetCheckTestSupport#method2(Defn, Input15Extensions)}.
+     * Next is a class with typed method {@link BaseFileSetCheckTestSupport#method2(Definitions, Input15Extensions)}.
      *
      * @param param1 with a link {@link ConfigurationLoaderTest}
      * @throws CheckStyleTask when broken