diff --git a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/AbstractMemberWriter.java b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/AbstractMemberWriter.java index 3ea59576fb6..b11d255e565 100644 --- a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/AbstractMemberWriter.java +++ b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/AbstractMemberWriter.java @@ -239,7 +239,14 @@ public abstract class AbstractMemberWriter { if ((member.isField() || member.isMethod()) && writer instanceof ClassWriterImpl && ((ClassWriterImpl) writer).getClassDoc().isInterface()) { - mod = Util.replaceText(mod, "public", "").trim(); + // This check for isDefault() and the default modifier needs to be + // added for it to appear on the method details section. Once the + // default modifier is added to the Modifier list on DocEnv and once + // it is updated to use the javax.lang.model.element.Modifier, we + // will need to remove this. + mod = (member.isMethod() && ((MethodDoc)member).isDefault()) ? + Util.replaceText(mod, "public", "default").trim() : + Util.replaceText(mod, "public", "").trim(); } if(mod.length() > 0) { htmltree.addContent(mod); @@ -313,8 +320,18 @@ public abstract class AbstractMemberWriter { code.addContent(configuration.getText("doclet.Package_private")); code.addContent(" "); } - if (member.isMethod() && ((MethodDoc)member).isAbstract()) { - code.addContent("abstract "); + if (member.isMethod()) { + if (((MethodDoc)member).isAbstract()) { + code.addContent("abstract "); + } + // This check for isDefault() and the default modifier needs to be + // added for it to appear on the "Modifier and Type" column in the + // method summary section. Once the default modifier is added + // to the Modifier list on DocEnv and once it is updated to use the + // javax.lang.model.element.Modifier, we will need to remove this. + else if (((MethodDoc)member).isDefault()) { + code.addContent("default "); + } } if (member.isStatic()) { code.addContent("static "); @@ -547,6 +564,9 @@ public abstract class AbstractMemberWriter { methodType = (classdoc.isInterface() || ((MethodDoc)member).isAbstract()) ? methodType | MethodTypes.ABSTRACT.value() : methodType | MethodTypes.CONCRETE.value(); + if (((MethodDoc)member).isDefault()) { + methodType = methodType | MethodTypes.DEFAULT.value(); + } if (Util.isDeprecated(member) || Util.isDeprecated(classdoc)) { methodType = methodType | MethodTypes.DEPRECATED.value(); } diff --git a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/ClassWriterImpl.java b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/ClassWriterImpl.java index 06ac230dc27..809f00f8e59 100644 --- a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/ClassWriterImpl.java +++ b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/ClassWriterImpl.java @@ -513,6 +513,20 @@ public class ClassWriterImpl extends SubWriterHolderWriter } } + /** + * {@inheritDoc} + */ + public void addFunctionalInterfaceInfo (Content classInfoTree) { + if (classDoc.isFunctionalInterface()) { + Content dt = HtmlTree.DT(getResource("doclet.Functional_Interface")); + Content dl = HtmlTree.DL(dt); + Content dd = new HtmlTree(HtmlTag.DD); + dd.addContent(getResource("doclet.Functional_Interface_Message")); + dl.addContent(dd); + classInfoTree.addContent(dl); + } + } + /** * {@inheritDoc} */ diff --git a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/resources/standard.properties b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/resources/standard.properties index 9dedf79fc52..7e6df8bc55c 100644 --- a/langtools/src/share/classes/com/sun/tools/doclets/formats/html/resources/standard.properties +++ b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/resources/standard.properties @@ -90,6 +90,8 @@ doclet.in_interface=in interface doclet.Subclasses=Direct Known Subclasses: doclet.Subinterfaces=All Known Subinterfaces: doclet.Implementing_Classes=All Known Implementing Classes: +doclet.Functional_Interface=Functional Interface: +doclet.Functional_Interface_Message=This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference. doclet.also=also doclet.Frames=Frames doclet.No_Frames=No Frames diff --git a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/ClassWriter.java b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/ClassWriter.java index f5904b3aef3..c0a991e2196 100644 --- a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/ClassWriter.java +++ b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/ClassWriter.java @@ -116,6 +116,13 @@ public interface ClassWriter { */ public void addInterfaceUsageInfo(Content classInfoTree); + /** + * If this is an functional interface, display appropriate message. + * + * @param classInfoTree content tree to which the documentation will be added + */ + public void addFunctionalInterfaceInfo(Content classInfoTree); + /** * If this is an inner class or interface, add the enclosing class or * interface. diff --git a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/ClassBuilder.java b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/ClassBuilder.java index 1f2e82a10ad..efc9d563473 100644 --- a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/ClassBuilder.java +++ b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/ClassBuilder.java @@ -235,6 +235,16 @@ public class ClassBuilder extends AbstractBuilder { writer.addInterfaceUsageInfo(classInfoTree); } + /** + * If this is an functional interface, display appropriate message. + * + * @param node the XML element that specifies which components to document + * @param classInfoTree the content tree to which the documentation will be added + */ + public void buildFunctionalInterfaceInfo(XMLNode node, Content classInfoTree) { + writer.addFunctionalInterfaceInfo(classInfoTree); + } + /** * If this class is deprecated, build the appropriate information. * diff --git a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/resources/doclet.xml b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/resources/doclet.xml index a39cea10843..ce4472e9624 100644 --- a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/resources/doclet.xml +++ b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/resources/doclet.xml @@ -85,6 +85,7 @@ + diff --git a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/MethodTypes.java b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/MethodTypes.java index d1211fc1c91..7b31ad81f04 100644 --- a/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/MethodTypes.java +++ b/langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/util/MethodTypes.java @@ -36,7 +36,8 @@ public enum MethodTypes { INSTANCE(0x2, "Instance Methods", "t2", false), ABSTRACT(0x4, "Abstract Methods", "t3", false), CONCRETE(0x8, "Concrete Methods", "t4", false), - DEPRECATED(0x10, "Deprecated Methods", "t5", false); + DEFAULT(0x10, "Default Methods", "t5", false), + DEPRECATED(0x20, "Deprecated Methods", "t6", false); private final int value; private final String text; diff --git a/langtools/test/com/sun/javadoc/testHtmlTableTags/TestHtmlTableTags.java b/langtools/test/com/sun/javadoc/testHtmlTableTags/TestHtmlTableTags.java index 683d1d9dcc2..c6b14e05277 100644 --- a/langtools/test/com/sun/javadoc/testHtmlTableTags/TestHtmlTableTags.java +++ b/langtools/test/com/sun/javadoc/testHtmlTableTags/TestHtmlTableTags.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2009, 2012, 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 @@ -207,7 +207,7 @@ public class TestHtmlTableTags extends JavadocTester { "Instance Methods " + "" + "Concrete Methods " + - "" + + "" + "Deprecated Methods " + "" }, diff --git a/langtools/test/com/sun/javadoc/testLambdaFeature/TestLambdaFeature.java b/langtools/test/com/sun/javadoc/testLambdaFeature/TestLambdaFeature.java new file mode 100644 index 00000000000..383a394bf3c --- /dev/null +++ b/langtools/test/com/sun/javadoc/testLambdaFeature/TestLambdaFeature.java @@ -0,0 +1,102 @@ +/* + * Copyright (c) 2012, 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 8004893 + * @summary Make sure that the lambda feature changes work fine in + * javadoc. + * @author bpatel + * @library ../lib/ + * @build JavadocTester TestLambdaFeature + * @run main TestLambdaFeature + */ + +public class TestLambdaFeature extends JavadocTester { + + //Test information. + private static final String BUG_ID = "8004893"; + + //Javadoc arguments. + private static final String[] ARGS = new String[] { + "-d", BUG_ID, "-sourcepath", SRC_DIR, "pkg" + }; + + //Input for string search tests. + private static final String[][] TEST = { + {BUG_ID + FS + "pkg" + FS + "A.html", + "default void"}, + {BUG_ID + FS + "pkg" + FS + "A.html", + "
default void defaultMethod()
"}, + {BUG_ID + FS + "pkg" + FS + "A.html", + "" + + "All Methods " + + "" + + "Instance Methods" + + " " + + "Abstract Methods " + + "" + + "Default Methods" + + " "}, + {BUG_ID + FS + "pkg" + FS + "A.html", + "
" + NL + "
Functional Interface:
" + NL + + "
This is a functional interface and can therefore be used as " + + "the assignment target for a lambda expression or method " + + "reference.
" + NL + "
"} + }; + private static final String[][] NEGATED_TEST = { + {BUG_ID + FS + "pkg" + FS + "A.html", + "default default void"}, + {BUG_ID + FS + "pkg" + FS + "A.html", + "
default default void defaultMethod()
"}, + {BUG_ID + FS + "pkg" + FS + "B.html", + "default void"}, + {BUG_ID + FS + "pkg" + FS + "B.html", + "
" + NL + "
Functional Interface:
"} + }; + + /** + * The entry point of the test. + * @param args the array of command line arguments. + */ + public static void main(String[] args) { + TestLambdaFeature tester = new TestLambdaFeature(); + run(tester, ARGS, TEST, NEGATED_TEST); + tester.printSummary(); + } + + /** + * {@inheritDoc} + */ + public String getBugId() { + return BUG_ID; + } + + /** + * {@inheritDoc} + */ + public String getBugName() { + return getClass().getName(); + } +} diff --git a/langtools/test/com/sun/javadoc/testLambdaFeature/pkg/A.java b/langtools/test/com/sun/javadoc/testLambdaFeature/pkg/A.java new file mode 100644 index 00000000000..c52f249b491 --- /dev/null +++ b/langtools/test/com/sun/javadoc/testLambdaFeature/pkg/A.java @@ -0,0 +1,31 @@ +/* + * Copyright (c) 2012, 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. + */ + +package pkg; + +public interface A { + + public void method1(); + + public default void defaultMethod() { } +} diff --git a/langtools/test/com/sun/javadoc/testLambdaFeature/pkg/B.java b/langtools/test/com/sun/javadoc/testLambdaFeature/pkg/B.java new file mode 100644 index 00000000000..ccc58e191d2 --- /dev/null +++ b/langtools/test/com/sun/javadoc/testLambdaFeature/pkg/B.java @@ -0,0 +1,31 @@ +/* + * Copyright (c) 2012, 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. + */ + +package pkg; + +public abstract class B { + + public abstract void method1(); + + public void method2() { } +} diff --git a/langtools/test/com/sun/javadoc/testMethodTypes/TestMethodTypes.java b/langtools/test/com/sun/javadoc/testMethodTypes/TestMethodTypes.java index 6a60b5036bd..634ee4e4407 100644 --- a/langtools/test/com/sun/javadoc/testMethodTypes/TestMethodTypes.java +++ b/langtools/test/com/sun/javadoc/testMethodTypes/TestMethodTypes.java @@ -55,7 +55,7 @@ public class TestMethodTypes extends JavadocTester { "Instance Methods " + "" + "Concrete Methods " + - "" + + "" + "Deprecated Methods " + "" }, @@ -87,7 +87,7 @@ public class TestMethodTypes extends JavadocTester { "Abstract Methods " + "" + "Concrete Methods " + - "" + + "" + "Deprecated Methods " + "" },