test/com/sun/javadoc/testInterface/TestInterface.java

Sat, 01 Dec 2007 00:00:00 +0000

author
duke
date
Sat, 01 Dec 2007 00:00:00 +0000
changeset 1
9a66ca7c79fa
child 182
47a62d8d98b4
permissions
-rw-r--r--

Initial load

duke@1 1 /*
duke@1 2 * Copyright 2003-2004 Sun Microsystems, Inc. All Rights Reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
duke@1 7 * published by the Free Software Foundation.
duke@1 8 *
duke@1 9 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 12 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 13 * accompanied this code).
duke@1 14 *
duke@1 15 * You should have received a copy of the GNU General Public License version
duke@1 16 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 18 *
duke@1 19 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1 20 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1 21 * have any questions.
duke@1 22 */
duke@1 23
duke@1 24 /*
duke@1 25 * @test
duke@1 26 * @bug 4682448 4947464 5029946
duke@1 27 * @summary Verify that the public modifier does not show up in the
duke@1 28 * documentation for public methods, as recommended by the JLS.
duke@1 29 * If A implements I and B extends A, B should be in the list of
duke@1 30 * implementing classes in the documentation for I.
duke@1 31 * @author jamieh
duke@1 32 * @library ../lib/
duke@1 33 * @build JavadocTester
duke@1 34 * @build TestInterface
duke@1 35 * @run main TestInterface
duke@1 36 */
duke@1 37
duke@1 38 public class TestInterface extends JavadocTester {
duke@1 39
duke@1 40 //Test information.
duke@1 41 private static final String BUG_ID = "4682448-4947464-5029946";
duke@1 42
duke@1 43 //Javadoc arguments.
duke@1 44 private static final String[] ARGS = new String[] {
duke@1 45 "-source", "1.5", "-d", BUG_ID, "-sourcepath", SRC_DIR, "pkg"
duke@1 46 };
duke@1 47
duke@1 48 //Input for string search tests.
duke@1 49 private static final String[][] TEST = {
duke@1 50 {BUG_ID + FS + "pkg" + FS + "Interface.html",
duke@1 51 "int <B>method</B>()"},
duke@1 52 {BUG_ID + FS + "pkg" + FS + "Interface.html",
duke@1 53 "static final int <B>field</B>"},
duke@1 54
duke@1 55
duke@1 56 // Make sure known implementing class list is correct and omits type parameters.
duke@1 57 {BUG_ID + FS + "pkg" + FS + "Interface.html",
duke@1 58 "<DT><B>All Known Implementing Classes:</B> " +
duke@1 59 "<DD><A HREF=\"../pkg/Child.html\" " +
duke@1 60 "title=\"class in pkg\">Child</A>, " +
duke@1 61 "<A HREF=\"../pkg/Parent.html\" title=\"class in pkg\">" +
duke@1 62 "Parent</A></DD>"},
duke@1 63
duke@1 64 // Make sure "All Implemented Interfaces": has substituted type parameters
duke@1 65 {BUG_ID + FS + "pkg" + FS + "Child.html",
duke@1 66 "<B>All Implemented Interfaces:</B> <DD><A HREF=\"../pkg/Interface.html\" title=\"interface in pkg\">Interface</A>&lt;T&gt;"
duke@1 67 },
duke@1 68 //Make sure Class Tree has substituted type parameters.
duke@1 69 {BUG_ID + FS + "pkg" + FS + "Child.html",
duke@1 70 "<PRE>" + NL +
duke@1 71 "java.lang.Object" + NL +
duke@1 72 " <IMG SRC=\"../resources/inherit.gif\" ALT=\"extended by \"><A HREF=\"../pkg/Parent.html\" title=\"class in pkg\">pkg.Parent</A>&lt;T&gt;" + NL +
duke@1 73 " <IMG SRC=\"../resources/inherit.gif\" ALT=\"extended by \"><B>pkg.Child&lt;T&gt;</B>" + NL +
duke@1 74 "</PRE>"
duke@1 75 },
duke@1 76 //Make sure "Direct Know Subclasses" omits type parameters
duke@1 77 {BUG_ID + FS + "pkg" + FS + "Parent.html",
duke@1 78 "<B>Direct Known Subclasses:</B> <DD><A HREF=\"../pkg/Child.html\" title=\"class in pkg\">Child</A>"
duke@1 79 },
duke@1 80 //Make sure "Specified By" has substituted type parameters.
duke@1 81 {BUG_ID + FS + "pkg" + FS + "Child.html",
duke@1 82 "<B>Specified by:</B><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>"
duke@1 83 },
duke@1 84 //Make sure "Overrides" has substituted type parameters.
duke@1 85 {BUG_ID + FS + "pkg" + FS + "Child.html",
duke@1 86 "<B>Overrides:</B><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>"
duke@1 87 },
duke@1 88 };
duke@1 89 private static final String[][] NEGATED_TEST = {
duke@1 90 {BUG_ID + FS + "pkg" + FS + "Interface.html",
duke@1 91 "public int <B>method</B>()"},
duke@1 92 {BUG_ID + FS + "pkg" + FS + "Interface.html",
duke@1 93 "public static final int <B>field</B>"},
duke@1 94 };
duke@1 95
duke@1 96 /**
duke@1 97 * The entry point of the test.
duke@1 98 * @param args the array of command line arguments.
duke@1 99 */
duke@1 100 public static void main(String[] args) {
duke@1 101 TestInterface tester = new TestInterface();
duke@1 102 run(tester, ARGS, TEST, NEGATED_TEST);
duke@1 103 tester.printSummary();
duke@1 104 }
duke@1 105
duke@1 106 /**
duke@1 107 * {@inheritDoc}
duke@1 108 */
duke@1 109 public String getBugId() {
duke@1 110 return BUG_ID;
duke@1 111 }
duke@1 112
duke@1 113 /**
duke@1 114 * {@inheritDoc}
duke@1 115 */
duke@1 116 public String getBugName() {
duke@1 117 return getClass().getName();
duke@1 118 }
duke@1 119 }

mercurial