langtools/test/com/sun/javadoc/testOverridenMethods/TestOverridenPrivateMethodsWithPackageFlag.java
author bpatel
Wed, 01 Dec 2010 11:02:38 -0800
changeset 7614 cfadc977ca75
parent 5520 86e4b9a9da40
child 7681 1f0819a3341f
permissions -rw-r--r--
6851834: Javadoc doclet needs a structured approach to generate the output HTML. Reviewed-by: jjg
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 2216
diff changeset
     2
 * Copyright (c) 2002, 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
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
 * @bug 4634891
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
 * @summary Determine if overriden methods are properly documented when
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
 * -protected (default) visibility flag is used.
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
 * @author jamieh
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
 * @library ../lib/
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
 * @build JavadocTester
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
 * @build TestOverridenPrivateMethodsWithPackageFlag
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
 * @run main TestOverridenPrivateMethodsWithPackageFlag
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 TestOverridenPrivateMethodsWithPackageFlag extends JavadocTester {
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
    private static final String BUG_ID = "4634891";
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
    private static final String[][] TEST = {
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
        //The public method should be overriden
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
        {BUG_ID + FS + "pkg1" + FS + "SubClass.html",
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    43
         "<dt><strong>Overrides:</strong></dt>" + NL +
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    44
                 "<dd><code><a href=\"../pkg1/BaseClass.html#publicMethod()\">" +
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    45
                 "publicMethod</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
    46
                 "<a href=\"../pkg1/BaseClass.html\" title=\"class in pkg1\">BaseClass</a></code></dd>"},
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
        //The public method in different package should be overriden
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
        {BUG_ID + FS + "pkg2" + FS + "SubClass.html",
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    50
         "<dt><strong>Overrides:</strong></dt>" + NL +
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    51
                 "<dd><code><a href=\"../pkg1/BaseClass.html#publicMethod()\">" +
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    52
                 "publicMethod</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
    53
                 "<a href=\"../pkg1/BaseClass.html\" title=\"class in pkg1\">BaseClass</a></code></dd>"},
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
        //The package private method should be overriden since the base and sub class are in the same
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
        //package.
06bc494ca11e Initial load
duke
parents:
diff changeset
    57
        {BUG_ID + FS + "pkg1" + FS + "SubClass.html",
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    58
         "<dt><strong>Overrides:</strong></dt>" + NL +
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    59
                 "<dd><code><a href=\"../pkg1/BaseClass.html#packagePrivateMethod()\">" +
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    60
                 "packagePrivateMethod</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
    61
                 "<a href=\"../pkg1/BaseClass.html\" title=\"class in pkg1\">BaseClass</a></code></dd>"}
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
    private static final String[][] NEGATED_TEST = {
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
        //The private method in should not be overriden
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
        {BUG_ID + FS + "pkg1" + FS + "SubClass.html",
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    68
         "<dt><strong>Overrides:</strong></dt>" + NL +
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    69
                 "<dd><code><a href=\"../pkg1/BaseClass.html#privateMethod()\">"},
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
        //The private method in different package should not be overriden
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
        {BUG_ID + FS + "pkg2" + FS + "SubClass.html",
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    73
         "<dt><strong>Overrides:</strong></dt>" + NL +
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    74
                 "<dd><code><a href=\"../pkg1/BaseClass.html#privateMethod()\">"},
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
        //The package private method should not be overriden since the base and sub class are in
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
        //different packages.
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
        {BUG_ID + FS + "pkg2" + FS + "SubClass.html",
7614
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    79
         "<dt><strong>Overrides:</strong></dt>" + NL +
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML.
bpatel
parents: 5520
diff changeset
    80
                 "<dd><code><a href=\"../pkg1/BaseClass.html#packagePrivateMethod()\">"},
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    82
06bc494ca11e Initial load
duke
parents:
diff changeset
    83
    private static final String[] ARGS =
06bc494ca11e Initial load
duke
parents:
diff changeset
    84
        new String[] {
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
            "-d", BUG_ID, "-sourcepath", SRC_DIR, "-package", "pkg1", "pkg2"};
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
06bc494ca11e Initial load
duke
parents:
diff changeset
    87
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    88
     * The entry point of the test.
06bc494ca11e Initial load
duke
parents:
diff changeset
    89
     * @param args the array of command line arguments.
06bc494ca11e Initial load
duke
parents:
diff changeset
    90
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
    public static void main(String[] args) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
        TestOverridenPrivateMethodsWithPackageFlag tester = new TestOverridenPrivateMethodsWithPackageFlag();
06bc494ca11e Initial load
duke
parents:
diff changeset
    93
        run(tester, ARGS, TEST, NEGATED_TEST);
06bc494ca11e Initial load
duke
parents:
diff changeset
    94
        tester.printSummary();
06bc494ca11e Initial load
duke
parents:
diff changeset
    95
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    96
06bc494ca11e Initial load
duke
parents:
diff changeset
    97
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    98
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
    99
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   100
    public String getBugId() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   101
        return BUG_ID;
06bc494ca11e Initial load
duke
parents:
diff changeset
   102
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   103
06bc494ca11e Initial load
duke
parents:
diff changeset
   104
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   105
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   106
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   107
    public String getBugName() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   108
        return getClass().getName();
06bc494ca11e Initial load
duke
parents:
diff changeset
   109
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   110
}