Merge pull request #1438 from matozoid/small_things

Some small improvements

10 files changed, 48 insertions, 21 deletions

diff --git a/javaparser-core/src/main/java/com/github/javaparser/ast/nodeTypes/NodeWithJavadoc.java b/javaparser-core/src/main/java/com/github/javaparser/ast/nodeTypes/NodeWithJavadoc.java
index f4a7013b0..592947e07 100644
--- a/javaparser-core/src/main/java/com/github/javaparser/ast/nodeTypes/NodeWithJavadoc.java
+++ b/javaparser-core/src/main/java/com/github/javaparser/ast/nodeTypes/NodeWithJavadoc.java
@@ -64,7 +64,7 @@ public interface NodeWithJavadoc<N extends Node> {
      */
     @SuppressWarnings("unchecked")
     default N setJavadocComment(String comment) {
-        return setJavadocComment(new JavadocComment(comment));
+        return setJavadocComment(new JavadocComment(" " + comment));
     }
 
     default N setJavadocComment(JavadocComment comment) {
@@ -73,8 +73,11 @@ public interface NodeWithJavadoc<N extends Node> {
     }
 
     default N setJavadocComment(String indentation, Javadoc javadoc) {
-        JavadocComment comment = javadoc.toComment(indentation);
-        return setJavadocComment(comment);
+        return setJavadocComment(javadoc.toComment(indentation));
+    }
+
+    default N setJavadocComment(Javadoc javadoc) {
+        return setJavadocComment(javadoc.toComment());
     }
 
     default boolean removeJavaDocComment() {
diff --git a/javaparser-core/src/main/java/com/github/javaparser/ast/nodeTypes/NodeWithSimpleName.java b/javaparser-core/src/main/java/com/github/javaparser/ast/nodeTypes/NodeWithSimpleName.java
index a979e7bdf..ebd3957b8 100644
--- a/javaparser-core/src/main/java/com/github/javaparser/ast/nodeTypes/NodeWithSimpleName.java
+++ b/javaparser-core/src/main/java/com/github/javaparser/ast/nodeTypes/NodeWithSimpleName.java
@@ -22,6 +22,7 @@
 package com.github.javaparser.ast.nodeTypes;
 
 import com.github.javaparser.ast.Node;
+import com.github.javaparser.ast.expr.NameExpr;
 import com.github.javaparser.ast.expr.SimpleName;
 
 import static com.github.javaparser.utils.Utils.assertNonEmpty;
@@ -45,4 +46,8 @@ public interface NodeWithSimpleName<N extends Node> {
     default String getNameAsString() {
         return getName().getIdentifier();
     }
+
+    default NameExpr getNameAsExpression() {
+        return new NameExpr(getName());
+    }
 }
diff --git a/javaparser-core/src/main/java/com/github/javaparser/ast/nodeTypes/NodeWithType.java b/javaparser-core/src/main/java/com/github/javaparser/ast/nodeTypes/NodeWithType.java
index d97030cd7..06e66fb91 100644
--- a/javaparser-core/src/main/java/com/github/javaparser/ast/nodeTypes/NodeWithType.java
+++ b/javaparser-core/src/main/java/com/github/javaparser/ast/nodeTypes/NodeWithType.java
@@ -72,4 +72,7 @@ public interface NodeWithType<N extends Node, T extends Type> {
         return setType((T) parseType(typeString));

     }

 

+    default String getTypeAsString() {

+        return getType().asString();

+    }

 }

diff --git a/javaparser-core/src/main/java/com/github/javaparser/javadoc/Javadoc.java b/javaparser-core/src/main/java/com/github/javaparser/javadoc/Javadoc.java
index 62e1957cc..ba606c2f3 100644
--- a/javaparser-core/src/main/java/com/github/javaparser/javadoc/Javadoc.java
+++ b/javaparser-core/src/main/java/com/github/javaparser/javadoc/Javadoc.java
@@ -52,10 +52,25 @@ public class Javadoc {
         return this;
     }
 
+    /**
+     * For tags like "@return good things" where
+     * tagName is "return",
+     * and the rest is content.
+     */
     public Javadoc addBlockTag(String tagName, String content) {
         return addBlockTag(new JavadocBlockTag(tagName, content));
     }
 
+    /**
+     * For tags like "@param abc this is a parameter" where
+     * tagName is "param",
+     * parameter is "abc"
+     * and the rest is content.
+     */
+    public Javadoc addBlockTag(String tagName, String parameter, String content) {
+        return addBlockTag(tagName, parameter + " " + content);
+    }
+
     public Javadoc addBlockTag(String tagName) {
         return addBlockTag(tagName, "");
     }
@@ -81,7 +96,14 @@ public class Javadoc {
     }
 
     /**
-     * Create a JavadocComment, by formatting the text of the Javadoc using the given indentation/
+     * Create a JavadocComment, by formatting the text of the Javadoc using no indentation (expecting the pretty printer to do the formatting.)
+     */
+    public JavadocComment toComment() {
+        return toComment("");
+    }
+
+    /**
+     * Create a JavadocComment, by formatting the text of the Javadoc using the given indentation.
      */
     public JavadocComment toComment(String indentation) {
         for (char c : indentation.toCharArray()) {
diff --git a/javaparser-testing/src/test/java/com/github/javaparser/ast/visitor/CloneVisitorTest.java b/javaparser-testing/src/test/java/com/github/javaparser/ast/visitor/CloneVisitorTest.java
index aa792c90e..e59661170 100644
--- a/javaparser-testing/src/test/java/com/github/javaparser/ast/visitor/CloneVisitorTest.java
+++ b/javaparser-testing/src/test/java/com/github/javaparser/ast/visitor/CloneVisitorTest.java
@@ -87,12 +87,12 @@ public class CloneVisitorTest {
         while (typeItr.hasNext()) {
             typeDeclaration = typeItr.next();
             if (typeDeclaration.getMembers() == null) {
-                assertEquals(typeDeclaration.getComment().get().getContent(), "javadoc");
+                assertEquals(typeDeclaration.getComment().get().getContent(), " javadoc");
             } else {
                 Iterator<BodyDeclaration<?>> bodyItr = typeDeclaration.getMembers().iterator();
                 while (bodyItr.hasNext()) {
                     BodyDeclaration<?> bodyDeclaration = bodyItr.next();
-                    assertEquals(bodyDeclaration.getComment().get().getContent(), "javadoc");
+                    assertEquals(bodyDeclaration.getComment().get().getContent(), " javadoc");
                 }
             }
         }
diff --git a/javaparser-testing/src/test/java/com/github/javaparser/printer/PrettyPrintVisitorTest.java b/javaparser-testing/src/test/java/com/github/javaparser/printer/PrettyPrintVisitorTest.java
index 2360d0ce0..df1168ed1 100644
--- a/javaparser-testing/src/test/java/com/github/javaparser/printer/PrettyPrintVisitorTest.java
+++ b/javaparser-testing/src/test/java/com/github/javaparser/printer/PrettyPrintVisitorTest.java
@@ -178,7 +178,7 @@ public class PrettyPrintVisitorTest {
     @Test
     public void multilineJavadocGetsFormatted() {
         CompilationUnit cu = new CompilationUnit();
-        cu.addClass("X").addMethod("abc").setJavadocComment(" line1\n   line2 *\n * line3");
+        cu.addClass("X").addMethod("abc").setJavadocComment("line1\n   line2 *\n * line3");
 
         assertEqualsNoEol("public class X {\n" +
                 "\n" +
@@ -226,7 +226,7 @@ public class PrettyPrintVisitorTest {
     @Test
     public void singlelineJavadocGetsFormatted() {
         CompilationUnit cu = new CompilationUnit();
-        cu.addClass("X").addMethod("abc").setJavadocComment(" line1");
+        cu.addClass("X").addMethod("abc").setJavadocComment("line1");
 
         assertEqualsNoEol("public class X {\n" +
                 "\n" +
diff --git a/javaparser-testing/src/test/java/com/github/javaparser/printer/lexicalpreservation/transformations/ast/body/AnnotationMemberDeclarationTransformationsTest.java b/javaparser-testing/src/test/java/com/github/javaparser/printer/lexicalpreservation/transformations/ast/body/AnnotationMemberDeclarationTransformationsTest.java
index aeb4eeb26..6b5552807 100644
--- a/javaparser-testing/src/test/java/com/github/javaparser/printer/lexicalpreservation/transformations/ast/body/AnnotationMemberDeclarationTransformationsTest.java
+++ b/javaparser-testing/src/test/java/com/github/javaparser/printer/lexicalpreservation/transformations/ast/body/AnnotationMemberDeclarationTransformationsTest.java
@@ -154,22 +154,22 @@ public class AnnotationMemberDeclarationTransformationsTest extends AbstractLexi
     public void addingJavadoc() {
         AnnotationMemberDeclaration it = consider("int foo();");
         it.setJavadocComment("Cool this annotation!");
-        assertTransformedToString("@interface AD { /**Cool this annotation!*/" + EOL +
+        assertTransformedToString("@interface AD { /** Cool this annotation!*/" + EOL +
                 "int foo(); }", it.getParentNode().get());
     }
 
     @Test
     public void removingJavadoc() {
-        AnnotationMemberDeclaration it = consider("/**Cool this annotation!*/ int foo();");
+        AnnotationMemberDeclaration it = consider("/** Cool this annotation!*/ int foo();");
         assertTrue(it.getJavadocComment().get().remove());
         assertTransformedToString("@interface AD {  int foo(); }", it.getParentNode().get());
     }
 
     @Test
     public void replacingJavadoc() {
-        AnnotationMemberDeclaration it = consider("/**Cool this annotation!*/ int foo();");
+        AnnotationMemberDeclaration it = consider("/** Cool this annotation!*/ int foo();");
         it.setJavadocComment("Super extra cool this annotation!!!");
-        assertTransformedToString("@interface AD { /**Super extra cool this annotation!!!*/ int foo(); }", it.getParentNode().get());
+        assertTransformedToString("@interface AD { /** Super extra cool this annotation!!!*/ int foo(); }", it.getParentNode().get());
     }
 
 }
diff --git a/javaparser-testing/src/test/resources/com/github/javaparser/bulk_test_results/javaparser_test_results.txt b/javaparser-testing/src/test/resources/com/github/javaparser/bulk_test_results/javaparser_test_results.txt
index 4daf779c1..8a9fcbee5 100644
--- a/javaparser-testing/src/test/resources/com/github/javaparser/bulk_test_results/javaparser_test_results.txt
+++ b/javaparser-testing/src/test/resources/com/github/javaparser/bulk_test_results/javaparser_test_results.txt
@@ -1,7 +1 @@
-javaparser-testing/src/test/resources/com/github/javaparser/TestFileIso88591.java
-Lexical error at line 5, column 22.  Encountered: "\ufffd" (65533), after : ""
-
-javaparser-testing/src/test/resources/com/github/javaparser/utils/module-info.java
-(line 1,col 1) Modules are not supported.
-
-2 problems in 2 files
\ No newline at end of file
+0 problems in 0 files
\ No newline at end of file
diff --git a/javaparser-testing/src/test/resources/com/github/javaparser/lexical_preservation_samples/AnnotationDeclaration_Example10_expected.java.txt b/javaparser-testing/src/test/resources/com/github/javaparser/lexical_preservation_samples/AnnotationDeclaration_Example10_expected.java.txt
index e500927af..131378890 100644
--- a/javaparser-testing/src/test/resources/com/github/javaparser/lexical_preservation_samples/AnnotationDeclaration_Example10_expected.java.txt
+++ b/javaparser-testing/src/test/resources/com/github/javaparser/lexical_preservation_samples/AnnotationDeclaration_Example10_expected.java.txt
@@ -1,5 +1,5 @@
 // some example
-/**Super extra cool this annotation!!!*/
+/** Super extra cool this annotation!!!*/
 public @interface ClassPreamble {
    String author();
    String date();
diff --git a/javaparser-testing/src/test/resources/com/github/javaparser/lexical_preservation_samples/AnnotationDeclaration_Example8_expected.java.txt b/javaparser-testing/src/test/resources/com/github/javaparser/lexical_preservation_samples/AnnotationDeclaration_Example8_expected.java.txt
index d3052f4c7..2a5fd934f 100644
--- a/javaparser-testing/src/test/resources/com/github/javaparser/lexical_preservation_samples/AnnotationDeclaration_Example8_expected.java.txt
+++ b/javaparser-testing/src/test/resources/com/github/javaparser/lexical_preservation_samples/AnnotationDeclaration_Example8_expected.java.txt
@@ -1,6 +1,6 @@
 // some example
 
-/**Cool this annotation!*/
+/** Cool this annotation!*/
 public @interface ClassPreamble {
    String author();
    String date();