Class Start


  • @Deprecated
    public class Start
    extends ToolOption.Helper
    Deprecated.
    Main program of Javadoc. Previously named "Main".

    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.

    Since:
    1.2
    • Constructor Summary

      Constructors 
      Constructor Description
      Start()
      Deprecated.
       
      Start​(com.sun.tools.javac.util.Context context)
      Deprecated.
       
      Start​(java.io.PrintWriter pw)
      Deprecated.
       
      Start​(java.lang.ClassLoader docletParentClassLoader)
      Deprecated.
       
      Start​(java.lang.String programName)
      Deprecated.
       
      Start​(java.lang.String programName, java.io.PrintWriter errWriter, java.io.PrintWriter warnWriter, java.io.PrintWriter noticeWriter, java.lang.String defaultDocletClassName)
      Deprecated.
       
      Start​(java.lang.String programName, java.io.PrintWriter errWriter, java.io.PrintWriter warnWriter, java.io.PrintWriter noticeWriter, java.lang.String defaultDocletClassName, java.lang.ClassLoader docletParentClassLoader)
      Deprecated.
       
      Start​(java.lang.String programName, java.lang.ClassLoader docletParentClassLoader)
      Deprecated.
       
      Start​(java.lang.String programName, java.lang.String defaultDocletClassName)
      Deprecated.
       
      Start​(java.lang.String programName, java.lang.String defaultDocletClassName, java.lang.ClassLoader docletParentClassLoader)
      Deprecated.
       
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean begin​(java.lang.Class<?> docletClass, java.lang.Iterable<java.lang.String> options, java.lang.Iterable<? extends javax.tools.JavaFileObject> fileObjects)
      Deprecated.
       
      private boolean begin​(java.lang.Class<?> docletClass, java.lang.String[] options, java.lang.Iterable<? extends javax.tools.JavaFileObject> fileObjects)
      Deprecated.
       
      int begin​(java.lang.String... argv)
      Deprecated.
      Main program - external wrapper
      private void exit()
      Deprecated.
      Exit
      (package private) com.sun.tools.javac.main.OptionHelper getOptionHelper()
      Deprecated.
       
      private <T> boolean isEmpty​(java.lang.Iterable<T> iter)
      Deprecated.
       
      private void oneArg​(java.lang.String[] args, int index)
      Deprecated.
      Set one arg option.
      private boolean parseAndExecute​(java.lang.Class<?> docletClass, java.lang.String[] argv, java.lang.Iterable<? extends javax.tools.JavaFileObject> fileObjects)
      Deprecated.
      Main program - internal
      private void setDocletInvoker​(java.lang.Class<?> docletClass, javax.tools.JavaFileManager fileManager, java.lang.String[] argv)
      Deprecated.
      Init the doclet invoker.
      private void setOption​(java.lang.String opt)
      Deprecated.
      indicate an option with no arguments was given.
      private void setOption​(java.lang.String opt, com.sun.tools.javac.util.List<java.lang.String> arguments)
      Deprecated.
      indicate an option with the specified list of arguments was given.
      private void setOption​(java.lang.String opt, java.lang.String argument)
      Deprecated.
      indicate an option with one argument was given.
      (package private) void usage()
      Deprecated.
      Usage
      (package private) void usage​(boolean exit)
      Deprecated.
       
      private void usage​(java.lang.String main, java.lang.String doclet, java.lang.String foot, boolean exit)
      Deprecated.
       
      (package private) void usageError​(java.lang.String key, java.lang.Object... args)
      Deprecated.
       
      (package private) void Xusage()
      Deprecated.
       
      (package private) void Xusage​(boolean exit)
      Deprecated.
       
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • context

        private final com.sun.tools.javac.util.Context context
        Deprecated.
        Context for this invocation.
      • defaultDocletClassName

        private final java.lang.String defaultDocletClassName
        Deprecated.
      • docletParentClassLoader

        private final java.lang.ClassLoader docletParentClassLoader
        Deprecated.
      • javadocName

        private static final java.lang.String javadocName
        Deprecated.
        See Also:
        Constant Field Values
      • standardDocletClassName

        private static final java.lang.String standardDocletClassName
        Deprecated.
        See Also:
        Constant Field Values
      • messager

        private final Messager messager
        Deprecated.
      • apiMode

        private boolean apiMode
        Deprecated.
        In API mode, exceptions thrown while calling the doclet are propagated using ClientCodeException.
      • fileManager

        private javax.tools.JavaFileManager fileManager
        Deprecated.
    • Constructor Detail

      • Start

        public Start​(java.lang.String programName,
                     java.io.PrintWriter errWriter,
                     java.io.PrintWriter warnWriter,
                     java.io.PrintWriter noticeWriter,
                     java.lang.String defaultDocletClassName)
        Deprecated.
      • Start

        public Start​(java.io.PrintWriter pw)
        Deprecated.
      • Start

        public Start​(java.lang.String programName,
                     java.io.PrintWriter errWriter,
                     java.io.PrintWriter warnWriter,
                     java.io.PrintWriter noticeWriter,
                     java.lang.String defaultDocletClassName,
                     java.lang.ClassLoader docletParentClassLoader)
        Deprecated.
      • Start

        public Start​(java.lang.String programName,
                     java.lang.String defaultDocletClassName)
        Deprecated.
      • Start

        public Start​(java.lang.String programName,
                     java.lang.String defaultDocletClassName,
                     java.lang.ClassLoader docletParentClassLoader)
        Deprecated.
      • Start

        public Start​(java.lang.String programName,
                     java.lang.ClassLoader docletParentClassLoader)
        Deprecated.
      • Start

        public Start​(java.lang.String programName)
        Deprecated.
      • Start

        public Start​(java.lang.ClassLoader docletParentClassLoader)
        Deprecated.
      • Start

        public Start()
        Deprecated.
      • Start

        public Start​(com.sun.tools.javac.util.Context context)
        Deprecated.
    • Method Detail

      • usage

        void usage​(boolean exit)
        Deprecated.
      • Xusage

        void Xusage​(boolean exit)
        Deprecated.
      • usage

        private void usage​(java.lang.String main,
                           java.lang.String doclet,
                           java.lang.String foot,
                           boolean exit)
        Deprecated.
      • exit

        private void exit()
        Deprecated.
        Exit
      • begin

        public int begin​(java.lang.String... argv)
        Deprecated.
        Main program - external wrapper
      • begin

        public boolean begin​(java.lang.Class<?> docletClass,
                             java.lang.Iterable<java.lang.String> options,
                             java.lang.Iterable<? extends javax.tools.JavaFileObject> fileObjects)
        Deprecated.
      • begin

        private boolean begin​(java.lang.Class<?> docletClass,
                              java.lang.String[] options,
                              java.lang.Iterable<? extends javax.tools.JavaFileObject> fileObjects)
        Deprecated.
      • parseAndExecute

        private boolean parseAndExecute​(java.lang.Class<?> docletClass,
                                        java.lang.String[] argv,
                                        java.lang.Iterable<? extends javax.tools.JavaFileObject> fileObjects)
                                 throws java.io.IOException
        Deprecated.
        Main program - internal
        Throws:
        java.io.IOException
      • isEmpty

        private <T> boolean isEmpty​(java.lang.Iterable<T> iter)
        Deprecated.
      • setDocletInvoker

        private void setDocletInvoker​(java.lang.Class<?> docletClass,
                                      javax.tools.JavaFileManager fileManager,
                                      java.lang.String[] argv)
        Deprecated.
        Init the doclet invoker. The doclet class may be given explicitly, or via the -doclet option in argv. If the doclet class is not given explicitly, it will be loaded from the file manager's DOCLET_PATH location, if available, or via the -doclet path option in argv.
        Parameters:
        docletClass - The doclet class. May be null.
        fileManager - The file manager used to get the class loader to load the doclet class if required. May be null.
        argv - Args containing -doclet and -docletpath, in case they are required.
      • oneArg

        private void oneArg​(java.lang.String[] args,
                            int index)
        Deprecated.
        Set one arg option. Error and exit if one argument is not provided.
      • usageError

        void usageError​(java.lang.String key,
                        java.lang.Object... args)
        Deprecated.
        Specified by:
        usageError in class ToolOption.Helper
      • setOption

        private void setOption​(java.lang.String opt)
        Deprecated.
        indicate an option with no arguments was given.
      • setOption

        private void setOption​(java.lang.String opt,
                               java.lang.String argument)
        Deprecated.
        indicate an option with one argument was given.
      • setOption

        private void setOption​(java.lang.String opt,
                               com.sun.tools.javac.util.List<java.lang.String> arguments)
        Deprecated.
        indicate an option with the specified list of arguments was given.