langtools/test/com/sun/javadoc/testDocRootLink/TestDocRootLink.java
author jjg
Mon, 25 Nov 2013 17:42:28 -0800
changeset 21894 3535c1819067
parent 9608 385a828ba236
child 22005 4270ada5dcd1
permissions -rw-r--r--
8028318: [doclint] doclint will reject existing user-written doc comments using custom tags that follow the recommended rules Reviewed-by: darcy

/*
 * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

/*
 * @test
 * @bug 6553182
 * @summary This test verifies the -Xdocrootparent option.
 * @author Bhavesh Patel
 * @library ../lib/
 * @build JavadocTester TestDocRootLink
 * @run main TestDocRootLink
 */
public class TestDocRootLink extends JavadocTester {

    private static final String BUG_ID = "6553182";
    private static final String[][] TEST1 = {
        {BUG_ID + FS + "pkg1" + FS + "C1.html",
            "<a href=\"../../technotes/guides/index.html\">"
        },
        {BUG_ID + FS + "pkg1" + FS + "package-summary.html",
            "<a href=\"../../technotes/guides/index.html\">"
        }
    };
    private static final String[][] NEGATED_TEST1 = {
        {BUG_ID + FS + "pkg1" + FS + "C1.html",
            "<a href=\"http://download.oracle.com/javase/7/docs/technotes/guides/index.html\">"
        },
        {BUG_ID + FS + "pkg1" + FS + "package-summary.html",
            "<a href=\"http://download.oracle.com/javase/7/docs/technotes/guides/index.html\">"
        }
    };
    private static final String[][] TEST2 = {
        {BUG_ID + FS + "pkg2" + FS + "C2.html",
            "<a href=\"http://download.oracle.com/javase/7/docs/technotes/guides/index.html\">"
        },
        {BUG_ID + FS + "pkg2" + FS + "package-summary.html",
            "<a href=\"http://download.oracle.com/javase/7/docs/technotes/guides/index.html\">"
        }
    };
    private static final String[][] NEGATED_TEST2 = {
        {BUG_ID + FS + "pkg2" + FS + "C2.html",
            "<a href=\"../../technotes/guides/index.html\">"
        },
        {BUG_ID + FS + "pkg2" + FS + "package-summary.html",
            "<a href=\"../../technotes/guides/index.html\">"
        }
    };
    private static final String[] ARGS1 =
            new String[]{
        "-d", BUG_ID, "-sourcepath", SRC_DIR, "pkg1"
    };
    private static final String[] ARGS2 =
            new String[]{
        "-d", BUG_ID, "-Xdocrootparent", "http://download.oracle.com/javase/7/docs", "-sourcepath", SRC_DIR, "pkg2"
    };

    /**
     * The entry point of the test.
     * @param args the array of command line arguments.
     */
    public static void main(String[] args) {
        TestDocRootLink tester = new TestDocRootLink();
        run(tester, ARGS1, TEST1, NEGATED_TEST1);
        run(tester, ARGS2, TEST2, NEGATED_TEST2);
        tester.printSummary();
    }

    /**
     * {@inheritDoc}
     */
    public String getBugId() {
        return BUG_ID;
    }

    /**
     * {@inheritDoc}
     */
    public String getBugName() {
        return getClass().getName();
    }
}