Class DocletInvoker

java.lang.Object
gw.gosudoc.com.sun.tools.javadoc.main.DocletInvoker

@Deprecated public class DocletInvoker extends Object
Deprecated.
Class creates, controls and invokes doclets.

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.

  • Field Details

    • docletClass

      private final Class<?> docletClass
      Deprecated.
    • docletClassName

      private final String docletClassName
      Deprecated.
    • appClassLoader

      private final ClassLoader appClassLoader
      Deprecated.
    • messager

      private final Messager messager
      Deprecated.
    • apiMode

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

      private final boolean exportInternalAPI
      Deprecated.
      Whether javadoc internal API should be exported to doclets and (indirectly) to taglets
  • Constructor Details

    • DocletInvoker

      public DocletInvoker(Messager messager, Class<?> docletClass, boolean apiMode, boolean exportInternalAPI)
      Deprecated.
    • DocletInvoker

      public DocletInvoker(Messager messager, JavaFileManager fileManager, String docletClassName, String docletPath, ClassLoader docletParentClassLoader, boolean apiMode, boolean exportInternalAPI)
      Deprecated.
  • Method Details

    • appendPath

      private String appendPath(String path1, String path2)
      Deprecated.
    • getDelegationClassLoader

      private ClassLoader getDelegationClassLoader(String docletClassName)
      Deprecated.
    • start

      public boolean start(RootDoc root)
      Deprecated.
      Generate documentation here. Return true on success.
    • optionLength

      public int optionLength(String option)
      Deprecated.
      Check for doclet added options here. Zero return means option not known. Positive value indicates number of arguments to option. Negative value means error occurred.
    • validOptions

      public boolean validOptions(com.sun.tools.javac.util.List<String[]> optlist)
      Deprecated.
      Let doclet check that all options are OK. Returning true means options are OK. If method does not exist, assume true.
    • languageVersion

      public LanguageVersion languageVersion()
      Deprecated.
      Return the language version supported by this doclet. If the method does not exist in the doclet, assume version 1.1.
    • invoke

      private Object invoke(String methodName, Object returnValueIfNonExistent, Class<?>[] paramTypes, Object[] params) throws DocletInvoker.DocletInvokeException
      Deprecated.
      Utility method for calling doclet functionality
      Throws:
      DocletInvoker.DocletInvokeException
    • exportInternalAPI

      private void exportInternalAPI(ClassLoader cl)
      Deprecated.
      Export javadoc internal API to the unnamed module for a classloader. This is to support continued use of existing non-standard doclets that use the internal toolkit API and related classes.
      Parameters:
      cl - the classloader
    • pathToURLs

      private static URL[] pathToURLs(String path)
      Deprecated.
      Utility method for converting a search path string to an array of directory and JAR file URLs. Note that this method is called by the DocletInvoker.
      Parameters:
      path - the search path string
      Returns:
      the resulting array of directory and JAR file URLs
    • fileToURL

      private static URL fileToURL(Path file)
      Deprecated.
      Returns the directory or JAR file URL corresponding to the specified local file name.
      Parameters:
      file - the Path object
      Returns:
      the resulting directory or JAR file URL, or null if unknown