langtools/test/com/sun/javadoc/testExternalOverridenMethod/TestExternalOverridenMethod.java
author bpatel
Fri, 18 Oct 2013 16:34:42 -0700
changeset 21478 fa4c7cda1b41
parent 21008 af0b915df7cc
child 23971 f5ff1f5a8dee
permissions -rw-r--r--
8026567: Use meaningful style names for strong and italic styles. Reviewed-by: jjg
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
19253
b97b3e18547f 7198274: RFE : Javadoc Accessibility : Use CSS styles rather than <strong> or <i> tags
bpatel
parents: 7681
diff changeset
     2
 * Copyright (c) 2003, 2013, 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: 2216
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 2216
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 2216
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
21478
fa4c7cda1b41 8026567: Use meaningful style names for strong and italic styles.
bpatel
parents: 21008
diff changeset
    26
 * @bug 4857717 8025633 8026567
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
 * @summary Test to make sure that externally overriden and implemented methods
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
 * are documented properly.  The method should still include "implements" or
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
 * "overrides" documentation even though the method is external.
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
 * @author jamieh
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
 * @library ../lib/
21008
af0b915df7cc 8025633: Fix javadoc to generate valid anchor names
bpatel
parents: 19253
diff changeset
    32
 * @build JavadocTester TestExternalOverridenMethod
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
 * @run main TestExternalOverridenMethod
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
public class TestExternalOverridenMethod extends JavadocTester {
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
    private static final String BUG_ID = "4857717";
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
    private static final String[][] TEST = {
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
        {BUG_ID + FS + "pkg" + FS + "XReader.html",
21478
fa4c7cda1b41 8026567: Use meaningful style names for strong and italic styles.
bpatel
parents: 21008
diff changeset
    41
            "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>" + NL +
21008
af0b915df7cc 8025633: Fix javadoc to generate valid anchor names
bpatel
parents: 19253
diff changeset
    42
            "<dd><code><a href=\"http://java.sun.com/j2se/1.4.1/docs/api/java/io/FilterReader.html?is-external=true#read--\" " +
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    43
            "title=\"class or interface in java.io\">read</a></code>&nbsp;in class&nbsp;<code>" +
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    44
            "<a href=\"http://java.sun.com/j2se/1.4.1/docs/api/java/io/FilterReader.html?is-external=true\" " +
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    45
            "title=\"class or interface in java.io\">FilterReader</a></code></dd>"},
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
        {BUG_ID + FS + "pkg" + FS + "XReader.html",
21478
fa4c7cda1b41 8026567: Use meaningful style names for strong and italic styles.
bpatel
parents: 21008
diff changeset
    47
            "<dt><span class=\"overrideSpecifyLabel\">Specified by:</span></dt>" + NL +
21008
af0b915df7cc 8025633: Fix javadoc to generate valid anchor names
bpatel
parents: 19253
diff changeset
    48
            "<dd><code><a href=\"http://java.sun.com/j2se/1.4.1/docs/api/java/io/DataInput.html?is-external=true#readInt--\" " +
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    49
            "title=\"class or interface in java.io\">readInt</a></code>&nbsp;in interface&nbsp;<code>" +
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    50
            "<a href=\"http://java.sun.com/j2se/1.4.1/docs/api/java/io/DataInput.html?is-external=true\" " +
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    51
            "title=\"class or interface in java.io\">DataInput</a></code></dd>"}};
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
    private static final String[][] NEGATED_TEST = NO_TEST;
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
06bc494ca11e Initial load
duke
parents:
diff changeset
    57
    private static final String[] ARGS =
06bc494ca11e Initial load
duke
parents:
diff changeset
    58
        new String[] {
06bc494ca11e Initial load
duke
parents:
diff changeset
    59
            "-d", BUG_ID, "-sourcepath", SRC_DIR,
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
            "-linkoffline", "http://java.sun.com/j2se/1.4.1/docs/api", SRC_DIR,
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
            "pkg"
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
        };
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
     * The entry point of the test.
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
     * @param args the array of command line arguments.
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
    public static void main(String[] args) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
        TestExternalOverridenMethod tester = new TestExternalOverridenMethod();
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
        run(tester, ARGS, TEST, NEGATED_TEST);
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
        tester.printSummary();
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
    public String getBugId() {
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
        return BUG_ID;
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    80
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    82
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
    83
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    84
    public String getBugName() {
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
        return getClass().getName();
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    87
}