diff --git a/vscode-extensions/commons/commons-java/src/main/java/org/springframework/ide/vscode/commons/javadoc/HtmlJavadocIndex.java b/vscode-extensions/commons/commons-java/src/main/java/org/springframework/ide/vscode/commons/javadoc/HtmlJavadocIndex.java index a69aed187..87527bcaf 100644 --- a/vscode-extensions/commons/commons-java/src/main/java/org/springframework/ide/vscode/commons/javadoc/HtmlJavadocIndex.java +++ b/vscode-extensions/commons/commons-java/src/main/java/org/springframework/ide/vscode/commons/javadoc/HtmlJavadocIndex.java @@ -34,7 +34,7 @@ public interface HtmlJavadocIndex { BufferedReader buffer = new BufferedReader(new InputStreamReader(stream)); return new JavadocContents(buffer.lines().collect(Collectors.joining("\n"))); } catch (IOException e) { - Log.log(e); + Log.log("Cannot load javadoc content from " + url, e); return NO_HTML_CONTENT; } finally { if (stream != null) { diff --git a/vscode-extensions/commons/commons-maven/src/test/java/org/springframework/ide/vscode/commons/maven/JavaIndexTest.java b/vscode-extensions/commons/commons-maven/src/test/java/org/springframework/ide/vscode/commons/maven/JavaIndexTest.java index 675807982..bc8019026 100644 --- a/vscode-extensions/commons/commons-maven/src/test/java/org/springframework/ide/vscode/commons/maven/JavaIndexTest.java +++ b/vscode-extensions/commons/commons-maven/src/test/java/org/springframework/ide/vscode/commons/maven/JavaIndexTest.java @@ -4,7 +4,6 @@ import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertNull; -import java.nio.file.Files; import java.nio.file.Path; import java.nio.file.Paths; import java.util.Collections; @@ -17,6 +16,7 @@ import org.springframework.ide.vscode.commons.java.IMethod; import org.springframework.ide.vscode.commons.java.IPrimitiveType; import org.springframework.ide.vscode.commons.java.IType; import org.springframework.ide.vscode.commons.java.IVoidType; +import org.springframework.ide.vscode.commons.javadoc.IJavadoc; import org.springframework.ide.vscode.commons.maven.java.MavenJavaProject; import org.springframework.ide.vscode.commons.maven.java.MavenProjectClasspath; import org.springframework.ide.vscode.commons.maven.java.MavenProjectClasspath.JavadocProviderTypes; @@ -288,7 +288,9 @@ public class JavaIndexTest { "
An object that maps keys to values. A map cannot contain duplicate keys;", " each key can map to at most one value." ); - assertEquals(expected, type.getJavaDoc().getRenderable().toHtml().substring(0, expected.length())); + IJavadoc javaDoc = type.getJavaDoc(); + assertNotNull(javaDoc); + assertEquals(expected, javaDoc.getRenderable().toHtml().substring(0, expected.length())); } @Test @@ -302,7 +304,9 @@ public class JavaIndexTest { String expected = String.join("\n", "
A map entry (key-value pair). The Map.entrySet method returns", " a collection-view of the map, whose elements are of this class. The"); - assertEquals(expected, type.getJavaDoc().getRenderable().toHtml().substring(0, expected.length())); + IJavadoc javaDoc = type.getJavaDoc(); + assertNotNull(javaDoc); + assertEquals(expected, javaDoc.getRenderable().toHtml().substring(0, expected.length())); } @Test @@ -321,7 +325,9 @@ public class JavaIndexTest { "
public int size()
", "
Returns the number of elements in this list.
" ); - assertEquals(expected, method.getJavaDoc().getRenderable().toHtml().substring(0, expected.length())); + IJavadoc javaDoc = method.getJavaDoc(); + assertNotNull(javaDoc); + assertEquals(expected, javaDoc.getRenderable().toHtml().substring(0, expected.length())); } @Test @@ -338,7 +344,9 @@ public class JavaIndexTest { String expected = String.join("\n", "

ArrayList

" ); - assertEquals(expected, method.getJavaDoc().getRenderable().toHtml().substring(0, expected.length())); + IJavadoc javaDoc = method.getJavaDoc(); + assertNotNull(javaDoc); + assertEquals(expected, javaDoc.getRenderable().toHtml().substring(0, expected.length())); } @@ -362,7 +370,9 @@ public class JavaIndexTest { "
Constant Field Values
", "" ); - assertEquals(expected, field.getJavaDoc().getRenderable().toHtml()); + IJavadoc javaDoc = field.getJavaDoc(); + assertNotNull(javaDoc); + assertEquals(expected, javaDoc.getRenderable().toHtml()); IMethod method = type.getMethod("getListeners", Stream.empty()); assertNotNull(method); @@ -377,7 +387,9 @@ public class JavaIndexTest { "
the listeners
", "" ); - assertEquals(expected, method.getJavaDoc().getRenderable().toHtml()); + javaDoc = method.getJavaDoc(); + assertNotNull(javaDoc); + assertEquals(expected, javaDoc.getRenderable().toHtml()); } @Test @@ -389,7 +401,9 @@ public class JavaIndexTest { assertNotNull(type); String expected = "
Comment for Greeting class
"; - assertEquals(expected, type.getJavaDoc().getRenderable().toHtml()); + IJavadoc javaDoc = type.getJavaDoc(); + assertNotNull(javaDoc); + assertEquals(expected, javaDoc.getRenderable().toHtml()); IField field = type.getField("id"); assertNotNull(field); @@ -398,7 +412,9 @@ public class JavaIndexTest { "
protected final long id
", "
Comment for id field
" ); - assertEquals(expected, field.getJavaDoc().getRenderable().toHtml()); + javaDoc = field.getJavaDoc(); + assertNotNull(javaDoc); + assertEquals(expected, javaDoc.getRenderable().toHtml()); IMethod method = type.getMethod("getId", Stream.empty()); assertNotNull(method); @@ -407,7 +423,9 @@ public class JavaIndexTest { "
public long getId()
", "
Comment for getId()
" ); - assertEquals(expected, method.getJavaDoc().getRenderable().toHtml()); + javaDoc = method.getJavaDoc(); + assertNotNull(javaDoc); + assertEquals(expected, javaDoc.getRenderable().toHtml()); } @Test @@ -418,7 +436,9 @@ public class JavaIndexTest { IType type = project.findType("hello.Greeting$TestInnerClass"); assertNotNull(type); - assertEquals("
Comment for inner class
", type.getJavaDoc().getRenderable().toHtml()); + IJavadoc javaDoc = type.getJavaDoc(); + assertNotNull(javaDoc); + assertEquals("
Comment for inner class
", javaDoc.getRenderable().toHtml()); IField field = type.getField("innerField"); assertNotNull(field); @@ -427,7 +447,9 @@ public class JavaIndexTest { "
protected int innerField
", "
Comment for inner field
" ); - assertEquals(expected, field.getJavaDoc().getRenderable().toHtml()); + javaDoc = field.getJavaDoc(); + assertNotNull(javaDoc); + assertEquals(expected, javaDoc.getRenderable().toHtml()); IMethod method = type.getMethod("getInnerField", Stream.empty()); assertNotNull(method); @@ -436,7 +458,9 @@ public class JavaIndexTest { "
public int getInnerField()
", "
Comment for method inside nested class
" ); - assertEquals(expected, method.getJavaDoc().getRenderable().toHtml()); + javaDoc = method.getJavaDoc(); + assertNotNull(javaDoc); + assertEquals(expected, javaDoc.getRenderable().toHtml()); } @Test @@ -447,7 +471,9 @@ public class JavaIndexTest { IType type = project.findType("hello.Greeting$TestInnerClass$TestInnerClassLevel2"); assertNotNull(type); - assertEquals("
Comment for level 2 nested class
", type.getJavaDoc().getRenderable().toHtml()); + IJavadoc javaDoc = type.getJavaDoc(); + assertNotNull(javaDoc); + assertEquals("
Comment for level 2 nested class
", javaDoc.getRenderable().toHtml()); IField field = type.getField("innerLevel2Field"); assertNotNull(field); @@ -456,7 +482,9 @@ public class JavaIndexTest { "
protected int innerLevel2Field
", "
Comment for level 2 inner field
" ); - assertEquals(expected, field.getJavaDoc().getRenderable().toHtml()); + javaDoc = field.getJavaDoc(); + assertNotNull(javaDoc); + assertEquals(expected, javaDoc.getRenderable().toHtml()); IMethod method = type.getMethod("getInnerLevel2Field", Stream.empty()); assertNotNull(method); @@ -465,7 +493,9 @@ public class JavaIndexTest { "
public int getInnerLevel2Field()
", "
Comment for method inside level 2 nested class
" ); - assertEquals(expected, method.getJavaDoc().getRenderable().toHtml()); + javaDoc = method.getJavaDoc(); + assertNotNull(javaDoc); + assertEquals(expected, javaDoc.getRenderable().toHtml()); } @Test @@ -505,7 +535,9 @@ public class JavaIndexTest { "
@Bean",
 				"public org.springframework.web.servlet.config.annotation.WebMvcConfigurer corsConfigurer()
" ); - assertEquals(expected, method.getJavaDoc().getRenderable().toHtml()); + IJavadoc javaDoc = method.getJavaDoc(); + assertNotNull(javaDoc); + assertEquals(expected, javaDoc.getRenderable().toHtml()); } @Test @@ -513,7 +545,6 @@ public class JavaIndexTest { MavenProjectClasspath.providerType = JavadocProviderTypes.HTML; Path projectPath = projectsCache.get("gs-rest-service-cors-boot-1.4.1-with-classpath-file"); MavenJavaProject project = createMavenProject(projectPath); - Files.list(project.getOutputFolder().getParent().resolve("site")).forEach(System.out::println); IType type = project.findType("hello.GreetingController"); assertNotNull(type); @@ -527,6 +558,8 @@ public class JavaIndexTest { "
Constant Field Values
", "" ); - assertEquals(expected, field.getJavaDoc().getRenderable().toHtml()); + IJavadoc javaDoc = field.getJavaDoc(); + assertNotNull(javaDoc); + assertEquals(expected, javaDoc.getRenderable().toHtml()); } }