langtools/test/com/sun/javadoc/testInterface/TestInterface.java
author ohair
Tue, 25 May 2010 15:54:51 -0700
changeset 5520 86e4b9a9da40
parent 2985 f43e1241e7fb
child 7614 cfadc977ca75
permissions -rw-r--r--
6943119: Rebrand source copyright notices Reviewed-by: darcy
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 2985
diff changeset
     2
 * Copyright (c) 2003, 2004, 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: 2985
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 2985
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 2985
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
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
 * @bug      4682448 4947464 5029946
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
 * @summary  Verify that the public modifier does not show up in the
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
 *           documentation for public methods, as recommended by the JLS.
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
 *           If A implements I and B extends A, B should be in the list of
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
 *           implementing classes in the documentation for I.
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
 * @author   jamieh
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
 * @library  ../lib/
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
 * @build    JavadocTester
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
 * @build    TestInterface
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
 * @run main TestInterface
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 TestInterface extends JavadocTester {
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
    //Test information.
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
    private static final String BUG_ID = "4682448-4947464-5029946";
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
    //Javadoc arguments.
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
    private static final String[] ARGS = new String[] {
2985
f43e1241e7fb 6843761: Update langtools tests to remove unncessary -source and -target options
darcy
parents: 2216
diff changeset
    45
        "-d", BUG_ID, "-sourcepath", SRC_DIR, "pkg"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
    //Input for string search tests.
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
    private static final String[][] TEST = {
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
        {BUG_ID + FS + "pkg" + FS + "Interface.html",
1787
1aa079321cd2 6786028: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Bold tags should be strong
bpatel
parents: 10
diff changeset
    51
            "int <STRONG>method</STRONG>()"},
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
        {BUG_ID + FS + "pkg" + FS + "Interface.html",
1787
1aa079321cd2 6786028: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Bold tags should be strong
bpatel
parents: 10
diff changeset
    53
            "static final int <STRONG>field</STRONG>"},
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
        // Make sure known implementing class list is correct and omits type parameters.
06bc494ca11e Initial load
duke
parents:
diff changeset
    57
        {BUG_ID + FS + "pkg" + FS + "Interface.html",
2216
b124d5c924eb 6786690: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - DL tag and nesting issue
bpatel
parents: 1787
diff changeset
    58
            "<DT><STRONG>All Known Implementing Classes:</STRONG></DT> " +
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    59
            "<DD><A HREF=\"../pkg/Child.html\" " +
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
            "title=\"class in pkg\">Child</A>, " +
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
            "<A HREF=\"../pkg/Parent.html\" title=\"class in pkg\">" +
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
            "Parent</A></DD>"},
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
         // Make sure "All Implemented Interfaces": has substituted type parameters
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
         {BUG_ID + FS + "pkg" + FS + "Child.html",
2216
b124d5c924eb 6786690: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - DL tag and nesting issue
bpatel
parents: 1787
diff changeset
    66
            "<STRONG>All Implemented Interfaces:</STRONG></DT> <DD>" +
b124d5c924eb 6786690: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - DL tag and nesting issue
bpatel
parents: 1787
diff changeset
    67
            "<A HREF=\"../pkg/Interface.html\" title=\"interface in pkg\">" +
b124d5c924eb 6786690: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - DL tag and nesting issue
bpatel
parents: 1787
diff changeset
    68
            "Interface</A>&lt;T&gt;"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
         },
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
         //Make sure Class Tree has substituted type parameters.
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
         {BUG_ID + FS + "pkg" + FS + "Child.html",
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
            "<PRE>" + NL +
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
            "java.lang.Object" + NL +
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
            "  <IMG SRC=\"../resources/inherit.gif\" ALT=\"extended by \"><A HREF=\"../pkg/Parent.html\" title=\"class in pkg\">pkg.Parent</A>&lt;T&gt;" + NL +
1787
1aa079321cd2 6786028: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Bold tags should be strong
bpatel
parents: 10
diff changeset
    75
            "      <IMG SRC=\"../resources/inherit.gif\" ALT=\"extended by \"><STRONG>pkg.Child&lt;T&gt;</STRONG>" + NL +
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
            "</PRE>"
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
         },
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
         //Make sure "Direct Know Subclasses" omits type parameters
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
        {BUG_ID + FS + "pkg" + FS + "Parent.html",
2216
b124d5c924eb 6786690: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - DL tag and nesting issue
bpatel
parents: 1787
diff changeset
    80
            "<STRONG>Direct Known Subclasses:</STRONG></DT> <DD><A HREF=\"../pkg/Child.html\" title=\"class in pkg\">Child</A>"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
        },
06bc494ca11e Initial load
duke
parents:
diff changeset
    82
        //Make sure "Specified By" has substituted type parameters.
06bc494ca11e Initial load
duke
parents:
diff changeset
    83
        {BUG_ID + FS + "pkg" + FS + "Child.html",
2216
b124d5c924eb 6786690: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - DL tag and nesting issue
bpatel
parents: 1787
diff changeset
    84
            "<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>"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
         },
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
        //Make sure "Overrides" has substituted type parameters.
06bc494ca11e Initial load
duke
parents:
diff changeset
    87
        {BUG_ID + FS + "pkg" + FS + "Child.html",
2216
b124d5c924eb 6786690: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - DL tag and nesting issue
bpatel
parents: 1787
diff changeset
    88
            "<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>"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    89
         },
06bc494ca11e Initial load
duke
parents:
diff changeset
    90
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
    private static final String[][] NEGATED_TEST = {
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
        {BUG_ID + FS + "pkg" + FS + "Interface.html",
1787
1aa079321cd2 6786028: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Bold tags should be strong
bpatel
parents: 10
diff changeset
    93
            "public int <STRONG>method</STRONG>()"},
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    94
        {BUG_ID + FS + "pkg" + FS + "Interface.html",
1787
1aa079321cd2 6786028: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Bold tags should be strong
bpatel
parents: 10
diff changeset
    95
            "public static final int <STRONG>field</STRONG>"},
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    96
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    97
06bc494ca11e Initial load
duke
parents:
diff changeset
    98
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    99
     * The entry point of the test.
06bc494ca11e Initial load
duke
parents:
diff changeset
   100
     * @param args the array of command line arguments.
06bc494ca11e Initial load
duke
parents:
diff changeset
   101
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   102
    public static void main(String[] args) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   103
        TestInterface tester = new TestInterface();
06bc494ca11e Initial load
duke
parents:
diff changeset
   104
        run(tester, ARGS, TEST, NEGATED_TEST);
06bc494ca11e Initial load
duke
parents:
diff changeset
   105
        tester.printSummary();
06bc494ca11e Initial load
duke
parents:
diff changeset
   106
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   107
06bc494ca11e Initial load
duke
parents:
diff changeset
   108
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   109
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   110
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   111
    public String getBugId() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   112
        return BUG_ID;
06bc494ca11e Initial load
duke
parents:
diff changeset
   113
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   114
06bc494ca11e Initial load
duke
parents:
diff changeset
   115
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   116
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   117
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   118
    public String getBugName() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   119
        return getClass().getName();
06bc494ca11e Initial load
duke
parents:
diff changeset
   120
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   121
}