changeset 50833:5715962c8831

8199307: NPE in jdk.javadoc.internal.doclets.toolkit.util.Utils.getLineNumber Reviewed-by: ksrini, jjg
author pmuthuswamy
date Thu, 24 May 2018 14:35:32 +0530
parents c0475f9c1c45
children 04f9bb270ab8
files src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDocletWriter.java test/langtools/jdk/javadoc/doclet/testSerializedFormWithClassFile/TestSerializedFormWithClassFile.java
diffstat 2 files changed, 122 insertions(+), 11 deletions(-) [+]
line wrap: on
line diff
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDocletWriter.java	Thu May 24 09:59:57 2018 +0200
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDocletWriter.java	Thu May 24 14:35:32 2018 +0530
@@ -644,25 +644,29 @@
     /**
      * Add the link to the content tree.
      *
-     * @param typeElement program element typeElement for which the link will be added
+     * @param element program element for which the link will be added
      * @param label label for the link
      * @param htmltree the content tree to which the link will be added
      */
-    public void addSrcLink(Element typeElement, Content label, Content htmltree) {
-        if (typeElement == null) {
+    public void addSrcLink(Element element, Content label, Content htmltree) {
+        if (element == null) {
             return;
         }
-        TypeElement te = utils.getEnclosingTypeElement(typeElement);
+        TypeElement te = utils.getEnclosingTypeElement(element);
         if (te == null) {
             // must be a typeElement since in has no containing class.
-            te = (TypeElement) typeElement;
+            te = (TypeElement) element;
         }
-        DocPath href = pathToRoot
-                .resolve(DocPaths.SOURCE_OUTPUT)
-                .resolve(docPaths.forClass(te));
-        Content linkContent = links.createLink(href
-                .fragment(SourceToHTMLConverter.getAnchorName(utils, typeElement)), label, "", "");
-        htmltree.addContent(linkContent);
+        if (utils.isIncluded(te)) {
+            DocPath href = pathToRoot
+                    .resolve(DocPaths.SOURCE_OUTPUT)
+                    .resolve(docPaths.forClass(te));
+            Content content = links.createLink(href
+                    .fragment(SourceToHTMLConverter.getAnchorName(utils, element)), label, "", "");
+            htmltree.addContent(content);
+        } else {
+            htmltree.addContent(label);
+        }
     }
 
     /**
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/test/langtools/jdk/javadoc/doclet/testSerializedFormWithClassFile/TestSerializedFormWithClassFile.java	Thu May 24 14:35:32 2018 +0530
@@ -0,0 +1,107 @@
+/*
+ * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/*
+ * @test
+ * @bug 8199307
+ * @summary NPE in jdk.javadoc.internal.doclets.toolkit.util.Utils.getLineNumber
+ * @library /tools/lib ../lib
+ * @modules
+ *      jdk.javadoc/jdk.javadoc.internal.tool
+ *      jdk.compiler/com.sun.tools.javac.api
+ *      jdk.compiler/com.sun.tools.javac.main
+ * @build JavadocTester
+ * @run main TestSerializedFormWithClassFile
+ */
+
+import builder.ClassBuilder;
+
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+import builder.ClassBuilder.MethodBuilder;
+import toolbox.ToolBox;
+import toolbox.JavacTask;
+
+public class TestSerializedFormWithClassFile extends JavadocTester {
+
+    final ToolBox tb;
+
+    public static void main(String... args) throws Exception {
+        TestSerializedFormWithClassFile tester = new TestSerializedFormWithClassFile();
+        tester.runTests(m -> new Object[]{Paths.get(m.getName())});
+    }
+
+    TestSerializedFormWithClassFile() {
+        tb = new ToolBox();
+    }
+
+    @Test
+    void test(Path base) throws Exception {
+        Path srcDir = base.resolve("src");
+        createTestClass(base, srcDir);
+
+        Path outDir = base.resolve("out");
+        javadoc("-d", outDir.toString(),
+                "-linksource",
+                "-classpath", base.resolve("classes").toString(),
+                "-sourcepath", "",
+                srcDir.resolve("B.java").toString());
+
+        checkExit(Exit.OK);
+
+        checkOutput("serialized-form.html", true,
+                "<pre>public&nbsp;void&nbsp;readObject&#8203;"
+                + "(java.io.ObjectInputStream&nbsp;arg0)\n"
+                + "                throws java.lang.ClassNotFoundException,\n"
+                + "                       java.io.IOException</pre>\n");
+    }
+
+    void createTestClass(Path base, Path srcDir) throws Exception {
+        //create A.java , compile the class in classes dir
+        Path classes = base.resolve("classes");
+        tb.createDirectories(classes);
+
+        MethodBuilder method = MethodBuilder
+                .parse("public void readObject(ObjectInputStream s)"
+                        + "throws ClassNotFoundException, IOException {}")
+                .setComments(
+                    "@param s a serialization stream",
+                    "@throws ClassNotFoundException if class not found",
+                    "@throws java.io.IOException if an IO error",
+                    "@serial");
+
+        new ClassBuilder(tb, "A")
+                .setModifiers("public", "abstract", "class")
+                .addImplements("Serializable")
+                .addImports("java.io.*")
+                .addMembers(method)
+                .write(srcDir);
+        new JavacTask(tb).files(srcDir.resolve("A.java")).outdir(classes).run();
+
+        new ClassBuilder(tb, "B")
+                .setExtends("A")
+                .setModifiers("public", "class")
+                .write(srcDir);
+    }
+}