langtools/src/share/classes/com/sun/tools/javadoc/Main.java
author jjg
Wed, 01 Oct 2008 16:26:33 -0700
changeset 1363 d7fc53d64560
parent 10 06bc494ca11e
child 1365 ced0e3c4678f
permissions -rw-r--r--
6748601: javadoc API should allow varargs use Reviewed-by: bpatel
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
06bc494ca11e Initial load
duke
parents:
diff changeset
     2
 * Copyright 2000-2006 Sun Microsystems, Inc.  All Rights Reserved.
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.  Sun designates this
06bc494ca11e Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
06bc494ca11e Initial load
duke
parents:
diff changeset
     9
 * by Sun in the LICENSE file that accompanied this code.
06bc494ca11e Initial load
duke
parents:
diff changeset
    10
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
06bc494ca11e Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
06bc494ca11e Initial load
duke
parents:
diff changeset
    16
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load
duke
parents:
diff changeset
    20
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    21
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
06bc494ca11e Initial load
duke
parents:
diff changeset
    22
 * CA 95054 USA or visit www.sun.com if you need additional information or
06bc494ca11e Initial load
duke
parents:
diff changeset
    23
 * have any questions.
06bc494ca11e Initial load
duke
parents:
diff changeset
    24
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
package com.sun.tools.javadoc;
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
import java.io.PrintWriter;
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
/**
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
 * Provides external entry points (tool and programmatic)
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
 * for the javadoc program.
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
 * @since 1.4
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
public class Main {
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
     * Constructor should never be called.
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
    private Main() {
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    45
     * Command line interface.
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
     * @param args   The command line parameters.
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
     */
1363
d7fc53d64560 6748601: javadoc API should allow varargs use
jjg
parents: 10
diff changeset
    48
    public static void main(String... args) {
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
        System.exit(execute(args));
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
     * Programmatic interface.
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
     * @param args   The command line parameters.
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
     * @return The return code.
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
     */
1363
d7fc53d64560 6748601: javadoc API should allow varargs use
jjg
parents: 10
diff changeset
    57
    public static int execute(String... args) {
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    58
        Start jdoc = new Start();
06bc494ca11e Initial load
duke
parents:
diff changeset
    59
        return jdoc.begin(args);
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    61
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    63
     * Programmatic interface.
06bc494ca11e Initial load
duke
parents:
diff changeset
    64
     * @param programName  Name of the program (for error messages).
06bc494ca11e Initial load
duke
parents:
diff changeset
    65
     * @param args   The command line parameters.
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
     * @return The return code.
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
     */
1363
d7fc53d64560 6748601: javadoc API should allow varargs use
jjg
parents: 10
diff changeset
    68
    public static int execute(String programName, String... args) {
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
        Start jdoc = new Start(programName);
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
        return jdoc.begin(args);
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
06bc494ca11e Initial load
duke
parents:
diff changeset
    73
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
     * Programmatic interface.
06bc494ca11e Initial load
duke
parents:
diff changeset
    75
     * @param programName  Name of the program (for error messages).
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
     * @param defaultDocletClassName  Fully qualified class name.
06bc494ca11e Initial load
duke
parents:
diff changeset
    77
     * @param args   The command line parameters.
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
     * @return The return code.
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    80
    public static int execute(String programName,
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
                              String defaultDocletClassName,
1363
d7fc53d64560 6748601: javadoc API should allow varargs use
jjg
parents: 10
diff changeset
    82
                              String... args) {
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    83
        Start jdoc = new Start(programName, defaultDocletClassName);
06bc494ca11e Initial load
duke
parents:
diff changeset
    84
        return jdoc.begin(args);
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
06bc494ca11e Initial load
duke
parents:
diff changeset
    87
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    88
     * Programmatic interface.
06bc494ca11e Initial load
duke
parents:
diff changeset
    89
     * @param programName  Name of the program (for error messages).
06bc494ca11e Initial load
duke
parents:
diff changeset
    90
     * @param errWriter    PrintWriter to receive error messages.
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
     * @param warnWriter    PrintWriter to receive error messages.
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
     * @param noticeWriter    PrintWriter to receive error messages.
06bc494ca11e Initial load
duke
parents:
diff changeset
    93
     * @param defaultDocletClassName  Fully qualified class name.
06bc494ca11e Initial load
duke
parents:
diff changeset
    94
     * @param args   The command line parameters.
06bc494ca11e Initial load
duke
parents:
diff changeset
    95
     * @return The return code.
06bc494ca11e Initial load
duke
parents:
diff changeset
    96
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    97
    public static int execute(String programName,
06bc494ca11e Initial load
duke
parents:
diff changeset
    98
                              PrintWriter errWriter,
06bc494ca11e Initial load
duke
parents:
diff changeset
    99
                              PrintWriter warnWriter,
06bc494ca11e Initial load
duke
parents:
diff changeset
   100
                              PrintWriter noticeWriter,
06bc494ca11e Initial load
duke
parents:
diff changeset
   101
                              String defaultDocletClassName,
1363
d7fc53d64560 6748601: javadoc API should allow varargs use
jjg
parents: 10
diff changeset
   102
                              String... args) {
10
06bc494ca11e Initial load
duke
parents:
diff changeset
   103
        Start jdoc = new Start(programName,
06bc494ca11e Initial load
duke
parents:
diff changeset
   104
                               errWriter, warnWriter, noticeWriter,
06bc494ca11e Initial load
duke
parents:
diff changeset
   105
                               defaultDocletClassName);
06bc494ca11e Initial load
duke
parents:
diff changeset
   106
        return jdoc.begin(args);
06bc494ca11e Initial load
duke
parents:
diff changeset
   107
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   108
}