langtools/test/com/sun/javadoc/testSerializedForm/TestSerializedForm.java
author martin
Fri, 11 Jun 2010 18:55:45 -0700
changeset 5786 f60ef38202e7
parent 5520 86e4b9a9da40
child 7614 cfadc977ca75
permissions -rw-r--r--
6944584: Improvements to subprocess handling on Unix Summary: use thread pool for reaper thread; move most I/O operations out of reaper thread Reviewed-by: michaelm, hiroshi
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: 1787
diff changeset
     2
 * Copyright (c) 2001, 2003, 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: 1787
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1787
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 1787
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
import java.lang.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
import java.io.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
/*
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
 * @test
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
 * @bug 4341304 4485668 4966728
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
 * @summary Test that methods readResolve and writeReplace show
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
 * up in serialized-form.html the same way that readObject and writeObject do.
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
 * If the doclet includes readResolve and writeReplace in the serialized-form
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
 * documentation that same way the it includes readObject and writeObject, the
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
 * test passes.  This also tests that throws tag information is correctly shown
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
 * in the serialized form page.
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
 * Make sure see tags work in serialized form.
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
 * @author jamieh
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
 * @library ../lib/
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
 * @build JavadocTester
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
 * @build TestSerializedForm
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
 * @run main TestSerializedForm
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
public class TestSerializedForm extends JavadocTester implements Serializable {
06bc494ca11e Initial load
duke
parents:
diff changeset
    45
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
    private static final String BUG_ID = "4341304-4485668-4966728";
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
    private static final String[][] TEST = {
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
        {BUG_ID + FS + "serialized-form.html",
1787
1aa079321cd2 6786028: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Bold tags should be strong
bpatel
parents: 10
diff changeset
    50
            "protected java.lang.Object <STRONG>readResolve</STRONG>()"},
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
        {BUG_ID + FS + "serialized-form.html",
1787
1aa079321cd2 6786028: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Bold tags should be strong
bpatel
parents: 10
diff changeset
    52
            "protected java.lang.Object <STRONG>writeReplace</STRONG>()"},
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
        {BUG_ID + FS + "serialized-form.html",
1787
1aa079321cd2 6786028: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Bold tags should be strong
bpatel
parents: 10
diff changeset
    54
            "protected java.lang.Object <STRONG>readObjectNoData</STRONG>()"},
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
        {BUG_ID + FS + "serialized-form.html",
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
            "See Also"},
06bc494ca11e Initial load
duke
parents:
diff changeset
    57
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    58
06bc494ca11e Initial load
duke
parents:
diff changeset
    59
    private static final String[][] NEGATED_TEST = NO_TEST;
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
    private static final String[] ARGS = new String[] {
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
        "-d", BUG_ID, "-sourcepath", SRC_DIR,
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
        SRC_DIR + FS + "TestSerializedForm.java"
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
    };
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
     * @serial
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
     * @see TestSerializedForm
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
    public final int SERIALIZABLE_CONSTANT = 1;
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
     * The entry point of the test.
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
     * @param args the array of command line arguments.
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
    public static void main(String[] args) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
        TestSerializedForm tester = new TestSerializedForm();
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
        int actualExitCode = run(tester, ARGS, TEST, NEGATED_TEST);
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
        tester.printSummary();
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    80
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    82
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
    83
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    84
    public String getBugId() {
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
        return BUG_ID;
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    87
06bc494ca11e Initial load
duke
parents:
diff changeset
    88
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    89
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
    90
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
    public String getBugName() {
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
        return getClass().getName();
06bc494ca11e Initial load
duke
parents:
diff changeset
    93
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    94
06bc494ca11e Initial load
duke
parents:
diff changeset
    95
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    96
     * @throws IOException when there is an I/O error.
06bc494ca11e Initial load
duke
parents:
diff changeset
    97
     * @serial
06bc494ca11e Initial load
duke
parents:
diff changeset
    98
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    99
    private void readObject(ObjectInputStream s) {}
06bc494ca11e Initial load
duke
parents:
diff changeset
   100
06bc494ca11e Initial load
duke
parents:
diff changeset
   101
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   102
     * @throws IOException when there is an I/O error.
06bc494ca11e Initial load
duke
parents:
diff changeset
   103
     * @serial
06bc494ca11e Initial load
duke
parents:
diff changeset
   104
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   105
    private void writeObject(ObjectOutputStream s) {}
06bc494ca11e Initial load
duke
parents:
diff changeset
   106
06bc494ca11e Initial load
duke
parents:
diff changeset
   107
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   108
     * @throws IOException when there is an I/O error.
06bc494ca11e Initial load
duke
parents:
diff changeset
   109
     * @serialData This is a serial data comment.
06bc494ca11e Initial load
duke
parents:
diff changeset
   110
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   111
    protected Object readResolve(){return null;}
06bc494ca11e Initial load
duke
parents:
diff changeset
   112
06bc494ca11e Initial load
duke
parents:
diff changeset
   113
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   114
     * @throws IOException when there is an I/O error.
06bc494ca11e Initial load
duke
parents:
diff changeset
   115
     * @serialData This is a serial data comment.
06bc494ca11e Initial load
duke
parents:
diff changeset
   116
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   117
    protected Object writeReplace(){return null;}
06bc494ca11e Initial load
duke
parents:
diff changeset
   118
06bc494ca11e Initial load
duke
parents:
diff changeset
   119
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   120
     * @throws IOException when there is an I/O error.
06bc494ca11e Initial load
duke
parents:
diff changeset
   121
     * @serialData This is a serial data comment.
06bc494ca11e Initial load
duke
parents:
diff changeset
   122
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   123
    protected Object readObjectNoData() {
06bc494ca11e Initial load
duke
parents:
diff changeset
   124
        return null;
06bc494ca11e Initial load
duke
parents:
diff changeset
   125
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   126
06bc494ca11e Initial load
duke
parents:
diff changeset
   127
}