/*

 * Copyright (c) 2003, 2014, 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      4789689 4905985 4927164 4827184 4993906 5004549 7025314 7010344 8025633 8026567

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

 * @build    JavadocTester TestNewLanguageFeatures

 * @run main TestNewLanguageFeatures

 */

public class TestNewLanguageFeatures extends JavadocTester {

    //Javadoc arguments.

    private static final String[] ARGS = new String[] {

        "pkg", "pkg1", "pkg2"

    };

    //Input for string search tests.

    private static final String[][] TEST =

        {

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

            // ENUM TESTING

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

            //Make sure enum header is correct.

            //Make sure enum signature is correct.

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

                     "extends java.lang.Enum&lt;<a href=\"../pkg/Coin.html\" " +

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

            },

            //Check for enum constant section

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

            //Detail for enum constant

                "<span class=\"memberNameLink\"><a href=\"../pkg/Coin.html#Dime\">Dime</a></span>"},

            //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"},

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

                "Overloaded values method  has correct documentation."},

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

            // TYPE PARAMETER TESTING

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

            //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>" +

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

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

                "</dl>"},

            //Method that uses class type parameter.

                "(<a href=\"../pkg/TypeParameters.html\" title=\"type " +

                    "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"},

            //Wildcard testing.

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

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

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

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

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

                    "TypeParameters</a>&nbsp;c"},

            //Bad type parameter warnings.

            {WARNING_OUTPUT, "warning - @param argument " +

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

            {WARNING_OUTPUT, "warning - @param argument " +

                "\"<BadMethodTypeParam>\" is not a type parameter name."},

            //Signature of subclass that has type parameters.

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

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

                "extends " +

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

                "TypeParameterSuperClass</a>&lt;T&gt;</pre>"},

            //Interface generic parameter substitution

            //Signature of subclass that has type parameters.

                "<dl>\n" +

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

                "<dd><a href=\"../pkg/SubInterface.html\" title=\"interface in pkg\">" +

                "SubInterface</a>&lt;E&gt;, <a href=\"../pkg/SuperInterface.html\" " +

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

                "</dl>"},

                "<dl>\n" +

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

                "<dd><a href=\"../pkg/SubInterface.html\" title=\"interface in pkg\">" +

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

                "</dl>"},

                "<dl>\n" +

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

                "<dd><a href=\"../pkg/SuperInterface.html\" title=\"interface in pkg\">" +

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

                "</dl>"},

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

            // VAR ARG TESTING

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

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

                "TypeParameters</a>...&nbsp;t"},

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

            // ANNOTATION TYPE TESTING

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

            //Make sure the summary links are correct.

                "<li>Summary:&nbsp;</li>\n" +

                "<li>Field&nbsp;|&nbsp;</li>\n" +

                "<li><a href=\"#annotation.type.required.element.summary\">" +

                "Required</a>&nbsp;|&nbsp;</li>\n" +

                "<li>" +

                "<a href=\"#annotation.type.optional.element.summary\">Optional</a></li>"},

            //Make sure the detail links are correct.

                "<li>Detail:&nbsp;</li>\n" +

                "<li>Field&nbsp;|&nbsp;</li>\n" +

                "<li><a href=\"#annotation.type.element.detail\">Element</a></li>"},

            //Make sure the heading is correct.

                "Annotation Type AnnotationType</h2>"},

            //Make sure the signature is correct.

                "public @interface <span class=\"memberNameLabel\">AnnotationType</span>"},

            //Make sure member summary headings are correct.

                "<h3>Required Element Summary</h3>"},

                "<h3>Optional Element Summary</h3>"},

            //Make sure element detail heading is correct

                "Element Detail"},

            //Make sure default annotation type value is printed when necessary.

                "<dl>\n" +

                "<dt>Default:</dt>\n" +

                "<dd>\"unknown\"</dd>\n" +

                "</dl>"},

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

            // ANNOTATION TYPE USAGE TESTING

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

            //PACKAGE

                "<a href=\"../pkg/AnnotationType.html\" title=\"annotation in pkg\">@AnnotationType</a>(<a href=\"../pkg/AnnotationType.html#optional--\">optional</a>=\"Package Annotation\",\n" +

                "                <a href=\"../pkg/AnnotationType.html#required--\">required</a>=1994)"},

            //CLASS

                "<pre><a href=\"../pkg/AnnotationType.html\" " +

                "title=\"annotation in pkg\">@AnnotationType</a>(" +

                "<a href=\"../pkg/AnnotationType.html#optional--\">optional</a>" +

                "=\"Class Annotation\",\n" +

                "                <a href=\"../pkg/AnnotationType.html#required--\">" +

                "required</a>=1994)\n" +

                "public class <span class=\"typeNameLabel\">" +

                "AnnotationTypeUsage</span>\n" +

                "extends java.lang.Object</pre>"},

            //FIELD

                "<pre><a href=\"../pkg/AnnotationType.html\" " +

                "title=\"annotation in pkg\">@AnnotationType</a>(" +

                "<a href=\"../pkg/AnnotationType.html#optional--\">optional</a>" +

                "=\"Field Annotation\",\n" +

                "                <a href=\"../pkg/AnnotationType.html#required--\">" +

                "required</a>=1994)\n" +

                "public&nbsp;int field</pre>"},

            //CONSTRUCTOR

                "<pre><a href=\"../pkg/AnnotationType.html\" " +

                "title=\"annotation in pkg\">@AnnotationType</a>(" +

                "<a href=\"../pkg/AnnotationType.html#optional--\">optional</a>" +

                "=\"Constructor Annotation\",\n" +

                "                <a href=\"../pkg/AnnotationType.html#required--\">" +

                "required</a>=1994)\n" +

                "public&nbsp;AnnotationTypeUsage()</pre>"},

            //METHOD

                "<pre><a href=\"../pkg/AnnotationType.html\" " +

                "title=\"annotation in pkg\">@AnnotationType</a>(" +

                "<a href=\"../pkg/AnnotationType.html#optional--\">optional</a>" +

                "=\"Method Annotation\",\n" +

                "                <a href=\"../pkg/AnnotationType.html#required--\">" +

                "required</a>=1994)\n" +

                "public&nbsp;void&nbsp;method()</pre>"},

            //METHOD PARAMS

                "<pre>public&nbsp;void&nbsp;methodWithParams(" +

                "<a href=\"../pkg/AnnotationType.html\" title=\"annotation in pkg\">" +

                "@AnnotationType</a>(<a href=\"../pkg/AnnotationType.html#optional--\">" +

                "optional</a>=\"Parameter Annotation\",<a " +

                "href=\"../pkg/AnnotationType.html#required--\">required</a>=1994)\n" +

                "                             int documented,\n" +

                "                             int&nbsp;undocmented)</pre>"},

            //CONSTRUCTOR PARAMS

                "<pre>public&nbsp;AnnotationTypeUsage(<a " +

                "href=\"../pkg/AnnotationType.html\" title=\"annotation in pkg\">" +

                "@AnnotationType</a>(<a href=\"../pkg/AnnotationType.html#optional--\">" +

                "optional</a>=\"Constructor Param Annotation\",<a " +

                "href=\"../pkg/AnnotationType.html#required--\">required</a>=1994)\n" +

                "                           int documented,\n" +

                "                           int&nbsp;undocmented)</pre>"},

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

            // ANNOTATION TYPE USAGE TESTING (All Different Types).

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

            //Integer

                "<a href=\"../pkg1/A.html#d--\">d</a>=3.14,"},

            //Double

                "<a href=\"../pkg1/A.html#d--\">d</a>=3.14,"},

            //Boolean

                "<a href=\"../pkg1/A.html#b--\">b</a>=true,"},

            //String

                "<a href=\"../pkg1/A.html#s--\">s</a>=\"sigh\","},

            //Class

                "<a href=\"../pkg1/A.html#c--\">c</a>=<a href=\"../pkg2/Foo.html\" title=\"class in pkg2\">Foo.class</a>,"},

            //Bounded Class

                "<a href=\"../pkg1/A.html#w--\">w</a>=<a href=\"../pkg/TypeParameterSubClass.html\" title=\"class in pkg\">TypeParameterSubClass.class</a>,"},

            //Enum

                "<a href=\"../pkg1/A.html#e--\">e</a>=<a href=\"../pkg/Coin.html#Penny\">Penny</a>,"},

            //Annotation Type

                "<a href=\"../pkg1/A.html#a--\">a</a>=<a href=\"../pkg/AnnotationType.html\" title=\"annotation in pkg\">@AnnotationType</a>(<a href=\"../pkg/AnnotationType.html#optional--\">optional</a>=\"foo\",<a href=\"../pkg/AnnotationType.html#required--\">required</a>=1994),"},

            //String Array

                "<a href=\"../pkg1/A.html#sa--\">sa</a>={\"up\",\"down\"},"},

            //Primitive

                "<a href=\"../pkg1/A.html#primitiveClassTest--\">primitiveClassTest</a>=boolean.class,"},

            //XXX:  Add array test case after this if fixed:

            //5020899: Incorrect internal representation of class-valued annotation elements

            //Make sure that annotations are surrounded by <pre> and </pre>

                "<pre><a href=\"../pkg1/A.html\" title=\"annotation in pkg1\">@A</a>"},

                "public interface <span class=\"typeNameLabel\">B</span></pre>"},

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

            // Handle multiple bounds.

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

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

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

            // Test Class-Use Documenation for Type Parameters.

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

            //ClassUseTest1: <T extends Foo & Foo2>

                     "<caption><span>Classes in <a href=\"../../pkg2/" +

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

                     "type <a href=\"../../pkg2/Foo.html\" title=\"class in pkg2\">" +

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

            },

                     "<td class=\"colLast\"><code><span class=\"memberNameLink\"><a href=\"../../pkg2/ClassUseTest1.html\" " +

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

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

                     "</a> &amp; <a href=\"../../pkg2/Foo2.html\" title=\"interface in pkg2\">" +

                     "Foo2</a>&gt;</span></code>&nbsp;</td>"

            },

                     "<caption><span>Methods in <a href=\"../../pkg2/" +

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

                     "type <a href=\"../../pkg2/Foo.html\" title=\"class in " +

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

            },

                     "<td class=\"colLast\"><span class=\"typeNameLabel\">ClassUseTest1." +

                     "</span><code><span class=\"memberNameLink\"><a href=\"../../pkg2/" +

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

                     "(T&nbsp;t)</code>&nbsp;</td>"

            },

                     "<caption><span>Fields in <a href=\"../../pkg2/" +

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

                     "type <a href=\"../../pkg2/Foo.html\" title=\"class in pkg2\">" +

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

            },

                     "td class=\"colFirst\"><code><a href=\"../../pkg2/" +

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

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

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

            },

                     "<caption><span>Fields in <a href=\"../../pkg2/" +

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

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

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

            },

                     "<td class=\"colFirst\"><code><a href=\"../../pkg2/" +

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

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

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

            },

                    "<caption><span>Classes in <a href=\"../../pkg2/" +

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

                    "type <a href=\"../../pkg2/Foo2.html\" title=\"interface " +

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

                    "</span></caption>"

           },

                    "<td class=\"colLast\"><code><span class=\"memberNameLink\"><a href=\"../../pkg2/ClassUseTest1.html\" " +

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

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

                     "</a> &amp; <a href=\"../../pkg2/Foo2.html\" title=\"interface in pkg2\">" +

                     "Foo2</a>&gt;</span></code>&nbsp;</td>"

           },

                    "<caption><span>Methods in <a href=\"../../pkg2/" +

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

                    "type <a href=\"../../pkg2/Foo2.html\" title=\"interface " +

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

                    "</span></caption>"

            },

                     "<td class=\"colLast\"><span class=\"typeNameLabel\">" +

                     "ClassUseTest1.</span><code><span class=\"memberNameLink\"><a href=\"../../" +

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

                     "(T&nbsp;t)</code>&nbsp;</td>"

            },

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

                     "<caption><span>Classes in <a href=\"../../pkg2/" +

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

                     "type <a href=\"../../pkg2/ParamTest.html\" title=\"class " +

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

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

            },

                     "<td class=\"colLast\"><code><span class=\"memberNameLink\"><a href=\"../../pkg2/ClassUseTest2.html\" " +

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

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

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

                     "Foo3</a>&gt;&gt;</span></code>&nbsp;</td>"

            },

                     "<caption><span>Methods in <a href=\"../../pkg2/" +

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

                     "type <a href=\"../../pkg2/ParamTest.html\" title=\"class " +

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

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

            },

                     "<td class=\"colLast\"><span class=\"typeNameLabel\">ClassUseTest2." +

                     "</span><code><span class=\"memberNameLink\"><a href=\"../../pkg2/" +

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

                     "(T&nbsp;t)</code>&nbsp;</td>"

            },

                     "<caption><span>Fields in <a href=\"../../pkg2/" +

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

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

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

            },

                     "<td class=\"colFirst\"><code><a href=\"../../pkg2/" +

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

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

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

            },

                     "<caption><span>Methods in <a href=\"../../pkg2/" +

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

                     "type <a href=\"../../pkg2/ParamTest.html\" title=\"class " +

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

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

            },

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

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

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

                     "pkg2\">Foo3</a>&gt;&gt;<br><a href=\"../../pkg2/" +

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

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

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

            },

                     "<caption><span>Classes in <a href=\"../../pkg2/" +

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

                     "type <a href=\"../../pkg2/Foo3.html\" title=\"class in pkg2\">" +

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

            },

                     "<td class=\"colLast\"><code><span class=\"memberNameLink\"><a href=\"../../pkg2/ClassUseTest2.html\" " +

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

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

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

                     "Foo3</a>&gt;&gt;</span></code>&nbsp;</td>"

            },

                     "<caption><span>Methods in <a href=\"../../pkg2/" +

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