/*

 * Copyright (c) 2003, 2019, 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      4682448 4947464 5029946 8025633 8026567 8035473 8139101 8175200

             8186332 8186703 8182765 8187288

 * @summary  Verify that the public modifier does not show up in the

 *           documentation for public methods, as recommended by the JLS.

 *           If A implements I and B extends A, B should be in the list of

 *           implementing classes in the documentation for I.

 * @author   jamieh

 * @library  ../../lib

 * @modules jdk.javadoc/jdk.javadoc.internal.tool

 * @build    javadoc.tester.*

 * @run main TestInterface

 */

/*

 * TODO: make it Interface<PE> ie. fix all ParameterTypes, likely should get

 * fixed when Doc is replace by j.l.m, but meanwhile this test has been adjusted

 * take the current format this is better than @ignore because we can follow the

 * differences as the work progress.

 *

 * The consensus is that we should have something as follows:

 * In Child.html

 *  Specified by:  method in interface<IE>

 *  Overrides:     method in class Parent<PE>

 * In otherwords the TypeParameter in scope should be used ex: Interface<IE>, Parent<PE>

   and Child<CE>

 */

import javadoc.tester.JavadocTester;

public class TestInterface extends JavadocTester {

    public static void main(String... args) throws Exception {

        TestInterface tester = new TestInterface();

        tester.runTests();

    }

    @Test

    public void test() {

        javadoc("-d", "out",

                "-sourcepath", testSrc,

                "pkg");

        checkExit(Exit.OK);

        checkOutput("pkg/Interface.html", true,

                "<pre class=\"methodSignature\">int&nbsp;method()</pre>",

                "<pre>static final&nbsp;int field</pre>",

                // Make sure known implementing class list is correct and omits type parameters.

                "<dl>\n"

                + "<dt>All Known Implementing Classes:</dt>\n"

                + "<dd><code><a href=\"Child.html\" title=\"class in pkg\">Child"

                + "</a></code>, <code><a href=\"Parent.html\" title=\"class in pkg\">Parent"

                + "</a></code></dd>\n"

                + "</dl>");

        checkOutput("pkg/Child.html", true,

                // Make sure "All Implemented Interfaces": has substituted type parameters

                "<dl>\n"

                + "<dt>All Implemented Interfaces:</dt>\n"

                + "<dd><code><a href=\"Interface.html\" title=\"interface in pkg\">"

                + "Interface</a>&lt;CE&gt;</code></dd>\n"

                + "</dl>",

                //Make sure Class Tree has substituted type parameters.

                "<ul class=\"inheritance\">\n"

                + "<li>java.lang.Object</li>\n"

                + "<li>\n"

                + "<ul class=\"inheritance\">\n"

                + "<li><a href=\"Parent.html\" title=\"class in pkg\">"

                + "pkg.Parent</a>&lt;CE&gt;</li>\n"

                + "<li>\n"

                + "<ul class=\"inheritance\">\n"

                + "<li>pkg.Child&lt;CE&gt;</li>\n"

                + "</ul>\n"

                + "</li>\n"

                + "</ul>\n"

                + "</li>\n"

                + "</ul>",

                //Make sure "Specified By" has substituted type parameters.

                "<dt><span class=\"overrideSpecifyLabel\">Specified by:</span></dt>\n"

                + "<dd><code><a href=\"Interface.html#method()\">method</a>"

                + "</code>&nbsp;in interface&nbsp;<code>"

                + "<a href=\"Interface.html\" title=\"interface in pkg\">"

                + "Interface</a>&lt;<a href=\"Child.html\" title=\"type parameter in Child\">"

                + "CE</a>&gt;</code></dd>",

                //Make sure "Overrides" has substituted type parameters.

                "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"

                + "<dd><code><a href=\"Parent.html#method()\">method</a>"

                + "</code>&nbsp;in class&nbsp;<code><a href=\"Parent.html\" "

                + "title=\"class in pkg\">Parent</a>&lt;<a href=\"Child.html\" "

                + "title=\"type parameter in Child\">CE</a>&gt;</code></dd>");

        checkOutput("pkg/Parent.html", true,

                //Make sure "Direct Know Subclasses" omits type parameters

                "<dl>\n"

                + "<dt>Direct Known Subclasses:</dt>\n"

                + "<dd><code><a href=\"Child.html\" title=\"class in pkg\">Child"

                + "</a></code></dd>\n"

                + "</dl>");

        checkOutput("pkg/Interface.html", false,

                "public int method--",

                "public static final int field");

        checkOutput("pkg/ClassWithStaticMembers.html", false,

                //Make sure "Specified By" does not appear on class documentation when

                //the method is a static method in the interface.

                "<dt><span class=\"overrideSpecifyLabel\">Specified by:</span></dt>\n");

        checkOutput("pkg/ClassWithStaticMembers.html", true,

                + "<pre>public static&nbsp;int f</pre>\n"

                + "<div class=\"block\">A hider field</div>",

                "<td class=\"colFirst\"><code>static void</code></td>\n"

                + "<th class=\"colSecond\" scope=\"row\"><code><span class=\"memberNameLink\">"

                + "<a href=\"#m()\">m</a></span>()</code></th>\n"

                + "<td class=\"colLast\">\n"

                + "<div class=\"block\">A hider method</div>\n"

                + "</td>\n",

                + "<pre class=\"methodSignature\">public static&nbsp;void&nbsp;staticMethod()</pre>\n"

                + "<div class=\"block\"><span class=\"descfrmTypeLabel\">"

                + "Description copied from interface:&nbsp;<code>"

                + "<a href=\"InterfaceWithStaticMembers.html#staticMethod()\">"

                + "InterfaceWithStaticMembers</a></code></span></div>\n"

                + "<div class=\"block\">A static method</div>\n");

        checkOutput("pkg/ClassWithStaticMembers.InnerClass.html", true,

                "<pre>public static class <span class=\"typeNameLabel\">"

                + "ClassWithStaticMembers.InnerClass</span>\n"

                + "extends java.lang.Object</pre>\n"

                + "<div class=\"block\">A hider inner class</div>");

    }

    @Test

    public void test1() {

        javadoc("-d", "out-1",

                "-sourcepath", testSrc,

                "pkg1");

        checkExit(Exit.OK);

        checkOutput("pkg1/Child.html", true,

            // Ensure the correct Overrides in the inheritance hierarchy is reported

            "<span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n" +

            "<dd><code><a href=\"GrandParent.html#method1()\">method1</a></code>" +

            " in class " +

            "<code><a href=\"GrandParent.html\" title=\"class in pkg1\">GrandParent</a>" +

            "&lt;<a href=\"Child.html\" title=\"type parameter in Child\">CE</a>&gt;</code>");

    }

    @Test

    public void test2() {

        javadoc("-d", "out-2",

                "-sourcepath", testSrc,

                "pkg2");

        checkExit(Exit.OK);

        checkOutput("pkg2/Spliterator.OfDouble.html", true,

            // Ensure the correct type parameters are displayed correctly

            + "<code><a href=\"Spliterator.OfDouble.html\" title=\"interface in pkg2\">"

            + "Spliterator.OfDouble</a>, <a href=\"Spliterator.OfInt.html\" "

            + "title=\"interface in pkg2\">Spliterator.OfInt</a>&lt;"

            + "<a href=\"Spliterator.OfInt.html\" title=\"type parameter in Spliterator.OfInt\">"

            + "Integer</a>&gt;, <a href=\"Spliterator.OfPrimitive.html\" title=\"interface in pkg2\">"

            + "Spliterator.OfPrimitive</a>&lt;<a href=\"Spliterator.OfPrimitive.html\" "

            + "title=\"type parameter in Spliterator.OfPrimitive\">T</a>,&#8203;<a href=\"Spliterator.OfPrimitive.html\" "

            + "title=\"type parameter in Spliterator.OfPrimitive\">T_CONS</a>,&#8203;"

            + "<a href=\"Spliterator.OfPrimitive.html\" title=\"type parameter in Spliterator.OfPrimitive\">"

            + "T_SPLITR</a> extends <a href=\"Spliterator.OfPrimitive.html\" title=\"interface in pkg2\">"

            + "Spliterator.OfPrimitive</a>&lt;<a href=\"Spliterator.OfPrimitive.html\" "

            + "title=\"type parameter in Spliterator.OfPrimitive\">T</a>,&#8203;"

            + "<a href=\"Spliterator.OfPrimitive.html\" title=\"type parameter in Spliterator.OfPrimitive\">"

            + "T_CONS</a>,&#8203;<a href=\"Spliterator.OfPrimitive.html\" title=\"type parameter in Spliterator.OfPrimitive\">"

            + "T_SPLITR</a>&gt;&gt;</code>");

    }

}