/*

 * 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.

 *

 */

/*

 * @test

 * @bug      4682448 4947464 5029946

 * @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/

 * @build    JavadocTester

 * @build    TestInterface

 * @run main TestInterface

 */

public class TestInterface extends JavadocTester {

    //Test information.

    private static final String BUG_ID = "4682448-4947464-5029946";

    //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 + "Interface.html",

            "int <STRONG>method</STRONG>()"},

        {BUG_ID + FS + "pkg" + FS + "Interface.html",

            "static final int <STRONG>field</STRONG>"},

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

        {BUG_ID + FS + "pkg" + FS + "Interface.html",

            "<DT><STRONG>All Known Implementing Classes:</STRONG></DT> " +

            "<DD><A HREF=\"../pkg/Child.html\" " +

            "title=\"class in pkg\">Child</A>, " +

            "<A HREF=\"../pkg/Parent.html\" title=\"class in pkg\">" +

            "Parent</A></DD>"},

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

         {BUG_ID + FS + "pkg" + FS + "Child.html",

            "<STRONG>All Implemented Interfaces:</STRONG></DT> <DD>" +

            "<A HREF=\"../pkg/Interface.html\" title=\"interface in pkg\">" +

            "Interface</A>&lt;T&gt;"

         },

         //Make sure Class Tree has substituted type parameters.

         {BUG_ID + FS + "pkg" + FS + "Child.html",

            "<PRE>" + NL +

            "java.lang.Object" + NL +

            "  <IMG SRC=\"../resources/inherit.gif\" ALT=\"extended by \"><A HREF=\"../pkg/Parent.html\" title=\"class in pkg\">pkg.Parent</A>&lt;T&gt;" + NL +

            "      <IMG SRC=\"../resources/inherit.gif\" ALT=\"extended by \"><STRONG>pkg.Child&lt;T&gt;</STRONG>" + NL +

            "</PRE>"

         },

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

        {BUG_ID + FS + "pkg" + FS + "Parent.html",

            "<STRONG>Direct Known Subclasses:</STRONG></DT> <DD><A HREF=\"../pkg/Child.html\" title=\"class in pkg\">Child</A>"

        },

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

        {BUG_ID + FS + "pkg" + FS + "Child.html",

            "<STRONG>Specified by:</STRONG></DT><DD><CODE><A HREF=\"../pkg/Interface.html#method()\">method</A></CODE> in interface <CODE><A HREF=\"../pkg/Interface.html\" title=\"interface in pkg\">Interface</A>&lt;<A HREF=\"../pkg/Child.html\" title=\"type parameter in Child\">T</A>&gt;</CODE>"

         },

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

        {BUG_ID + FS + "pkg" + FS + "Child.html",

            "<STRONG>Overrides:</STRONG></DT><DD><CODE><A HREF=\"../pkg/Parent.html#method()\">method</A></CODE> in class <CODE><A HREF=\"../pkg/Parent.html\" title=\"class in pkg\">Parent</A>&lt;<A HREF=\"../pkg/Child.html\" title=\"type parameter in Child\">T</A>&gt;</CODE>"

         },

    };

    private static final String[][] NEGATED_TEST = {

        {BUG_ID + FS + "pkg" + FS + "Interface.html",

            "public int <STRONG>method</STRONG>()"},

        {BUG_ID + FS + "pkg" + FS + "Interface.html",

            "public static final int <STRONG>field</STRONG>"},

    };

    /**

     * The entry point of the test.

     * @param args the array of command line arguments.

     */

    public static void main(String[] args) {

        TestInterface tester = new TestInterface();

        run(tester, ARGS, TEST, NEGATED_TEST);

        tester.printSummary();

    }

    /**

     * {@inheritDoc}

     */

    public String getBugId() {

        return BUG_ID;

    }

    /**

     * {@inheritDoc}

     */

    public String getBugName() {

        return getClass().getName();

    }

}