src/share/classes/com/sun/tools/javadoc/Main.java

Wed, 01 Oct 2008 16:26:33 -0700

author
jjg
date
Wed, 01 Oct 2008 16:26:33 -0700
changeset 127
d593587c5938
parent 1
9a66ca7c79fa
child 129
944790f83b57
permissions
-rw-r--r--

6748601: javadoc API should allow varargs use
Reviewed-by: bpatel

duke@1 1 /*
duke@1 2 * Copyright 2000-2006 Sun Microsystems, Inc. All Rights Reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
duke@1 7 * published by the Free Software Foundation. Sun designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
duke@1 9 * by Sun in the LICENSE file that accompanied this code.
duke@1 10 *
duke@1 11 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 14 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 15 * accompanied this code).
duke@1 16 *
duke@1 17 * You should have received a copy of the GNU General Public License version
duke@1 18 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 20 *
duke@1 21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1 22 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1 23 * have any questions.
duke@1 24 */
duke@1 25
duke@1 26 package com.sun.tools.javadoc;
duke@1 27
duke@1 28 import java.io.PrintWriter;
duke@1 29
duke@1 30 /**
duke@1 31 * Provides external entry points (tool and programmatic)
duke@1 32 * for the javadoc program.
duke@1 33 *
duke@1 34 * @since 1.4
duke@1 35 */
duke@1 36 public class Main {
duke@1 37
duke@1 38 /**
duke@1 39 * Constructor should never be called.
duke@1 40 */
duke@1 41 private Main() {
duke@1 42 }
duke@1 43
duke@1 44 /**
duke@1 45 * Command line interface.
duke@1 46 * @param args The command line parameters.
duke@1 47 */
jjg@127 48 public static void main(String... args) {
duke@1 49 System.exit(execute(args));
duke@1 50 }
duke@1 51
duke@1 52 /**
duke@1 53 * Programmatic interface.
duke@1 54 * @param args The command line parameters.
duke@1 55 * @return The return code.
duke@1 56 */
jjg@127 57 public static int execute(String... args) {
duke@1 58 Start jdoc = new Start();
duke@1 59 return jdoc.begin(args);
duke@1 60 }
duke@1 61
duke@1 62 /**
duke@1 63 * Programmatic interface.
duke@1 64 * @param programName Name of the program (for error messages).
duke@1 65 * @param args The command line parameters.
duke@1 66 * @return The return code.
duke@1 67 */
jjg@127 68 public static int execute(String programName, String... args) {
duke@1 69 Start jdoc = new Start(programName);
duke@1 70 return jdoc.begin(args);
duke@1 71 }
duke@1 72
duke@1 73 /**
duke@1 74 * Programmatic interface.
duke@1 75 * @param programName Name of the program (for error messages).
duke@1 76 * @param defaultDocletClassName Fully qualified class name.
duke@1 77 * @param args The command line parameters.
duke@1 78 * @return The return code.
duke@1 79 */
duke@1 80 public static int execute(String programName,
duke@1 81 String defaultDocletClassName,
jjg@127 82 String... args) {
duke@1 83 Start jdoc = new Start(programName, defaultDocletClassName);
duke@1 84 return jdoc.begin(args);
duke@1 85 }
duke@1 86
duke@1 87 /**
duke@1 88 * Programmatic interface.
duke@1 89 * @param programName Name of the program (for error messages).
duke@1 90 * @param errWriter PrintWriter to receive error messages.
duke@1 91 * @param warnWriter PrintWriter to receive error messages.
duke@1 92 * @param noticeWriter PrintWriter to receive error messages.
duke@1 93 * @param defaultDocletClassName Fully qualified class name.
duke@1 94 * @param args The command line parameters.
duke@1 95 * @return The return code.
duke@1 96 */
duke@1 97 public static int execute(String programName,
duke@1 98 PrintWriter errWriter,
duke@1 99 PrintWriter warnWriter,
duke@1 100 PrintWriter noticeWriter,
duke@1 101 String defaultDocletClassName,
jjg@127 102 String... args) {
duke@1 103 Start jdoc = new Start(programName,
duke@1 104 errWriter, warnWriter, noticeWriter,
duke@1 105 defaultDocletClassName);
duke@1 106 return jdoc.begin(args);
duke@1 107 }
duke@1 108 }

mercurial