Package gw.gosudoc.com.sun.tools.javadoc.main

Class DocletInvoker

java.lang.Object

gw.gosudoc.com.sun.tools.javadoc.main.DocletInvoker

@Deprecated
public class DocletInvoker
extends java.lang.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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	DocletInvoker.DocletInvokeException	Deprecated.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	apiMode	Deprecated. In API mode, exceptions thrown while calling the doclet are propagated using ClientCodeException.
private java.lang.ClassLoader	appClassLoader	Deprecated.
private java.lang.Class<?>	docletClass	Deprecated.
private java.lang.String	docletClassName	Deprecated.
private boolean	exportInternalAPI	Deprecated. Whether javadoc internal API should be exported to doclets and (indirectly) to taglets
private Messager	messager	Deprecated.

Constructor Summary

Constructors

Constructor	Description
DocletInvoker(Messager messager, java.lang.Class<?> docletClass, boolean apiMode, boolean exportInternalAPI)	Deprecated.
DocletInvoker(Messager messager, javax.tools.JavaFileManager fileManager, java.lang.String docletClassName, java.lang.String docletPath, java.lang.ClassLoader docletParentClassLoader, boolean apiMode, boolean exportInternalAPI)	Deprecated.

Method Summary

Modifier and Type	Method	Description
private java.lang.String	appendPath(java.lang.String path1, java.lang.String path2)	Deprecated.
private void	exportInternalAPI(java.lang.ClassLoader cl)	Deprecated. Export javadoc internal API to the unnamed module for a classloader.
private static java.net.URL	fileToURL(java.nio.file.Path file)	Deprecated. Returns the directory or JAR file URL corresponding to the specified local file name.
private java.lang.ClassLoader	getDelegationClassLoader(java.lang.String docletClassName)	Deprecated.
private java.lang.Object	invoke(java.lang.String methodName, java.lang.Object returnValueIfNonExistent, java.lang.Class<?>[] paramTypes, java.lang.Object[] params)	Deprecated. Utility method for calling doclet functionality
LanguageVersion	languageVersion()	Deprecated. Return the language version supported by this doclet.
int	optionLength(java.lang.String option)	Deprecated. Check for doclet added options here.
private static java.net.URL[]	pathToURLs(java.lang.String path)	Deprecated. Utility method for converting a search path string to an array of directory and JAR file URLs.
boolean	start(RootDoc root)	Deprecated. Generate documentation here.
boolean	validOptions(com.sun.tools.javac.util.List<java.lang.String[]> optlist)	Deprecated. Let doclet check that all options are OK.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

docletClass

private final java.lang.Class<?> docletClass

Deprecated.

docletClassName

private final java.lang.String docletClassName

Deprecated.

appClassLoader

private final java.lang.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 Detail

DocletInvoker

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

Deprecated.

DocletInvoker

public DocletInvoker(Messager messager,
                     javax.tools.JavaFileManager fileManager,
                     java.lang.String docletClassName,
                     java.lang.String docletPath,
                     java.lang.ClassLoader docletParentClassLoader,
                     boolean apiMode,
                     boolean exportInternalAPI)

Deprecated.

Method Detail

appendPath

private java.lang.String appendPath(java.lang.String path1,
                                    java.lang.String path2)

Deprecated.

getDelegationClassLoader

private java.lang.ClassLoader getDelegationClassLoader(java.lang.String docletClassName)

Deprecated.

start

public boolean start(RootDoc root)

Deprecated.

Generate documentation here. Return true on success.

optionLength

public int optionLength(java.lang.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<java.lang.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 java.lang.Object invoke(java.lang.String methodName,
                                java.lang.Object returnValueIfNonExistent,
                                java.lang.Class<?>[] paramTypes,
                                java.lang.Object[] params)
                         throws DocletInvoker.DocletInvokeException

Deprecated.

Utility method for calling doclet functionality

Throws:

DocletInvoker.DocletInvokeException

exportInternalAPI

private void exportInternalAPI(java.lang.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 java.net.URL[] pathToURLs(java.lang.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 java.net.URL fileToURL(java.nio.file.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