aoqi@0: /* aoqi@0: * Copyright (c) 2000, 2012, Oracle and/or its affiliates. All rights reserved. aoqi@0: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. aoqi@0: * aoqi@0: * This code is free software; you can redistribute it and/or modify it aoqi@0: * under the terms of the GNU General Public License version 2 only, as aoqi@0: * published by the Free Software Foundation. Oracle designates this aoqi@0: * particular file as subject to the "Classpath" exception as provided aoqi@0: * by Oracle in the LICENSE file that accompanied this code. aoqi@0: * aoqi@0: * This code is distributed in the hope that it will be useful, but WITHOUT aoqi@0: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or aoqi@0: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License aoqi@0: * version 2 for more details (a copy is included in the LICENSE file that aoqi@0: * accompanied this code). aoqi@0: * aoqi@0: * You should have received a copy of the GNU General Public License version aoqi@0: * 2 along with this work; if not, write to the Free Software Foundation, aoqi@0: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. aoqi@0: * aoqi@0: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA aoqi@0: * or visit www.oracle.com if you need additional information or have any aoqi@0: * questions. aoqi@0: */ aoqi@0: aoqi@0: package com.sun.tools.javadoc; aoqi@0: aoqi@0: import java.io.PrintWriter; aoqi@0: aoqi@0: /** aoqi@0: * Provides external entry points (tool and programmatic) aoqi@0: * for the javadoc program. aoqi@0: * aoqi@0: *

This is NOT part of any supported API. aoqi@0: * If you write code that depends on this, you do so at your own risk. aoqi@0: * This code and its internal interfaces are subject to change or aoqi@0: * deletion without notice. aoqi@0: * aoqi@0: * @since 1.4 aoqi@0: */ aoqi@0: public class Main { aoqi@0: aoqi@0: /** aoqi@0: * Constructor should never be called. aoqi@0: */ aoqi@0: private Main() { aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Command line interface. aoqi@0: * @param args The command line parameters. aoqi@0: */ aoqi@0: public static void main(String... args) { aoqi@0: System.exit(execute(args)); aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Programmatic interface. aoqi@0: * @param args The command line parameters. aoqi@0: * @return The return code. aoqi@0: */ aoqi@0: public static int execute(String... args) { aoqi@0: Start jdoc = new Start(); aoqi@0: return jdoc.begin(args); aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Programmatic interface. aoqi@0: * @param args The command line parameters. aoqi@0: * @param docletParentClassLoader The parent class loader used when aoqi@0: * creating the doclet classloader. If null, the class loader used aoqi@0: * to instantiate doclets will be created without specifying a parent aoqi@0: * class loader. aoqi@0: * @return The return code. aoqi@0: * @since 1.7 aoqi@0: */ aoqi@0: public static int execute(ClassLoader docletParentClassLoader, String... args) { aoqi@0: Start jdoc = new Start(docletParentClassLoader); aoqi@0: return jdoc.begin(args); aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Programmatic interface. aoqi@0: * @param programName Name of the program (for error messages). aoqi@0: * @param args The command line parameters. aoqi@0: * @return The return code. aoqi@0: */ aoqi@0: public static int execute(String programName, String... args) { aoqi@0: Start jdoc = new Start(programName); aoqi@0: return jdoc.begin(args); aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Programmatic interface. aoqi@0: * @param programName Name of the program (for error messages). aoqi@0: * @param args The command line parameters. aoqi@0: * @param docletParentClassLoader The parent class loader used when aoqi@0: * creating the doclet classloader. If null, the class loader used aoqi@0: * to instantiate doclets will be created without specifying a parent aoqi@0: * class loader. aoqi@0: * @return The return code. aoqi@0: * @since 1.7 aoqi@0: */ aoqi@0: public static int execute(String programName, ClassLoader docletParentClassLoader, String... args) { aoqi@0: Start jdoc = new Start(programName, docletParentClassLoader); aoqi@0: return jdoc.begin(args); aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Programmatic interface. aoqi@0: * @param programName Name of the program (for error messages). aoqi@0: * @param defaultDocletClassName Fully qualified class name. aoqi@0: * @param args The command line parameters. aoqi@0: * @return The return code. aoqi@0: */ aoqi@0: public static int execute(String programName, aoqi@0: String defaultDocletClassName, aoqi@0: String... args) { aoqi@0: Start jdoc = new Start(programName, defaultDocletClassName); aoqi@0: return jdoc.begin(args); aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Programmatic interface. aoqi@0: * @param programName Name of the program (for error messages). aoqi@0: * @param defaultDocletClassName Fully qualified class name. aoqi@0: * @param docletParentClassLoader The parent class loader used when aoqi@0: * creating the doclet classloader. If null, the class loader used aoqi@0: * to instantiate doclets will be created without specifying a parent aoqi@0: * class loader. aoqi@0: * @param args The command line parameters. aoqi@0: * @return The return code. aoqi@0: * @since 1.7 aoqi@0: */ aoqi@0: public static int execute(String programName, aoqi@0: String defaultDocletClassName, aoqi@0: ClassLoader docletParentClassLoader, aoqi@0: String... args) { aoqi@0: Start jdoc = new Start(programName, defaultDocletClassName, docletParentClassLoader); aoqi@0: return jdoc.begin(args); aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Programmatic interface. aoqi@0: * @param programName Name of the program (for error messages). aoqi@0: * @param errWriter PrintWriter to receive error messages. aoqi@0: * @param warnWriter PrintWriter to receive error messages. aoqi@0: * @param noticeWriter PrintWriter to receive error messages. aoqi@0: * @param defaultDocletClassName Fully qualified class name. aoqi@0: * @param args The command line parameters. aoqi@0: * @return The return code. aoqi@0: */ aoqi@0: public static int execute(String programName, aoqi@0: PrintWriter errWriter, aoqi@0: PrintWriter warnWriter, aoqi@0: PrintWriter noticeWriter, aoqi@0: String defaultDocletClassName, aoqi@0: String... args) { aoqi@0: Start jdoc = new Start(programName, aoqi@0: errWriter, warnWriter, noticeWriter, aoqi@0: defaultDocletClassName); aoqi@0: return jdoc.begin(args); aoqi@0: } aoqi@0: aoqi@0: /** aoqi@0: * Programmatic interface. aoqi@0: * @param programName Name of the program (for error messages). aoqi@0: * @param errWriter PrintWriter to receive error messages. aoqi@0: * @param warnWriter PrintWriter to receive error messages. aoqi@0: * @param noticeWriter PrintWriter to receive error messages. aoqi@0: * @param defaultDocletClassName Fully qualified class name. aoqi@0: * @param docletParentClassLoader The parent class loader used when aoqi@0: * creating the doclet classloader. If null, the class loader used aoqi@0: * to instantiate doclets will be created without specifying a parent aoqi@0: * class loader. aoqi@0: * @param args The command line parameters. aoqi@0: * @return The return code. aoqi@0: * @since 1.7 aoqi@0: */ aoqi@0: public static int execute(String programName, aoqi@0: PrintWriter errWriter, aoqi@0: PrintWriter warnWriter, aoqi@0: PrintWriter noticeWriter, aoqi@0: String defaultDocletClassName, aoqi@0: ClassLoader docletParentClassLoader, aoqi@0: String... args) { aoqi@0: Start jdoc = new Start(programName, aoqi@0: errWriter, warnWriter, noticeWriter, aoqi@0: defaultDocletClassName, aoqi@0: docletParentClassLoader); aoqi@0: return jdoc.begin(args); aoqi@0: } aoqi@0: }