1 /*

     2  * Copyright (c) 2000, 2016, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    25 package jdk.javadoc.internal.tool;

    26 

    27 import java.io.PrintWriter;

    28 

    29 /**

    30  * Provides external entry points (tool and programmatic) for the javadoc program.

    31  *

    32  *  <p><b>This is NOT part of any supported API.

    33  *  If you write code that depends on this, you do so at your own risk.

    34  *  This code and its internal interfaces are subject to change or

    35  *  deletion without notice.</b>

    36  */

    37 

    38 public class Main {

    39 

    40     /**

    41      * Constructor should never be called.

    42      */

    43     private Main() {}

    44 

    45     /**

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

    47      * System.exit with an appropriate return value.

    48      *

    49      * @param args The command line parameters.

    50      */

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

    52         System.exit(execute(args));

    53     }

    54 

    55     /**

    56      * Programmatic interface.

    57      *

    58      * @param args The command line parameters.

    59      * @return The return code.

    60      */

    61     public static int execute(String... args) {

    62         Start jdoc = new Start();

    63         return jdoc.begin(args).exitCode;

    64     }

    65 

    66     /**

    67      * Programmatic interface.

    68      *

    69      * @param writer a stream for all output

    70      * @param args The command line parameters.

    71      * @return The return code.

    72      */

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

    74         Start jdoc = new Start(writer, writer);

    75         return jdoc.begin(args).exitCode;

    76     }

    77 

    78     /**

    79      * Programmatic interface.

    80      *

    81      * @param outWriter a stream for expected output

    82      * @param errWriter a stream for diagnostic output

    83      * @param args The command line parameters.

    84      * @return The return code.

    85      */

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

    87         Start jdoc = new Start(outWriter, errWriter);

    88         return jdoc.begin(args).exitCode;

    89     }

    90 

    91     public static enum Result {

    92         /** completed with no errors */

    93         OK(0),

    94         /** Completed with reported errors */

    95         ERROR(1),

    96         /** Bad command-line arguments */

    97         CMDERR(2),

    98         /** System error or resource exhaustion */

    99         SYSERR(3),

   100         /** Terminated abnormally */

   101         ABNORMAL(4);

   102 

   103         private static final long serialVersionUID = 1L;

   104 

   105         Result(int exitCode) {

   106             this.exitCode = exitCode;

   107         }

   108 

   109         public boolean isOK() {

   110             return (exitCode == 0);

   111         }

   112 

   113         public final int exitCode;

   114 

   115         @Override

   116         public String toString() {

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

   118         }

   119     }

   120 }