/*

 * 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 jdk.javadoc.internal.tool;

import java.io.PrintWriter;

/**

 * 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>

 */

public class Main {

    /**

     * Constructor should never be called.

     */

    private Main() {}

    /**

     * The main entry point called by the launcher. This will call

     * System.exit with an appropriate return value.

     *

     * @param args The command line parameters.

     */

    public static void main(String... args) {

        System.exit(execute(args));

    }

    /**

     * 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).exitCode;

    }

    /**

     * Programmatic interface.

     *

     * @param writer a stream for all output

     * @param args The command line parameters.

     * @return The return code.

     */

    public static int execute(String[] args, PrintWriter writer) {

        Start jdoc = new Start(writer, writer);

        return jdoc.begin(args).exitCode;

    }

    /**

     * Programmatic interface.

     *

     * @param outWriter a stream for expected output

     * @param errWriter a stream for diagnostic output

     * @param args The command line parameters.

     * @return The return code.

     */

    public static int execute(String[] args, PrintWriter outWriter, PrintWriter errWriter) {

        Start jdoc = new Start(outWriter, errWriter);

        return jdoc.begin(args).exitCode;

    }

    public static enum Result {

        /** completed with no errors */

        OK(0),

        /** Completed with reported errors */

        ERROR(1),

        /** Bad command-line arguments */

        CMDERR(2),

        /** System error or resource exhaustion */

        SYSERR(3),

        /** Terminated abnormally */

        ABNORMAL(4);

        private static final long serialVersionUID = 1L;

        Result(int exitCode) {

            this.exitCode = exitCode;

        }

        public boolean isOK() {

            return (exitCode == 0);

        }

        public final int exitCode;

        @Override

        public String toString() {

            return name() + '(' + exitCode + ')';

        }

    }

}