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>
  33  * <b>This is NOT part of any supported API. If you write code that depends on this, you do so at
  34  * your own risk. This code and its internal interfaces are subject to change or deletion without
  35  * notice.</b>
  36  *
  37  * @since 1.4
  38  */
  39 public class Main {
  40 
  41     /**
  42      * Constructor should never be called.
  43      */
  44     private Main() {}
  45 
  46     /**
  47      * The main entry point called by the launcher. This will call
  48      * System.exit with an appropriate return value.
  49      *
  50      * @param args The command line parameters.
  51      */
  52     public static void main(String... args) {
  53         System.exit(execute(args));
  54     }
  55 
  56     /**
  57      * Programmatic interface.
  58      *
  59      * @param args The command line parameters.
  60      * @return The return code.
  61      */
  62     public static int execute(String... args) {
  63         // NOTE: the following should be removed when the old doclet
  64         // is removed.
  65         if (args != null && args.length > 0 && "-Xold".equals(args[0])) {
  66             String[] nargs = new String[args.length - 1];
  67             System.arraycopy(args, 1, nargs, 0, nargs.length);
  68             return com.sun.tools.javadoc.Main.execute(nargs);
  69         }
  70         Start jdoc = new Start();
  71         return jdoc.begin(args);
  72     }
  73 
  74     /**
  75      * Programmatic interface.
  76      *
  77      * @param writer PrintWriter to receive notice messages.
  78      * @param args The command line parameters.
  79      * @return The return code.
  80      */
  81     public static int execute(String[] args, PrintWriter writer) {
  82         Start jdoc = new Start(writer);
  83         return jdoc.begin(args);
  84     }
  85 }