Issue #3426: remove warning on PACKAGE_DEF predicted by javadoc not s…

…eparated by line
checkstyle · Nov 12, 2016 · 92224dc · 92224dc
1 parent 548ecd7
commit 92224dc
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 18 deletions.
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyLineSeparatorCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyLineSeparatorCheck.java
@@ -404,7 +404,7 @@ && hasNotAllowedTwoEmptyLinesBefore(ast)) {
      * @param nextToken next token
      */
     private void processPackage(DetailAST ast, DetailAST nextToken) {
-        if (ast.getLineNo() > 1 && !hasEmptyLineBefore(ast)) {
+        if (ast.getLineNo() > 1 && !(hasEmptyLineBefore(ast) || isPredictedByJavadoc(ast))) {
             log(ast.getLineNo(), MSG_SHOULD_BE_SEPARATED, ast.getText());
         }
         if (!hasEmptyLineAfter(ast)) {
@@ -533,6 +533,34 @@ private boolean hasEmptyLineBefore(DetailAST token) {
         return lineBefore.trim().isEmpty();
     }
 
+    /**
+     * Check if token is predicted by javadoc comment
+     * @param token token.
+     * @return true, if token is predicted by javadoc comment.
+     */
+    private boolean isPredictedByJavadoc(DetailAST token) {
+        final int lineNo = token.getLineNo();
+        boolean result = false;
+
+        if (lineNo != 1) {
+            //  [lineNo - 2] is the number of the previous line because the numbering starts
+            //  from zero.
+            String lineBefore;
+            int lineIndex = 2;
+            do {
+                lineBefore = getLines()[lineNo - lineIndex];
+                if (lineBefore.trim().startsWith("/**")) {
+                    result = true;
+                }
+                else if (!lineBefore.trim().startsWith("*")) {
+                    break;
+                }
+                lineIndex++;
+            } while (lineNo - lineIndex >= 0);
+        }
+        return result;
+    }
+
     /**
      * If variable definition is a type field.
      * @param variableDef variable definition.

diff --git a/...t/java/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyLineSeparatorCheckTest.java b/...t/java/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyLineSeparatorCheckTest.java
@@ -54,15 +54,15 @@ public void testDefault() throws Exception {
         final DefaultConfiguration checkConfig = createCheckConfig(EmptyLineSeparatorCheck.class);
 
         final String[] expected = {
-            "21: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "import"),
-            "35: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "CLASS_DEF"),
-            "38: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "VARIABLE_DEF"),
-            "39: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "STATIC_INIT"),
-            "43: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "INSTANCE_INIT"),
-            "57: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "CTOR_DEF"),
-            "62: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "METHOD_DEF"),
-            "79: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "METHOD_DEF"),
-            "110: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "INTERFACE_DEF"),
+            "25: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "import"),
+            "39: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "CLASS_DEF"),
+            "42: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "VARIABLE_DEF"),
+            "43: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "STATIC_INIT"),
+            "47: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "INSTANCE_INIT"),
+            "61: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "CTOR_DEF"),
+            "66: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "METHOD_DEF"),
+            "83: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "METHOD_DEF"),
+            "114: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "INTERFACE_DEF"),
         };
         verify(checkConfig, getPath("InputEmptyLineSeparator.java"), expected);
     }
@@ -74,14 +74,14 @@ public void testAllowNoEmptyLineBetweenFields() throws Exception {
         checkConfig.addAttribute("allowNoEmptyLineBetweenFields", "true");
 
         final String[] expected = {
-            "21: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "import"),
-            "35: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "CLASS_DEF"),
-            "39: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "STATIC_INIT"),
-            "43: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "INSTANCE_INIT"),
-            "57: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "CTOR_DEF"),
-            "62: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "METHOD_DEF"),
-            "79: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "METHOD_DEF"),
-            "110: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "INTERFACE_DEF"),
+            "25: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "import"),
+            "39: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "CLASS_DEF"),
+            "43: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "STATIC_INIT"),
+            "47: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "INSTANCE_INIT"),
+            "61: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "CTOR_DEF"),
+            "66: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "METHOD_DEF"),
+            "83: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "METHOD_DEF"),
+            "114: " + getCheckMessage(MSG_SHOULD_BE_SEPARATED, "INTERFACE_DEF"),
         };
         verify(checkConfig, getPath("InputEmptyLineSeparator.java"), expected);
     }

diff --git a/.../resources/com/puppycrawl/tools/checkstyle/checks/whitespace/InputEmptyLineSeparator.java b/.../resources/com/puppycrawl/tools/checkstyle/checks/whitespace/InputEmptyLineSeparator.java
@@ -17,6 +17,10 @@
 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 ////////////////////////////////////////////////////////////////////////////////
 
+/**
+  * Some javadoc before PACKAGE_DEF to test that there isn't warning
+  * when javadoc and package definition aren't separate with line.
+  */
 package com.puppycrawl.tools.checkstyle.checks.whitespace;
 import java.io.Serializable;
 import java.util.ArrayList;