OpenJDK 27 · jdk.javadoc.internal.tool.Start · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
private boolean	apiMode In API mode, exceptions thrown while calling the doclet are propagated using ClientCodeException.
private final ClassLoader	classLoader
private static final String	COMPACT_FORMAT The format for a single-line help entry.
private final Context	context Context for this invocation.
private static final int	DEFAULT_MAX_LINE_LENGTH The nominal maximum line length, when seeing if text will fit on a line.
private static final int	DEFAULT_SYNOPSIS_WIDTH The space allowed for the synopsis, if the description is to be shown on the same line.
private Doclet	doclet
private Class<?>	docletClass
private final String	docletName
private Set<? extends Doclet.Option>	docletOptions
private JavaFileManager	fileManager
private static final String	LARGE_INDENT The automatic indent for the description.
private Locale	locale
private JavadocLog	log
private final ToolOptions	options
private static final String	ProgramName
private static final String	SMALL_INDENT The indent for the option synopsis.

Constructor Summary

Access	Constructor and Description
pack-priv	Start()
pack-priv	Start(PrintWriter outWriter, PrintWriter errWriter)
pack-priv	Start(Context context, String programName, PrintWriter outWriter, PrintWriter errWriter, String docletName, ClassLoader classLoader)
public	Start(Context context)

Method Summary

Modifier and Type	Method and Description
pack-priv Main.Result	begin(String... argv) Main program - external wrapper.
public boolean	begin(Class<?> docletClass, Iterable<String> options, Iterable<? extends JavaFileObject> fileObjects)
private Main.Result	begin(List<String> options, Iterable<? extends JavaFileObject> fileObjects)
private void	checkOneArg(List<String> args, int index) Check the one arg option.
pack-priv int	consumeDocletOption(int idx, List<String> args, boolean isToolOption)
private void	dumpStack(Throwable t)
private void	dumpStack(boolean enabled, Throwable t)
pack-priv void	error(String key, Object... args)
private Locale	getLocale(String localeName) Get the locale if specified on the command line else return null and if locale option is not used then return default locale.
private static Set<? extends Doclet.Option>	getSupportedOptionsOf(Doclet doclet)
private ToolOptions	getToolOptions()
private <T> boolean	isEmpty(Iterable<T> iter)
private Class<?>	loadDocletClass(String docletName, ClassLoader classLoader)
pack-priv boolean	matches(List<String> names, String arg)
pack-priv boolean	matches(Doclet.Option option, String arg)
private Main.Result	parseAndExecute(List<String> argList, Iterable<? extends JavaFileObject> fileObjects) Main program - internal
private boolean	parseArgs(List<String> args, List<String> javaNames)
private Doclet	Returns: the doclet preprocess(List<String> the arguments to be processed argv) Performs an initial pass over the options, primarily to determine the doclet to be used (if any), so that it may participate in the main round of option decoding.
private void	reportBadOption(String name)
private void	reportInternalError(Throwable t)
private void	showDocletOption(Doclet.Option option)
private void	showDocletOptions(Doclet.Option.Kind kind)
private void	showLines(String message)
private void	showLinesUsingKey(String key, Object... args)
pack-priv void	showOption(List<String> names, String parameters, String description)
private void	showToolOption(ToolOptions.ToolOption option)
private void	showToolOptions(ToolOptions.ToolOption.Kind kind)
private void	showUsage()
private void	showUsage(String headerKey, ToolOptions.ToolOption.Kind kind, String footerKey)
private void	showVersion(String labelKey, String value)
private static double	similarity(String a, String b)
private Runtime.Version	toolVersion()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

apiMode	back to summary
private boolean apiMode In API mode, exceptions thrown while calling the doclet are propagated using ClientCodeException.

classLoader	back to summary
private final ClassLoader classLoader

COMPACT_FORMAT	back to summary
private static final String COMPACT_FORMAT The format for a single-line help entry.

context	back to summary
private final Context context Context for this invocation.

DEFAULT_MAX_LINE_LENGTH	back to summary
private static final int DEFAULT_MAX_LINE_LENGTH The nominal maximum line length, when seeing if text will fit on a line.

DEFAULT_SYNOPSIS_WIDTH	back to summary
private static final int DEFAULT_SYNOPSIS_WIDTH The space allowed for the synopsis, if the description is to be shown on the same line.

doclet	back to summary
private Doclet doclet

docletClass	back to summary
private Class<?> docletClass

docletName	back to summary
private final String docletName

docletOptions	back to summary
private Set<? extends Doclet.Option> docletOptions

fileManager	back to summary
private JavaFileManager fileManager

LARGE_INDENT	back to summary
private static final String LARGE_INDENT The automatic indent for the description.

locale	back to summary
private Locale locale

log	back to summary
private JavadocLog log

options	back to summary
private final ToolOptions options

ProgramName	back to summary
private static final String ProgramName

SMALL_INDENT	back to summary
private static final String SMALL_INDENT The indent for the option synopsis.

Constructor Detail

Start	back to summary
pack-priv Start()

Start	back to summary
pack-priv Start(PrintWriter outWriter, PrintWriter errWriter)

Start	back to summary
pack-priv Start(Context context, String programName, PrintWriter outWriter, PrintWriter errWriter, String docletName, ClassLoader classLoader)

Start	back to summary
public Start(Context context)

Method Detail

begin	back to summary
pack-priv Main.Result begin(String... argv) Main program - external wrapper.

begin	back to summary
public boolean begin(Class<?> docletClass, Iterable<String> options, Iterable<? extends JavaFileObject> fileObjects)

begin	back to summary
private Main.Result begin(List<String> options, Iterable<? extends JavaFileObject> fileObjects)

checkOneArg	back to summary
private void checkOneArg(List<String> args, int index) throws OptionException Check the one arg option. Error and exit if one argument is not provided.

consumeDocletOption	back to summary
pack-priv int consumeDocletOption(int idx, List<String> args, boolean isToolOption) throws OptionException

dumpStack	back to summary
private void dumpStack(Throwable t)

dumpStack	back to summary
private void dumpStack(boolean enabled, Throwable t)

error	back to summary
pack-priv void error(String key, Object... args)

getLocale	back to summary
private Locale getLocale(String localeName) throws ToolException Get the locale if specified on the command line else return null and if locale option is not used then return default locale.

getSupportedOptionsOf	back to summary
private static Set<? extends Doclet.Option> getSupportedOptionsOf(Doclet doclet)

getToolOptions	back to summary
private ToolOptions getToolOptions()

isEmpty	back to summary
private <T> boolean isEmpty(Iterable<T> iter)

loadDocletClass	back to summary
private Class<?> loadDocletClass(String docletName, ClassLoader classLoader) throws ToolException

matches	back to summary
pack-priv boolean matches(List<String> names, String arg)

matches	back to summary
pack-priv boolean matches(Doclet.Option option, String arg)

parseAndExecute	back to summary
private Main.Result parseAndExecute(List<String> argList, Iterable<? extends JavaFileObject> fileObjects) throws ToolException, OptionException, InvalidValueException Main program - internal

parseArgs	back to summary
private boolean parseArgs(List<String> args, List<String> javaNames) throws OptionException, InvalidValueException

preprocess	back to summary
private Doclet preprocess(List<String> argv) throws ToolException, OptionException Performs an initial pass over the options, primarily to determine the doclet to be used (if any), so that it may participate in the main round of option decoding. This avoids having to specify that the options to specify the doclet should appear before any options that are handled by the doclet. The downside of this initial phase is that we have to skip over unknown options, and assume that we can reliably detect the options we need to handle. Parameters argv:List<String> the arguments to be processed Returns:Doclet the doclet Exceptions ToolException: if an error occurs initializing the doclet OptionException: if an error occurs while processing an option

preprocess

back to summary

private Doclet preprocess(List<String> argv) throws ToolException, OptionException

Performs an initial pass over the options, primarily to determine the doclet to be used (if any), so that it may participate in the main round of option decoding. This avoids having to specify that the options to specify the doclet should appear before any options that are handled by the doclet. The downside of this initial phase is that we have to skip over unknown options, and assume that we can reliably detect the options we need to handle.

Parameters

argv:List<String>: the arguments to be processed

Returns:Doclet

the doclet

Exceptions

ToolException:: if an error occurs initializing the doclet
OptionException:: if an error occurs while processing an option

reportBadOption	back to summary
private void reportBadOption(String name)

reportInternalError	back to summary
private void reportInternalError(Throwable t)

showDocletOption	back to summary
private void showDocletOption(Doclet.Option option)

showDocletOptions	back to summary
private void showDocletOptions(Doclet.Option.Kind kind)

showLines	back to summary
private void showLines(String message)

showLinesUsingKey	back to summary
private void showLinesUsingKey(String key, Object... args)

showOption	back to summary
pack-priv void showOption(List<String> names, String parameters, String description)

showToolOption	back to summary
private void showToolOption(ToolOptions.ToolOption option)

showToolOptions	back to summary
private void showToolOptions(ToolOptions.ToolOption.Kind kind)

showUsage	back to summary
private void showUsage()

showUsage	back to summary
private void showUsage(String headerKey, ToolOptions.ToolOption.Kind kind, String footerKey)

showVersion	back to summary
private void showVersion(String labelKey, String value)

similarity	back to summary
private static double similarity(String a, String b)