langtools/test/com/sun/javadoc/testLinkOption/TestLinkOption.java
author jjg
Wed, 16 Apr 2014 16:17:09 -0700
changeset 23971 f5ff1f5a8dee
parent 21478 fa4c7cda1b41
child 23974 d53628eda3d1
permissions -rw-r--r--
8031649: Clean up javadoc tests Reviewed-by: jjg Contributed-by: neil.toda@oracle.com
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: 21478
diff changeset
     2
 * Copyright (c) 2002, 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: 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: 9083
diff changeset
    26
 * @bug 4720957 5020118 8026567
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
 * @summary Test to make sure that -link and -linkoffline link to
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
 * right files.
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
 * @author jamieh
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
 * @library ../lib/
9083
63f3c4d2d992 7010344: Some of the html files do not have element <a> in right context.
bpatel
parents: 7681
diff changeset
    31
 * @build JavadocTester TestLinkOption
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
 * @run main TestLinkOption
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
public class TestLinkOption extends JavadocTester {
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
    private static final String BUG_ID = "4720957-5020118";
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
    //Generate the documentation using -linkoffline and a URL as the first parameter.
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
    private static final String[] ARGS1 = new String[] {
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
        "-d", BUG_ID + "-1", "-sourcepath", SRC_DIR,
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
        "-linkoffline", "http://java.sun.com/j2se/1.4/docs/api/",
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
        SRC_DIR, "-package", "pkg", "java.lang"
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    45
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
    private static final String[][] TEST1 = {
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    47
        {BUG_ID + "-1/pkg/C.html",
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    48
            "<a href=\"http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html?is-external=true\" " +
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.lang\"><code>Link to String Class</code></a>"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
        },
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
        //Make sure the parameters are indented properly when the -link option is used.
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    52
        {BUG_ID + "-1/pkg/C.html",
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    53
            "(int&nbsp;p1,\n" +
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    54
            "      int&nbsp;p2,\n" +
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    55
            "      int&nbsp;p3)"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
        },
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    57
        {BUG_ID + "-1/pkg/C.html",
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    58
            "(int&nbsp;p1,\n" +
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    59
            "      int&nbsp;p2,\n" +
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    60
            "      <a href=\"http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html?is-external=true\" title=\"class or interface in java.lang\">" +
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    61
            "Object</a>&nbsp;p3)"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
        },
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    63
        {BUG_ID + "-1/java/lang/StringBuilderChild.html",
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    64
            "<pre>public abstract class <span class=\"typeNameLabel\">StringBuilderChild</span>\n" +
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    65
                "extends <a href=\"http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html?is-external=true\" " +
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    66
            "title=\"class or interface in java.lang\">Object</a></pre>"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
        },
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
    private static final String[][] NEGATED_TEST1 = NO_TEST;
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
    //Generate the documentation using -linkoffline and a relative path as the first parameter.
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
    //We will try linking to the docs generated in test 1 with a relative path.
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
    private static final String[] ARGS2 = new String[] {
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
        "-d", BUG_ID + "-2", "-sourcepath", SRC_DIR,
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    76
        "-linkoffline", "../" + BUG_ID + "-1",
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    77
        BUG_ID + "-1", "-package", "pkg2"
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
06bc494ca11e Initial load
duke
parents:
diff changeset
    80
    private static final String[][] TEST2 = {
23971
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    81
        {BUG_ID + "-2/pkg2/C2.html",
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    82
            "This is a link to <a href=\"../../" + BUG_ID +
f5ff1f5a8dee 8031649: Clean up javadoc tests
jjg
parents: 21478
diff changeset
    83
            "-1/pkg/C.html?is-external=true\" " +
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    84
            "title=\"class or interface in pkg\"><code>Class C</code></a>."
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
        }
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    87
    private static final String[][] NEGATED_TEST2 = NO_TEST;
06bc494ca11e Initial load
duke
parents:
diff changeset
    88
06bc494ca11e Initial load
duke
parents:
diff changeset
    89
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    90
     * The entry point of the test.
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
     * @param args the array of command line arguments.
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    93
    public static void main(String[] args) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    94
        TestLinkOption tester = new TestLinkOption();
06bc494ca11e Initial load
duke
parents:
diff changeset
    95
        run(tester, ARGS1, TEST1, NEGATED_TEST1);
06bc494ca11e Initial load
duke
parents:
diff changeset
    96
        run(tester, ARGS2, TEST2, NEGATED_TEST2);
06bc494ca11e Initial load
duke
parents:
diff changeset
    97
        tester.printSummary();
06bc494ca11e Initial load
duke
parents:
diff changeset
    98
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    99
06bc494ca11e Initial load
duke
parents:
diff changeset
   100
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   101
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   102
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   103
    public String getBugId() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   104
        return BUG_ID;
06bc494ca11e Initial load
duke
parents:
diff changeset
   105
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   106
06bc494ca11e Initial load
duke
parents:
diff changeset
   107
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   108
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   109
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   110
    public String getBugName() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   111
        return getClass().getName();
06bc494ca11e Initial load
duke
parents:
diff changeset
   112
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   113
}