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

package com.sun.tools.javadoc;

import java.io.PrintWriter;

import com.sun.tools.javadoc.main.Start;

Provides external entry points (tool and programmatic)
for the javadoc program.
 
This is NOT part of any supported API.
 If you write code that depends on this, you do so at your own risk.
 This code and its internal interfaces are subject to change or
 deletion without notice.
Deprecated:
 This class is now deprecated and may be removed in a future release. See javax.tools.ToolProvider::getSystemDocumentationTool and javax.tools.DocumentationTool for replacement functionality.
Since:
1.4/**
 * Provides external entry points (tool and programmatic)
 * for the javadoc program.
 *
 *  <p><b>This is NOT part of any supported API.
 *  If you write code that depends on this, you do so at your own risk.
 *  This code and its internal interfaces are subject to change or
 *  deletion without notice.</b>
 *
 * @deprecated
 * This class is now deprecated and may be removed in a future release.
 * See
 * {@code javax.tools.ToolProvider::getSystemDocumentationTool}
 * and
 * {@code javax.tools.DocumentationTool}
 * for replacement functionality.
 *
 * @since 1.4
 */
@Deprecated
public class Main {

    
Constructor should never be called.
/**
     * Constructor should never be called.
     */
    private Main() {
    }

    
Command line interface.
Params:
args –   The command line parameters./**
     * Command line interface.
     * @param args   The command line parameters.
     */
    public static void main(String... args) {
        System.exit(execute(args));
    }

    
Programmatic interface.
Params:
args –   The command line parameters.
Returns:
The return code./**
     * Programmatic interface.
     * @param args   The command line parameters.
     * @return The return code.
     */
    public static int execute(String... args) {
        Start jdoc = new Start();
        return jdoc.begin(args);
    }

    
Programmatic interface.
Params:
args –   The command line parameters.
docletParentClassLoader – The parent class loader used when
 creating the doclet classloader. If null, the class loader used
 to instantiate doclets will be created without specifying a parent
 class loader.
Returns:
The return code.
Since:
1.7/**
     * Programmatic interface.
     * @param args   The command line parameters.
     * @param docletParentClassLoader The parent class loader used when
     *  creating the doclet classloader. If null, the class loader used
     *  to instantiate doclets will be created without specifying a parent
     *  class loader.
     * @return The return code.
     * @since 1.7
     */
    public static int execute(ClassLoader docletParentClassLoader, String... args) {
        Start jdoc = new Start(docletParentClassLoader);
        return jdoc.begin(args);
    }

    
Programmatic interface.
Params:
programName –  Name of the program (for error messages).
args –   The command line parameters.
Returns:
The return code./**
     * Programmatic interface.
     * @param programName  Name of the program (for error messages).
     * @param args   The command line parameters.
     * @return The return code.
     */
    public static int execute(String programName, String... args) {
        Start jdoc = new Start(programName);
        return jdoc.begin(args);
    }

    
Programmatic interface.
Params:
programName –  Name of the program (for error messages).
args –   The command line parameters.
docletParentClassLoader – The parent class loader used when
 creating the doclet classloader. If null, the class loader used
 to instantiate doclets will be created without specifying a parent
 class loader.
Returns:
The return code.
Since:
1.7/**
     * Programmatic interface.
     * @param programName  Name of the program (for error messages).
     * @param args   The command line parameters.
     * @param docletParentClassLoader The parent class loader used when
     *  creating the doclet classloader. If null, the class loader used
     *  to instantiate doclets will be created without specifying a parent
     *  class loader.
     * @return The return code.
     * @since 1.7
     */
    public static int execute(String programName, ClassLoader docletParentClassLoader, String... args) {
        Start jdoc = new Start(programName, docletParentClassLoader);
        return jdoc.begin(args);
    }

    
Programmatic interface.
Params:
programName –  Name of the program (for error messages).
defaultDocletClassName –  Fully qualified class name.
args –   The command line parameters.
Returns:
The return code./**
     * Programmatic interface.
     * @param programName  Name of the program (for error messages).
     * @param defaultDocletClassName  Fully qualified class name.
     * @param args   The command line parameters.
     * @return The return code.
     */
    public static int execute(String programName,
                              String defaultDocletClassName,
                              String... args) {
        Start jdoc = new Start(programName, defaultDocletClassName);
        return jdoc.begin(args);
    }

    
Programmatic interface.
Params:
programName –  Name of the program (for error messages).
defaultDocletClassName –  Fully qualified class name.
docletParentClassLoader – The parent class loader used when
 creating the doclet classloader. If null, the class loader used
 to instantiate doclets will be created without specifying a parent
 class loader.
args –   The command line parameters.
Returns:
The return code.
Since:
1.7/**
     * Programmatic interface.
     * @param programName  Name of the program (for error messages).
     * @param defaultDocletClassName  Fully qualified class name.
     * @param docletParentClassLoader The parent class loader used when
     *  creating the doclet classloader. If null, the class loader used
     *  to instantiate doclets will be created without specifying a parent
     *  class loader.
     * @param args   The command line parameters.
     * @return The return code.
     * @since 1.7
     */
    public static int execute(String programName,
                              String defaultDocletClassName,
                              ClassLoader docletParentClassLoader,
                              String... args) {
        Start jdoc = new Start(programName, defaultDocletClassName, docletParentClassLoader);
        return jdoc.begin(args);
    }

    
Programmatic interface.
Params:
programName –  Name of the program (for error messages).
errWriter –    PrintWriter to receive error messages.
warnWriter –    PrintWriter to receive error messages.
noticeWriter –    PrintWriter to receive error messages.
defaultDocletClassName –  Fully qualified class name.
args –   The command line parameters.
Returns:
The return code./**
     * Programmatic interface.
     * @param programName  Name of the program (for error messages).
     * @param errWriter    PrintWriter to receive error messages.
     * @param warnWriter    PrintWriter to receive error messages.
     * @param noticeWriter    PrintWriter to receive error messages.
     * @param defaultDocletClassName  Fully qualified class name.
     * @param args   The command line parameters.
     * @return The return code.
     */
    public static int execute(String programName,
                              PrintWriter errWriter,
                              PrintWriter warnWriter,
                              PrintWriter noticeWriter,
                              String defaultDocletClassName,
                              String... args) {
        Start jdoc = new Start(programName,
                               errWriter, warnWriter, noticeWriter,
                               defaultDocletClassName);
        return jdoc.begin(args);
    }

    
Programmatic interface.
Params:
programName –  Name of the program (for error messages).
errWriter –    PrintWriter to receive error messages.
warnWriter –    PrintWriter to receive error messages.
noticeWriter –    PrintWriter to receive error messages.
defaultDocletClassName –  Fully qualified class name.
docletParentClassLoader – The parent class loader used when
 creating the doclet classloader. If null, the class loader used
 to instantiate doclets will be created without specifying a parent
 class loader.
args –   The command line parameters.
Returns:
The return code.
Since:
1.7/**
     * Programmatic interface.
     * @param programName  Name of the program (for error messages).
     * @param errWriter    PrintWriter to receive error messages.
     * @param warnWriter    PrintWriter to receive error messages.
     * @param noticeWriter    PrintWriter to receive error messages.
     * @param defaultDocletClassName  Fully qualified class name.
     * @param docletParentClassLoader The parent class loader used when
     *  creating the doclet classloader. If null, the class loader used
     *  to instantiate doclets will be created without specifying a parent
     *  class loader.
     * @param args   The command line parameters.
     * @return The return code.
     * @since 1.7
     */
    public static int execute(String programName,
                              PrintWriter errWriter,
                              PrintWriter warnWriter,
                              PrintWriter noticeWriter,
                              String defaultDocletClassName,
                              ClassLoader docletParentClassLoader,
                              String... args) {
        Start jdoc = new Start(programName,
                               errWriter, warnWriter, noticeWriter,
                               defaultDocletClassName,
                               docletParentClassLoader);
        return jdoc.begin(args);
    }
}