SONAR-1932: Create a SQUID rule : instruction "continue" should not be used

diff --git a/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/java/ast/check/ContinueCheck.java b/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/java/ast/check/ContinueCheck.java
index 8f6d40a94446705bada0a55c659a43cb447aa213..e9088b5b384c60998cfd1117605aa58c4f6eea47 100644 (file)
--- a/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/java/ast/check/ContinueCheck.java
+++ b/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/java/ast/check/ContinueCheck.java
@@ -24,6 +24,7 @@ import java.util.Arrays;
 import java.util.List;
 
 import org.sonar.check.IsoCategory;
+import org.sonar.check.Priority;
 import org.sonar.check.Rule;
 import org.sonar.squid.api.CheckMessage;
 import org.sonar.squid.api.SourceCode;
@@ -32,7 +33,21 @@ import org.sonar.squid.api.SourceFile;
 import com.puppycrawl.tools.checkstyle.api.DetailAST;
 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
 
-@Rule(key = "AvoidUsageOfContinue", name = "AvoidUsageOfContinue", isoCategory = IsoCategory.Maintainability)
+@Rule(key = "AvoidContinueStatement", name = "Avoid using 'continue' branching statement", isoCategory = IsoCategory.Maintainability,
+    priority = Priority.MAJOR, description = "<p>The use of the 'continue' branching statement increase the essential complexity "
+        + "of the source code and so prevent any refactoring of this source code to replace all well structured control structures "
+        + "with a single statement.</p><p>For instance, in the following java program fragment, it's not possible to apply "
+        + "the 'extract method' refactoring pattern :</p>"
+        + "<pre>"
+        + "mylabel : for(int i = 0 ; i< 3; i++) {\n"
+        + "  for (int j = 0; j < 4 ; j++) {\n"
+        + "    doSomething();\n"
+        + "    if (checkSomething()) {\n"
+        + "      continue mylabel;\n"
+        + "    }\n"
+        + "  }\n"
+        + "}\n"
+        + "</pre>")
 public class ContinueCheck extends JavaAstCheck {
 
   @Override
@@ -43,7 +58,8 @@ public class ContinueCheck extends JavaAstCheck {
   @Override
   public void visitToken(DetailAST ast) {
     SourceCode currentResource = peekSourceCode();
-    CheckMessage message = new CheckMessage(this, "Avoid usage of continue");
+    CheckMessage message = new CheckMessage(this,
+        "The 'continue' branching statement prevent refactoring the source code to reduce the complexity.");
     message.setLine(ast.getLineNo());
     SourceFile sourceFile = currentResource.getParent(SourceFile.class);
     sourceFile.log(message);