langtools/test/com/sun/javadoc/testTypeParams/TestTypeParameters.java
author jjg
Tue, 22 Apr 2014 17:41:11 -0700
changeset 24071 b0845717434e
parent 24065 fc4022e50129
child 24072 e7549dcbc4af
permissions -rw-r--r--
8041253: Avoid redundant synonyms of NO_TEST Reviewed-by: ksrini
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 23139
diff changeset
     2
 * Copyright (c) 2003, 2014, Oracle and/or its affiliates. All rights reserved.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06bc494ca11e Initial load
duke
parents:
diff changeset
     4
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
06bc494ca11e Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
06bc494ca11e Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.
06bc494ca11e Initial load
duke
parents:
diff changeset
     8
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load
duke
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load
duke
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
06bc494ca11e Initial load
duke
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load
duke
parents:
diff changeset
    13
 * accompanied this code).
06bc494ca11e Initial load
duke
parents:
diff changeset
    14
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load
duke
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load
duke
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load
duke
parents:
diff changeset
    18
 *
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    21
 * questions.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    22
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    23
06bc494ca11e Initial load
duke
parents:
diff changeset
    24
/*
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
 * @test
21008
af0b915df7cc 8025633: Fix javadoc to generate valid anchor names
bpatel
parents: 17564
diff changeset
    26
 * @bug      4927167 4974929 7010344 8025633
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
 * @summary  When the type parameters are more than 10 characters in length,
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
 *           make sure there is a line break between type params and return type
9083
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    29
 *           in member summary. Also, test for type parameter links in package-summary and
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    30
 *           class-use pages. The class/annotation pages should check for type
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    31
 *           parameter links in the class/annotation signature section when -linksource is set.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
 * @author   jamieh
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
 * @library  ../lib/
9083
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    34
 * @build    JavadocTester TestTypeParameters
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
 * @run main TestTypeParameters
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
public class TestTypeParameters extends JavadocTester {
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
    //Test information.
9083
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    41
    private static final String BUG_ID = "4927167-4974929-7010344";
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
    //Javadoc arguments.
9083
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    44
    private static final String[] ARGS1 = new String[]{
23139
612191246a7d 8031670: Remove unneeded -source options in javadoc tests
darcy
parents: 21008
diff changeset
    45
        "-d", BUG_ID, "-use", "-sourcepath", SRC_DIR,
9083
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    46
        "pkg"
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    47
    };
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    48
    private static final String[] ARGS2 = new String[]{
23139
612191246a7d 8031670: Remove unneeded -source options in javadoc tests
darcy
parents: 21008
diff changeset
    49
        "-d", BUG_ID, "-linksource", "-sourcepath", SRC_DIR,
9083
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    50
        "pkg"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
    //Input for string search tests.
9083
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    54
    private static final String[][] TEST1 = {
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 23139
diff changeset
    55
        {BUG_ID + "/pkg/C.html",
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    56
            "<td class=\"colFirst\"><code>&lt;W extends java.lang.String,V extends " +
17564
c329fe11193d 8011288: Erratic/inconsistent indentation of signatures
jjg
parents: 9083
diff changeset
    57
            "java.util.List&gt;<br>java.lang.Object</code></td>"
9083
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    58
        },
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 23139
diff changeset
    59
        {BUG_ID + "/pkg/C.html",
9083
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    60
            "<code>&lt;T&gt;&nbsp;java.lang.Object</code>"
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    61
        },
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 23139
diff changeset
    62
        {BUG_ID + "/pkg/package-summary.html",
9083
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    63
            "C</a>&lt;E extends <a href=\"../pkg/Parent.html\" " +
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    64
            "title=\"class in pkg\">Parent</a>&gt;"
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    65
        },
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 23139
diff changeset
    66
        {BUG_ID + "/pkg/class-use/Foo4.html",
9083
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    67
            "<a href=\"../../pkg/ClassUseTest3.html\" title=\"class in pkg\">" +
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    68
            "ClassUseTest3</a>&lt;T extends <a href=\"../../pkg/ParamTest2.html\" " +
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    69
            "title=\"class in pkg\">ParamTest2</a>&lt;java.util.List&lt;? extends " +
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    70
            "<a href=\"../../pkg/Foo4.html\" title=\"class in pkg\">Foo4</a>&gt;&gt;&gt;"
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    71
        },
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
        //Nested type parameters
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 23139
diff changeset
    73
        {BUG_ID + "/pkg/C.html",
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 23139
diff changeset
    74
            "<a name=\"formatDetails-java.util.Collection-java.util.Collection-\">\n" +
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 23139
diff changeset
    75
            "<!--   -->\n" +
9083
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    76
            "</a>"
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    77
        },
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    78
    };
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    79
    private static final String[][] TEST2 = {
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 23139
diff changeset
    80
        {BUG_ID + "/pkg/ClassUseTest3.html",
9083
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    81
            "public class <a href=\"../src-html/pkg/ClassUseTest3.html#line.28\">" +
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    82
            "ClassUseTest3</a>&lt;T extends <a href=\"../pkg/ParamTest2.html\" " +
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    83
            "title=\"class in pkg\">ParamTest2</a>&lt;java.util.List&lt;? extends " +
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    84
            "<a href=\"../pkg/Foo4.html\" title=\"class in pkg\">Foo4</a>&gt;&gt;&gt;"
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    85
        }
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    87
06bc494ca11e Initial load
duke
parents:
diff changeset
    88
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    89
     * The entry point of the test.
06bc494ca11e Initial load
duke
parents:
diff changeset
    90
     * @param args the array of command line arguments.
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
    public static void main(String[] args) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    93
        TestTypeParameters tester = new TestTypeParameters();
24071
b0845717434e 8041253: Avoid redundant synonyms of NO_TEST
jjg
parents: 24065
diff changeset
    94
        tester.run(ARGS1, TEST1, NO_TEST);
b0845717434e 8041253: Avoid redundant synonyms of NO_TEST
jjg
parents: 24065
diff changeset
    95
        tester.run(ARGS2, TEST2, NO_TEST);
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    96
        tester.printSummary();
06bc494ca11e Initial load
duke
parents:
diff changeset
    97
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    98
06bc494ca11e Initial load
duke
parents:
diff changeset
    99
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   100
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   101
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   102
    public String getBugId() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   103
        return BUG_ID;
06bc494ca11e Initial load
duke
parents:
diff changeset
   104
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   105
06bc494ca11e Initial load
duke
parents:
diff changeset
   106
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   107
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   108
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   109
    public String getBugName() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   110
        return getClass().getName();
06bc494ca11e Initial load
duke
parents:
diff changeset
   111
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   112
}