duke@1: /*
duke@1:  * Copyright 2003-2004 Sun Microsystems, Inc.  All Rights Reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
duke@1:  * published by the Free Software Foundation.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
duke@1:  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1:  * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1:  * have any questions.
duke@1:  */
duke@1: 
duke@1: /*
duke@1:  * @test
duke@1:  * @bug      4780441 4874845 4978816
duke@1:  * @summary  Make sure that when the -private flag is not used, members
duke@1:  *           inherited from package private class are documented in the child.
duke@1:  *
duke@1:  *           Make sure that when a method inherits documentation from a method
duke@1:  *           in a non-public class/interface, the non-public class/interface
duke@1:  *           is not mentioned anywhere (not even in the signature or tree).
duke@1:  *
duke@1:  *           Make sure that when a private interface method with generic parameters
duke@1:  *           is implemented, the comments can be inherited properly.
duke@1:  * @author   jamieh
duke@1:  * @library  ../lib/
duke@1:  * @build    JavadocTester
duke@1:  * @build    TestPrivateClasses
duke@1:  * @run main TestPrivateClasses
duke@1:  */
duke@1: 
duke@1: public class TestPrivateClasses extends JavadocTester {
duke@1: 
duke@1:     //Test information.
duke@1:     private static final String BUG_ID = "4780441-4874845-4978816";
duke@1: 
duke@1:     //Javadoc arguments.
duke@1:     private static final String[] ARGS1 = new String[] {
duke@1:         "-d", BUG_ID + "-1", "-sourcepath", SRC_DIR, "-source", "1.5", "pkg", "pkg2"
duke@1:     };
duke@1:     private static final String[] ARGS2 = new String[] {
duke@1:         "-d", BUG_ID + "-2", "-sourcepath", SRC_DIR, "-private",
duke@1:             "-source", "1.5", "pkg", "pkg2"
duke@1:     };
duke@1: 
duke@1:     // Test output when -private flag is not used.
duke@1:     private static final String[][] TEST1 = {
duke@1:         // Field inheritence from non-public superclass.
duke@1:         {BUG_ID + "-1" + FS + "pkg" + FS + "PublicChild.html",
duke@1:             "<A HREF=\"../pkg/PublicChild.html#fieldInheritedFromParent\">" +
duke@1:                 "fieldInheritedFromParent</A>"
duke@1:         },
duke@1: 
duke@1:         // Method inheritence from non-public superclass.
duke@1:         {BUG_ID + "-1" + FS + "pkg" + FS + "PublicChild.html",
duke@1:             "<A HREF=\"../pkg/PublicChild.html#methodInheritedFromParent(int)\">" +
duke@1:                 "methodInheritedFromParent</A>"
duke@1:         },
duke@1: 
duke@1:         // Field inheritence from non-public superinterface.
duke@1:         {BUG_ID + "-1" + FS + "pkg" + FS + "PublicInterface.html",
duke@1:             "<A HREF=\"../pkg/PublicInterface.html#fieldInheritedFromInterface\">" +
duke@1:                 "fieldInheritedFromInterface</A>"
duke@1:         },
duke@1: 
duke@1:         // Method inheritence from non-public superinterface.
duke@1:         {BUG_ID + "-1" + FS + "pkg" + FS + "PublicInterface.html",
duke@1:             "<A HREF=\"../pkg/PublicInterface.html#methodInterface(int)\">" +
duke@1:                 "methodInterface</A>"
duke@1:         },
duke@1: 
duke@1:         // private class does not show up in tree
duke@1:         {BUG_ID + "-1" + FS + "pkg" + FS + "PublicChild.html",
duke@1:             "<PRE>" + NL +
duke@1:                 "java.lang.Object" + NL +
duke@1:                 "  <IMG SRC=\"../resources/inherit.gif\" " +
bpatel@182:                 "ALT=\"extended by \"><STRONG>pkg.PublicChild</STRONG>" + NL +
duke@1:             "</PRE>"
duke@1:         },
duke@1: 
duke@1:         // Method is documented as though it is declared in the inheriting method.
duke@1:         {BUG_ID + "-1" + FS + "pkg" + FS + "PublicChild.html",
bpatel@182:             "public void <STRONG>methodInheritedFromParent</STRONG>(int&nbsp;p1)"
duke@1:         },
duke@1: 
duke@1:         //Make sure implemented interfaces from private superclass are inherited
duke@1:         {BUG_ID + "-1" + FS + "pkg" + FS + "PublicInterface.html",
bpatel@182:             "<STRONG>All Known Implementing Classes:</STRONG> <DD><A HREF=\"../pkg/PublicChild.html\" " +
duke@1:             "title=\"class in pkg\">PublicChild</A>"},
duke@1: 
duke@1:         {BUG_ID + "-1" + FS + "pkg" + FS + "PublicChild.html",
bpatel@182:             "<STRONG>All Implemented Interfaces:</STRONG> <DD><A HREF=\"../pkg/PublicInterface.html\" " +
duke@1:             "title=\"interface in pkg\">PublicInterface</A>"},
duke@1: 
duke@1:         //Generic interface method test.
duke@1:         {BUG_ID + "-1" + FS + "pkg2" + FS + "C.html",
duke@1:             "This comment should get copied to the implementing class"},
duke@1:     };
duke@1:     private static final String[][] NEGATED_TEST1 = {
duke@1:        // Should not document that a method overrides method from private class.
duke@1:       {BUG_ID + "-1" + FS + "pkg" + FS + "PublicChild.html",
bpatel@182:         "<STRONG>Overrides:</STRONG>"},
duke@1:       // Should not document that a method specified by private interface.
duke@1:       {BUG_ID + "-1" + FS + "pkg" + FS + "PublicChild.html",
bpatel@182:         "<STRONG>Specified by:</STRONG>"},
duke@1:       {BUG_ID + "-1" + FS + "pkg" + FS + "PublicInterface.html",
bpatel@182:         "<STRONG>Specified by:</STRONG>"},
duke@1:       // Should not mention that any documentation was copied.
duke@1:       {BUG_ID + "-1" + FS + "pkg" + FS + "PublicChild.html",
duke@1:         "Description copied from"},
duke@1:       {BUG_ID + "-1" + FS + "pkg" + FS + "PublicInterface.html",
duke@1:         "Description copied from"},
duke@1:       // Don't extend private classes or interfaces
duke@1:       {BUG_ID + "-1" + FS + "pkg" + FS + "PublicChild.html",
duke@1:         "PrivateParent"},
duke@1:       {BUG_ID + "-1" + FS + "pkg" + FS + "PublicInterface.html",
duke@1:         "PrivateInterface"},
duke@1:       {BUG_ID + "-1" + FS + "pkg" + FS + "PublicChild.html",
duke@1:         "PrivateInterface"},
duke@1:       {BUG_ID + "-1" + FS + "pkg" + FS + "PublicInterface.html",
duke@1:         "All Superinterfaces"},
duke@1:       // Make inherited constant are documented correctly.
duke@1:       {BUG_ID + "-1" + FS + "constant-values.html",
duke@1:         "PrivateInterface"},
duke@1: 
duke@1:         //Do not inherit private interface method with generic parameters.
duke@1:         //This method has been implemented.
duke@1:         {BUG_ID + "-1" + FS + "pkg2" + FS + "C.html",
bpatel@182:             "<STRONG><A HREF=\"../pkg2/I.html#hello(T)\">hello</A></STRONG>"},
duke@1:     };
duke@1: 
duke@1:     // Test output when -private flag is used.
duke@1:     private static final String[][] TEST2 = {
duke@1:         // Field inheritence from non-public superclass.
duke@1:         {BUG_ID + "-2" + FS + "pkg" + FS + "PublicChild.html",
duke@1:             "Fields inherited from class " +
duke@1:             "pkg.<A HREF=\"../pkg/PrivateParent.html\" " +
duke@1:             "title=\"class in pkg\">PrivateParent</A>"
duke@1:         },
duke@1:         {BUG_ID + "-2" + FS + "pkg" + FS + "PublicChild.html",
duke@1:             "<A HREF=\"../pkg/PrivateParent.html#fieldInheritedFromParent\">" +
duke@1:                 "fieldInheritedFromParent</A>"
duke@1:         },
duke@1:         // Field inheritence from non-public superinterface.
duke@1:         {BUG_ID + "-2" + FS + "pkg" + FS + "PublicInterface.html",
duke@1:             "Fields inherited from interface " +
duke@1:             "pkg.<A HREF=\"../pkg/PrivateInterface.html\" " +
duke@1:             "title=\"interface in pkg\">PrivateInterface</A>"
duke@1:         },
duke@1:         {BUG_ID + "-2" + FS + "pkg" + FS + "PublicInterface.html",
duke@1:             "<A HREF=\"../pkg/PrivateInterface.html#fieldInheritedFromInterface\">" +
duke@1:                 "fieldInheritedFromInterface</A>"
duke@1:         },
duke@1:         // Method inheritence from non-public superclass.
duke@1:         {BUG_ID + "-2" + FS + "pkg" + FS + "PublicChild.html",
duke@1:             "Methods inherited from class " +
duke@1:             "pkg.<A HREF=\"../pkg/PrivateParent.html\" " +
duke@1:             "title=\"class in pkg\">PrivateParent</A>"
duke@1:         },
duke@1:         {BUG_ID + "-2" + FS + "pkg" + FS + "PublicChild.html",
duke@1:             "<A HREF=\"../pkg/PrivateParent.html#methodInheritedFromParent(int)\">" +
duke@1:                 "methodInheritedFromParent</A>"
duke@1:         },
duke@1:         // Should document that a method overrides method from private class.
duke@1:        {BUG_ID + "-2" + FS + "pkg" + FS + "PublicChild.html",
bpatel@182:             "<STRONG>Overrides:</STRONG><DD><CODE>" +
duke@1:             "<A HREF=\"../pkg/PrivateParent.html#methodOverridenFromParent(char[], int, T, V, java.util.List)\">" +
duke@1:             "methodOverridenFromParent</A></CODE> in class <CODE>" +
duke@1:             "<A HREF=\"../pkg/PrivateParent.html\" title=\"class in pkg\">" +
duke@1:             "PrivateParent</A></CODE></DL>"},
duke@1:        // Should document that a method is specified by private interface.
duke@1:        {BUG_ID + "-2" + FS + "pkg" + FS + "PublicChild.html",
bpatel@182:             "<STRONG>Specified by:</STRONG><DD><CODE>" +
duke@1:             "<A HREF=\"../pkg/PrivateInterface.html#methodInterface(int)\">" +
duke@1:             "methodInterface</A></CODE> in interface <CODE>" +
duke@1:             "<A HREF=\"../pkg/PrivateInterface.html\" title=\"interface in pkg\">" +
duke@1:             "PrivateInterface</A></CODE></DL>" + NL + "</DD>"},
duke@1:        // Method inheritence from non-public superinterface.
duke@1:        {BUG_ID + "-2" + FS + "pkg" + FS + "PublicInterface.html",
duke@1:             "Methods inherited from interface " +
duke@1:             "pkg.<A HREF=\"../pkg/PrivateInterface.html\" " +
duke@1:             "title=\"interface in pkg\">PrivateInterface</A>"
duke@1:         },
duke@1:         {BUG_ID + "-2" + FS + "pkg" + FS + "PrivateInterface.html",
duke@1:             "<A HREF=\"../pkg/PrivateInterface.html#methodInterface(int)\">" +
duke@1:                 "methodInterface</A>"
duke@1:         },
duke@1:       // Should mention that any documentation was copied.
duke@1:       {BUG_ID + "-2" + FS + "pkg" + FS + "PublicChild.html",
duke@1:         "Description copied from"},
duke@1:       // Extend documented private classes or interfaces
duke@1:       {BUG_ID + "-2" + FS + "pkg" + FS + "PublicChild.html",
duke@1:         "extends"},
duke@1:       {BUG_ID + "-2" + FS + "pkg" + FS + "PublicInterface.html",
duke@1:         "extends"},
duke@1:       {BUG_ID + "-2" + FS + "pkg" + FS + "PublicInterface.html",
duke@1:         "All Superinterfaces"},
duke@1: 
duke@1:       //Make sure implemented interfaces from private superclass are inherited
duke@1:       {BUG_ID + "-2" + FS + "pkg" + FS + "PublicInterface.html",
bpatel@182:         "<STRONG>All Known Implementing Classes:</STRONG> <DD><A HREF=\"../pkg/PrivateParent.html\" " +
duke@1:         "title=\"class in pkg\">PrivateParent</A>, " +
duke@1:         "<A HREF=\"../pkg/PublicChild.html\" title=\"class in pkg\">PublicChild</A>"},
duke@1: 
duke@1:       {BUG_ID + "-2" + FS + "pkg" + FS + "PublicChild.html",
bpatel@182:         "<STRONG>All Implemented Interfaces:</STRONG> <DD><A HREF=\"../pkg/PrivateInterface.html\" " +
duke@1:         "title=\"interface in pkg\">PrivateInterface</A>, " +
duke@1:         "<A HREF=\"../pkg/PublicInterface.html\" title=\"interface in pkg\">" +
duke@1:         "PublicInterface</A>"},
duke@1: 
duke@1:       //Since private flag is used, we can document that private interface method
duke@1:       //with generic parameters has been implemented.
duke@1:       {BUG_ID + "-2" + FS + "pkg2" + FS + "C.html",
bpatel@182:             "<STRONG>Description copied from interface: " +
bpatel@182:             "<CODE><A HREF=\"../pkg2/I.html#hello(T)\">I</A></CODE></STRONG>"},
duke@1: 
duke@1:       {BUG_ID + "-2" + FS + "pkg2" + FS + "C.html",
bpatel@182:             "<STRONG>Specified by:</STRONG><DD><CODE><A HREF=\"../pkg2/I.html#hello(T)\">" +
bpatel@182:             "hello</A></CODE> in interface <CODE><A HREF=\"../pkg2/I.html\" " +
bpatel@182:             "title=\"interface in pkg2\">I</A>"},
duke@1:     };
duke@1:     private static final String[][] NEGATED_TEST2 = NO_TEST;
duke@1: 
duke@1:     /**
duke@1:      * The entry point of the test.
duke@1:      * @param args the array of command line arguments.
duke@1:      */
duke@1:     public static void main(String[] args) {
duke@1:         TestPrivateClasses tester = new TestPrivateClasses();
duke@1:         run(tester, ARGS1, TEST1, NEGATED_TEST1);
duke@1:         run(tester, ARGS2, TEST2, NEGATED_TEST2);
duke@1:         tester.printSummary();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public String getBugId() {
duke@1:         return BUG_ID;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public String getBugName() {
duke@1:         return getClass().getName();
duke@1:     }
duke@1: }