/*

 * Copyright (c) 2002, 2015, 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 4634891 8026567

 * @summary Determine if overriden methods are properly documented when

 * -protected (default) visibility flag is used.

 * @author jamieh

 * @library ../lib

 * @modules jdk.javadoc

 * @build JavadocTester

 * @run main TestOverridenPrivateMethods

 */

public class TestOverridenPrivateMethods extends JavadocTester {

    public static void main(String... args) throws Exception {

        TestOverridenPrivateMethods tester = new TestOverridenPrivateMethods();

        tester.runTests();

    }

    @Test

    void test() {

        javadoc("-d", "out",

                "-sourcepath", testSrc,

                "pkg1", "pkg2");

        checkExit(Exit.OK);

        // The public method should be overridden

        checkOutput("pkg1/SubClass.html", true,

                "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"

                + "<dd><code><a href=\"../pkg1/BaseClass.html#publicMethod");

        // The public method in different package should be overridden

        checkOutput("pkg2/SubClass.html", true,

                "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"

                + "<dd><code><a href=\"../pkg1/BaseClass.html#publicMethod");

        checkOutput("pkg1/SubClass.html", false,

                //The package private method should be overridden since the base and sub class are in the same

                //package.  However, the link should not show up because the package private methods are not documented.

                "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"

                + "<dd><code><a href=\"../pkg1/BaseClass.html#packagePrivateMethod",

                //The private method in should not be overridden

                "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"

                + "<dd><code><a href=\"../pkg1/BaseClass.html#privateMethod");

        checkOutput("pkg2/SubClass.html", false,

                //The private method in different package should not be overridden

                "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"

                + "<dd><code><a href=\"../pkg1/BaseClass.html#privateMethod",

                //The package private method should not be overridden since the base and sub class are in

                //different packages.

                "Overrides:</span></dt><dd><code><a href=\"../pkg1/BaseClass.html#packagePrivateMethod");

    }

}