/*

 * 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      4789689 4905985 4927164 4827184 4993906 5004549 7025314 7010344 8025633 8026567 8162363

 *           8175200 8186332

 * @summary  Run Javadoc on a set of source files that demonstrate new

 *           language features.  Check the output to ensure that the new

 *           language features are properly documented.

 * @author   jamieh

 * @library  ../lib

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

 * @build    JavadocTester

 * @run main TestNewLanguageFeatures

 */

public class TestNewLanguageFeatures extends JavadocTester {

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

        TestNewLanguageFeatures tester = new TestNewLanguageFeatures();

        tester.runTests();

    }

    @Test

    void test() {

        javadoc("-Xdoclint:none",

                "-d", "out",

                "-use", "-sourcepath",

                testSrc,

                "pkg", "pkg1", "pkg2");

        checkExit(Exit.OK);

        checkEnums();

        checkTypeParameters();

        checkVarArgs();

        checkAnnotationTypeUsage();

    }

    //=================================

    // ENUM TESTING

    //=================================

    void checkEnums() {

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

                // Make sure enum header is correct.

                "Enum Coin</h2>",

                // Make sure enum signature is correct.

                "<pre>public enum "

                + "<span class=\"typeNameLabel\">Coin</span>\n"

                + "title=\"enum in pkg\">Coin</a>&gt;</pre>",

                // Check for enum constant section

                "<caption><span>Enum Constants"

                + "</span><span class=\"tabEnd\">&nbsp;</span></caption>",

                // Detail for enum constant

                // Automatically insert documentation for values() and valueOf().

                "Returns an array containing the constants of this enum type,",

                "Returns the enum constant of this type with the specified name",

                "for (Coin c : Coin.values())",

                "Overloaded valueOf() method has correct documentation.",

                "Overloaded values method  has correct documentation.",

                "&nbsp;valueOf&#8203;(java.lang.String&nbsp;name)</pre>\n" +

                "<div class=\"block\">Returns the enum constant of this type with the specified name.\n" +

                "The string must match <i>exactly</i> an identifier used to declare an\n" +

                "enum constant in this type.  (Extraneous whitespace characters are \n" +

                "not permitted.)</div>\n" +

                "<dl>\n" +

                "<dt><span class=\"paramLabel\">Parameters:</span></dt>\n" +

                "<dd><code>name</code> - the name of the enum constant to be returned.</dd>\n" +

                "<dt><span class=\"returnLabel\">Returns:</span></dt>\n" +

                "<dd>the enum constant with the specified name</dd>\n" +

                "<dt><span class=\"throwsLabel\">Throws:</span></dt>\n" +

                "<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no " +

                "constant with the specified name</dd>\n" +

                "<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd>");

        // NO constructor section

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

                "<h3>Constructor Summary</h3>");

    }

    //=================================

    // TYPE PARAMETER TESTING

    //=================================

    void checkTypeParameters() {

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

                // Make sure the header is correct.

                "Class TypeParameters&lt;E&gt;</h2>",

                // Check class type parameters section.

                "<dt><span class=\"paramLabel\">Type Parameters:</span></dt>\n"

                + "<dd><code>E</code> - "

                + "the type parameter for this class.",

                // Type parameters in @see/@link

                "<dl>\n"

                + "<dt><span class=\"seeLabel\">See Also:</span></dt>\n"

                + "<dd>"

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

                + "</dl>",

                // Method that uses class type parameter.

                + "parameter in TypeParameters\">E</a>&nbsp;param)",

                // Method type parameter section.

                "<span class=\"paramLabel\">Type Parameters:</span></dt>\n"

                + "<dd><code>T</code> - This is the first "

                + "type parameter.</dd>\n"

                + "<dd><code>V</code> - This is the second type "

                + "parameter.",

                // Signature of method with type parameters

                "public <T extends java.util.List,V> "

                + "java.lang.String[] methodThatHasTypeParameters",

                // Method that returns TypeParameters

                + "title=\"type parameter in TypeParameters\">E</a>[]</code></td>\n"

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

                + "title=\"type parameter in TypeParameters\">E</a>[]&nbsp;e)</code>",

                + "title=\"type parameter in TypeParameters\">E</a>[]&nbsp;"

                + "title=\"type parameter in TypeParameters\">E</a>[]&nbsp;e)</pre>\n",

                "<td class=\"colFirst\"><code>&lt;T extends java.lang.Object &amp; java.lang.Comparable&lt;? super T&gt;&gt;"

                + "<br>T</code></td>\n"

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

                + "methodtThatReturnsTypeParametersB</a></span>&#8203;(java.util.Collection&lt;? extends T&gt;&nbsp;coll)</code>",

                "<div class=\"block\">Returns TypeParameters</div>\n",

                // Method takes a TypeVariable

                "<td class=\"colFirst\"><code>&lt;X extends java.lang.Throwable&gt;<br>"

                + "</code></td>\n"

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

                + "orElseThrow</a></span>&#8203;(java.util.function.Supplier&lt;? extends X&gt;&nbsp;exceptionSupplier)</code>"

                );

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

                // Wildcard testing.

                + "TypeParameters</a>&lt;? super java.lang.String&gt;&nbsp;a",

                + "TypeParameters</a>&lt;? extends java.lang.StringBuffer&gt;&nbsp;b",

                + "TypeParameters</a>&nbsp;c");

        checkOutput(Output.OUT, true,

                // Bad type parameter warnings.

                "warning - @param argument "

                + "\"<BadClassTypeParam>\" is not a type parameter name.",

                "warning - @param argument "

                + "\"<BadMethodTypeParam>\" is not a type parameter name.");

        // Signature of subclass that has type parameters.

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

                "<pre>public class <span class=\"typeNameLabel\">TypeParameterSubClass&lt;T extends "

                + "java.lang.String&gt;</span>\n"

                + "extends "

                + "TypeParameterSuperClass</a>&lt;T&gt;</pre>");

        // Interface generic parameter substitution

        // Signature of subclass that has type parameters.

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

                "<dl>\n"

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

                + "title=\"interface in pkg\">SuperInterface</a>&lt;E&gt;</code></dd>\n"

                + "</dl>");

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

                "<dl>\n"

                + "<dt>All Known Subinterfaces:</dt>\n"

                + "SubInterface</a>&lt;V&gt;</code></dd>\n"

                + "</dl>");

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

                "<dl>\n"

                + "<dt>All Superinterfaces:</dt>\n"

                + "SuperInterface</a>&lt;V&gt;</code></dd>\n"

                + "</dl>");

        //==============================================================

        // Handle multiple bounds.

        //==============================================================

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

                "public <T extends java.lang.Number & java.lang.Runnable> T foo​(T t)");

        //==============================================================

        // Test Class-Use Documentation for Type Parameters.

        //==============================================================

        // ClassUseTest1: <T extends Foo & Foo2>

        checkOutput("pkg2/class-use/Foo.html", true,

                + "package-summary.html\">pkg2</a> with type parameters of "

                + "Foo</a></span><span class=\"tabEnd\">&nbsp;</span></caption>",

                + "title=\"class in pkg2\">ClassUseTest1</a>&lt;T extends "

                + "Foo2</a>&gt;</span></code></th>",

                + "package-summary.html\">pkg2</a> with type parameters of "

                + "pkg2\">Foo</a></span><span class=\"tabEnd\">&nbsp;</span></caption>",

                "<th class=\"colSecond\" scope=\"row\"><span class=\"typeNameLabel\">ClassUseTest1."

                + "ClassUseTest1.html#method-T-\">method</a></span>"

                + "&#8203;(T&nbsp;t)</code></th>",

                + "package-summary.html\">pkg2</a> with type parameters of "

                + "Foo</a></span><span class=\"tabEnd\">&nbsp;</span></caption>",

                + "ParamTest.html\" title=\"class in pkg2\">ParamTest</a>"

                + ">Foo</a>&gt;</code></td>"

        );

        checkOutput("pkg2/class-use/ParamTest.html", true,

                + "package-summary.html\">pkg2</a> declared as <a href=\"../"

                + "</a></span><span class=\"tabEnd\">&nbsp;</span></caption>",

                + "ParamTest.html\" title=\"class in pkg2\">ParamTest</a>&lt;<a "

                + ">&gt;</code></td>"

        );

        checkOutput("pkg2/class-use/Foo2.html", true,

                + "package-summary.html\">pkg2</a> with type parameters of "

                + "in pkg2\">Foo2</a></span><span class=\"tabEnd\">&nbsp;"

                + "</span></caption>",

                + "title=\"class in pkg2\">ClassUseTest1</a>&lt;T extends "

                + "Foo2</a>&gt;</span></code></th>",

                + "package-summary.html\">pkg2</a> with type parameters of "

                + "in pkg2\">Foo2</a></span><span class=\"tabEnd\">&nbsp;"

                + "</span></caption>",

                "<th class=\"colSecond\" scope=\"row\"><span class=\"typeNameLabel\">"

                + "&#8203;(T&nbsp;t)</code></th>"

        );

        // ClassUseTest2: <T extends ParamTest<Foo3>>

        checkOutput("pkg2/class-use/ParamTest.html", true,

                + "package-summary.html\">pkg2</a> with type parameters of "

                + "in pkg2\">ParamTest</a></span><span class=\"tabEnd\">"

                + "&nbsp;</span></caption>",

                + "title=\"class in pkg2\">ClassUseTest2</a>&lt;T extends "

                + "Foo3</a>&gt;&gt;</span></code></th>",

                + "package-summary.html\">pkg2</a> with type parameters of "

                + "in pkg2\">ParamTest</a></span><span class=\"tabEnd\">"

                + "&nbsp;</span></caption>",

                "<th class=\"colSecond\" scope=\"row\"><span class=\"typeNameLabel\">ClassUseTest2."

                + "ClassUseTest2.html#method-T-\">method</a></span>"

                + "&#8203;(T&nbsp;t)</code></th>",

                + "package-summary.html\">pkg2</a> declared as <a href=\"../"

                + "</a></span><span class=\"tabEnd\">&nbsp;</span></caption>",

                + "ParamTest.html\" title=\"class in pkg2\">ParamTest</a>"

                + "Foo</a>&gt;</code></td>",

                + "package-summary.html\">pkg2</a> with type parameters of "

                + "in pkg2\">ParamTest</a></span><span class=\"tabEnd\">"

                + "&nbsp;</span></caption>",

                "<td class=\"colFirst\"><code>&lt;T extends <a href=\"../"

                + "ParamTest.html\" title=\"class in pkg2\">ParamTest</a>"

                + "pkg2\">Foo3</a>&gt;</code></td>"

        );

        checkOutput("pkg2/class-use/Foo3.html", true,

                + "package-summary.html\">pkg2</a> with type parameters of "

                + "Foo3</a></span><span class=\"tabEnd\">&nbsp;</span></caption>",

                + "title=\"class in pkg2\">ClassUseTest2</a>&lt;T extends "

                + "Foo3</a>&gt;&gt;</span></code></th>",

                + "package-summary.html\">pkg2</a> with type parameters of "

                + "pkg2\">Foo3</a></span><span class=\"tabEnd\">&nbsp;"

                + "</span></caption>",

                "<th class=\"colSecond\" scope=\"row\"><span class=\"typeNameLabel\">ClassUseTest2."

                + "ClassUseTest2.html#method-T-\">method</a></span>"

                + "&#8203;(T&nbsp;t)</code></th>",

                + "package-summary.html\">pkg2</a> that return types with "

                + "=\"class in pkg2\">Foo3</a></span><span class=\"tabEnd\">"

                + "&nbsp;</span></caption>",

                + "Foo3.html\" title=\"class in pkg2\">Foo3</a>&gt;</code></td>"

        );

        // ClassUseTest3: <T extends ParamTest2<List<? extends Foo4>>>

        checkOutput("pkg2/class-use/ParamTest2.html", true,

                + "package-summary.html\">pkg2</a> with type parameters of "

                + "in pkg2\">ParamTest2</a></span><span class=\"tabEnd\">"

                + "&nbsp;</span></caption>",

                + "title=\"class in pkg2\">ClassUseTest3</a>&lt;T extends "

                + "ParamTest2</a>&lt;java.util.List&lt;? extends "

                + "Foo4</a>&gt;&gt;&gt;</span></code></th>",

                + "package-summary.html\">pkg2</a> with type parameters of "

                + "in pkg2\">ParamTest2</a></span><span class=\"tabEnd\">"

                + "&nbsp;</span></caption>",

                "<th class=\"colSecond\" scope=\"row\"><span class=\"typeNameLabel\">ClassUseTest3"

                + "html#method-T-\">method</a></span>&#8203;(T&nbsp;t)</code></th>",

                "<td class=\"colFirst\"><code>&lt;T extends <a href=\"../"

                + "ParamTest2</a>&lt;java.util.List&lt;? extends <a href=\".."

                + "title=\"class in pkg2\">ParamTest2</a>&lt;java.util.List"

                + "class in pkg2\">Foo4</a>&gt;&gt;</code></td>"

        );

        checkOutput("pkg2/class-use/Foo4.html", true,

                + "package-summary.html\">pkg2</a> with type parameters of "

                + "pkg2\">Foo4</a></span><span class=\"tabEnd\">&nbsp;"

                + "</span></caption>",

                + "title=\"class in pkg2\">ClassUseTest3</a>&lt;T extends "

                + "ParamTest2</a>&lt;java.util.List&lt;? extends "

                + "Foo4</a>&gt;&gt;&gt;</span></code></th>",

                + "package-summary.html\">pkg2</a> with type parameters of "

                + "pkg2\">Foo4</a></span><span class=\"tabEnd\">&nbsp;</span></caption>",

                "<th class=\"colSecond\" scope=\"row\"><span class=\"typeNameLabel\">ClassUseTest3."

                + "html#method-T-\">method</a></span>&#8203;(T&nbsp;t)</code>"

                + "</th>",

                + "package-summary.html\">pkg2</a> that return types with "

                + "title=\"class in pkg2\">Foo4</a></span><span class=\""

                + "tabEnd\">&nbsp;</span></caption>",

                "<td class=\"colFirst\"><code>&lt;T extends <a href=\"../"

                + "ParamTest2</a>&lt;java.util.List&lt;? extends <a href=\".."

                + "title=\"class in pkg2\">ParamTest2</a>&lt;java.util.List"

                + "class in pkg2\">Foo4</a>&gt;&gt;</code></td>"

        );

        // Type parameters in constructor and method args

        checkOutput("pkg2/class-use/Foo4.html", true,

                + "package-summary.html\">pkg2</a> with type arguments of "

                + "pkg2\">Foo4</a></span><span class=\"tabEnd\">&nbsp;"

                + "</span></caption>\n"

                + "<tr>\n"

                + "<th class=\"colFirst\" scope=\"col\">Modifier and Type</th>\n"

                + "<th class=\"colSecond\" scope=\"col\">Method</th>\n"

                + "<th class=\"colLast\" scope=\"col\">Description</th>\n"

                + "</tr>\n"

                + "<tbody>\n"

                + "<tr class=\"altColor\">\n"

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

                + "<th class=\"colSecond\" scope=\"row\"><span class=\"typeNameLabel\">ClassUseTest3."

                + "html#method-java.util.Set-\">method</a></span>&#8203;(java."

                + "class in pkg2\">Foo4</a>&gt;&nbsp;p)</code></th>",

                + "pkg2\">Foo4</a></span><span class=\"tabEnd\">&nbsp;"

                + "</span></caption>"

        );

        //=================================

        // TYPE PARAMETER IN INDEX

        //=================================

        checkOutput("index-all.html", true,

                "<span class=\"memberNameLink\"><a href=\"pkg2/Foo.html#method-java.util.Vector-\">"

                + "method(Vector&lt;Object&gt;)</a></span>"

        );

        // TODO: duplicate of previous case; left in delibarately for now to simplify comparison testing

        //=================================

        // TYPE PARAMETER IN INDEX

        //=================================

        checkOutput("index-all.html", true,

                "<span class=\"memberNameLink\"><a href=\"pkg2/Foo.html#method-java.util.Vector-\">"

                + "method(Vector&lt;Object&gt;)</a></span>"

        );

        // No type parameters in class frame.

        checkOutput("allclasses-frame.html", false,

                "<a href=\"../pkg/TypeParameters.html\" title=\"class in pkg\">"

                + "TypeParameters</a>&lt;<a href=\"../pkg/TypeParameters.html\" "

                + "title=\"type parameter in TypeParameters\">E</a>&gt;"

        );

    }

    //=================================

    // VAR ARG TESTING

    //=================================

    void checkVarArgs() {

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

                "(int... i)",

                "(int[][]... i)",

                "-int:A...-",