test/com/sun/javadoc/testExternalOverridenMethod/TestExternalOverridenMethod.java

Tue, 28 Dec 2010 15:54:52 -0800

author
ohair
date
Tue, 28 Dec 2010 15:54:52 -0800
changeset 798
4868a36f6fd8
parent 766
90af8d87741f
child 1935
8c55df2442c1
permissions
-rw-r--r--

6962318: Update copyright year
Reviewed-by: xdono

     1 /*
     2  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     4  *
     5  * This code is free software; you can redistribute it and/or modify it
     6  * under the terms of the GNU General Public License version 2 only, as
     7  * published by the Free Software Foundation.
     8  *
     9  * This code is distributed in the hope that it will be useful, but WITHOUT
    10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    12  * version 2 for more details (a copy is included in the LICENSE file that
    13  * accompanied this code).
    14  *
    15  * You should have received a copy of the GNU General Public License version
    16  * 2 along with this work; if not, write to the Free Software Foundation,
    17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    18  *
    19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    20  * or visit www.oracle.com if you need additional information or have any
    21  * questions.
    22  */
    24 /*
    25  * @test
    26  * @bug 4857717
    27  * @summary Test to make sure that externally overriden and implemented methods
    28  * are documented properly.  The method should still include "implements" or
    29  * "overrides" documentation even though the method is external.
    30  * @author jamieh
    31  * @library ../lib/
    32  * @build JavadocTester
    33  * @build TestExternalOverridenMethod
    34  * @run main TestExternalOverridenMethod
    35  */
    37 public class TestExternalOverridenMethod extends JavadocTester {
    39     private static final String BUG_ID = "4857717";
    40     private static final String[][] TEST = {
    41         {BUG_ID + FS + "pkg" + FS + "XReader.html",
    42             "<dt><strong>Overrides:</strong></dt>" + NL +
    43             "<dd><code><a href=\"http://java.sun.com/j2se/1.4.1/docs/api/java/io/FilterReader.html?is-external=true#read()\" " +
    44             "title=\"class or interface in java.io\">read</a></code>&nbsp;in class&nbsp;<code>" +
    45             "<a href=\"http://java.sun.com/j2se/1.4.1/docs/api/java/io/FilterReader.html?is-external=true\" " +
    46             "title=\"class or interface in java.io\">FilterReader</a></code></dd>"},
    47         {BUG_ID + FS + "pkg" + FS + "XReader.html",
    48             "<dt><strong>Specified by:</strong></dt>" + NL +
    49             "<dd><code><a href=\"http://java.sun.com/j2se/1.4.1/docs/api/java/io/DataInput.html?is-external=true#readInt()\" " +
    50             "title=\"class or interface in java.io\">readInt</a></code>&nbsp;in interface&nbsp;<code>" +
    51             "<a href=\"http://java.sun.com/j2se/1.4.1/docs/api/java/io/DataInput.html?is-external=true\" " +
    52             "title=\"class or interface in java.io\">DataInput</a></code></dd>"}};
    56     private static final String[][] NEGATED_TEST = NO_TEST;
    58     private static final String[] ARGS =
    59         new String[] {
    60             "-d", BUG_ID, "-sourcepath", SRC_DIR,
    61             "-linkoffline", "http://java.sun.com/j2se/1.4.1/docs/api", SRC_DIR,
    62             "pkg"
    63         };
    65     /**
    66      * The entry point of the test.
    67      * @param args the array of command line arguments.
    68      */
    69     public static void main(String[] args) {
    70         TestExternalOverridenMethod tester = new TestExternalOverridenMethod();
    71         run(tester, ARGS, TEST, NEGATED_TEST);
    72         tester.printSummary();
    73     }
    75     /**
    76      * {@inheritDoc}
    77      */
    78     public String getBugId() {
    79         return BUG_ID;
    80     }
    82     /**
    83      * {@inheritDoc}
    84      */
    85     public String getBugName() {
    86         return getClass().getName();
    87     }
    88 }

mercurial