Modifier and Type	Class and Description
pack-priv static interface	ToolOptions.ShowHelper
pack-priv static class	ToolOptions.ToolOption Base class for all supported tool options.

Field Summary

Modifier and Type	Field and Description
pack-priv static final String	AT
private boolean	breakIterator Argument for command-line option `-breakiterator`.
private final OptionHelper	compilerOptionHelper The "helper" to be used when processing compiler options.
private final Options	compOpts Options to be given to the underlying compiler front-end, such as options to indicate the source level to be used.
pack-priv static final String	DOCLET
pack-priv static final String	DOCLET_PATH
pack-priv static final String	DUMP_ON_ERROR
private boolean	dumpOnError Argument for command-line option `--dump-on-error`.
private List<String>	excludes Argument for command-line option `-exclude`.
private AccessLevel	expandRequires Argument for command-line option `--expand-requires`.
private final Map<Option, String>	fileManagerOpts Options to be given to the file manager, such as path options indicating where to find files to be documented.
private boolean	ignoreSourceErrors Argument for command-line option `--ignore-source-errors`.
pack-priv static final String	J
pack-priv static final String	LOCALE
private final JavadocLog	log The log to be used to report diagnostics..
private List<String>	modules Argument for command-line option `--module`.
private boolean	quiet Argument for command-line option `-quiet`.
private boolean	rejectWarnings Argument for command-line option `-Werror`.
private final ToolOptions.ShowHelper	showHelper The helper for help and version options
private AccessLevel	showMembersAccess Argument for command-line option `--show-members`.
private AccessLevel	showModuleContents Argument for command-line option `--show-module-contents`.
private AccessLevel	showPackagesAccess Argument for command-line option `--show-packages`.
private AccessLevel	showTypesAccess Argument for command-line option `--show-types`.
private List<String>	subpackages Argument for command-line option `-subpackages`.
private List<ToolOptions.ToolOption>	supportedOptions
private boolean	verbose Argument for command-line option `-verbose`.
private boolean	xclasses Argument for command-line option `-Xclasses`.

Constructor Summary

Access	Constructor and Description
pack-priv	ToolOptions(Context the context used to find other tool-related components context, JavadocLog the log to be used to report diagnostics log, ToolOptions.ShowHelper showHelper) Creates an object to handle tool options.
private	ToolOptions() Creates a minimal object, just sufficient to check the names of the supported options.

Method Summary

Modifier and Type	Method and Description
pack-priv boolean	breakIterator() Argument for command-line option `-breakiterator`.
pack-priv Options	Returns: the options compilerOptions() Returns the set of options to be used for the instance of the underlying compiler front-end.
pack-priv boolean	dumpOnError() Argument for command-line option `--dump-on-error`.
pack-priv List<String>	excludes() Argument for command-line option `-exclude`.
pack-priv AccessLevel	expandRequires() Argument for command-line option `--expand-requires`.
pack-priv Map<Option, String>	Returns: the options fileManagerOptions() Returns the set of options to be used for the file manager.
private AccessLevel	getAccessValue(String arg)
pack-priv ToolOptions.ToolOption	Returns: the option getOption(String the argument arg) Returns the option to be used to process an argument such as may be found on the command line.
private OptionHelper	Returns: the helper getOptionHelper() Returns a "helper" to be used when processing compiler options.
public List<ToolOptions.ToolOption>	Returns: the set of options getSupportedOptions() Returns the set of options supported by the tool, excluding any options that are managed by the doclet that may be in use.
pack-priv boolean	ignoreSourceErrors() Argument for command-line option `--ignore-source-errors`.
private IllegalOptionValue	Returns: the exception illegalOptionValue(String the argument to include in the detail message arg) Returns an `IllegalOptionValue` exception.
public static int	Returns: the number of arguments the given option takes or -1 if the option is not supported isSupportedOption(String an option option) Determines if the given option is supported and if so, the number of arguments the option takes.
pack-priv List<String>	modules() Argument for command-line option `--module`.
pack-priv void	processCompilerOption(Option the option object to process the command-line option option, String the command-line option opt) Process a compiler option.
private void	processCompilerOption(Option the option object to process the command-line option option, String the command-line option opt, String the argument for the command-line option arg) Process a compiler option.
pack-priv boolean	quiet() Argument for command-line option `-quiet`.
pack-priv boolean	rejectWarnings() Argument for command-line option `-Werror`.
private void	setAccess(AccessLevel accessValue)
private void	setAccessDefault()
pack-priv void	setDumpOnError(boolean v)
private void	setExpandRequires(String arg)
private void	setShowMembersAccess(String arg)
private void	setShowModuleContents(String arg)
private void	setShowPackageAccess(String arg)
private void	setShowTypesAccess(String arg)
private void	setSimpleAccessOption(String arg)
private void	setSimpleFilter(String arg)
private void	setVerbose()
pack-priv AccessLevel	showMembersAccess() Argument for command-line option `--show-members`.
pack-priv AccessLevel	showModuleContents() Argument for command-line option `--show-module-contents`.
pack-priv AccessLevel	showPackagesAccess() Argument for command-line option `--show-packages`.
pack-priv AccessLevel	showTypesAccess() Argument for command-line option `--show-types`.
pack-priv List<String>	subpackages() Argument for command-line option `-subpackages`.
pack-priv boolean	verbose() Argument for command-line option `-verbose`.
pack-priv boolean	xclasses() Argument for command-line option `-Xclasses`.

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

Field Detail

AT	back to summary
pack-priv static final String AT

breakIterator	back to summary
private boolean breakIterator Argument for command-line option `-breakiterator`.

compilerOptionHelper	back to summary
private final OptionHelper compilerOptionHelper The "helper" to be used when processing compiler options.

compOpts	back to summary
private final Options compOpts Options to be given to the underlying compiler front-end, such as options to indicate the source level to be used.

DOCLET	back to summary
pack-priv static final String DOCLET

DOCLET_PATH	back to summary
pack-priv static final String DOCLET_PATH

DUMP_ON_ERROR	back to summary
pack-priv static final String DUMP_ON_ERROR

dumpOnError	back to summary
private boolean dumpOnError Argument for command-line option `--dump-on-error`. Dump stack traces for debugging etc. Similar to javac `-doe`.

excludes	back to summary
private List<String> excludes Argument for command-line option `-exclude`.

expandRequires	back to summary
private AccessLevel expandRequires Argument for command-line option `--expand-requires`.

fileManagerOpts	back to summary
private final Map<Option, String> fileManagerOpts Options to be given to the file manager, such as path options indicating where to find files to be documented.

ignoreSourceErrors	back to summary
private boolean ignoreSourceErrors Argument for command-line option `--ignore-source-errors`.

J	back to summary
pack-priv static final String J

LOCALE	back to summary
pack-priv static final String LOCALE

log	back to summary
private final JavadocLog log The log to be used to report diagnostics..

modules	back to summary
private List<String> modules Argument for command-line option `--module`.

quiet	back to summary
private boolean quiet Argument for command-line option `-quiet`.

rejectWarnings	back to summary
private boolean rejectWarnings Argument for command-line option `-Werror`. Set by -Werror.

showHelper	back to summary
private final ToolOptions.ShowHelper showHelper The helper for help and version options

showMembersAccess	back to summary
private AccessLevel showMembersAccess Argument for command-line option `--show-members`.

showModuleContents	back to summary
private AccessLevel showModuleContents Argument for command-line option `--show-module-contents`.

showPackagesAccess	back to summary
private AccessLevel showPackagesAccess Argument for command-line option `--show-packages`.

showTypesAccess	back to summary
private AccessLevel showTypesAccess Argument for command-line option `--show-types`.

subpackages	back to summary
private List<String> subpackages Argument for command-line option `-subpackages`.

supportedOptions	back to summary
private List<ToolOptions.ToolOption> supportedOptions

verbose	back to summary
private boolean verbose Argument for command-line option `-verbose`.

xclasses	back to summary
private boolean xclasses Argument for command-line option `-Xclasses`. If true, names on the command line that would normally be treated as package names are treated as class names instead.

Constructor Detail

ToolOptions	back to summary
pack-priv ToolOptions(Context context, JavadocLog log, ToolOptions.ShowHelper showHelper) Creates an object to handle tool options. Parameters context:Context the context used to find other tool-related components log:JavadocLog the log to be used to report diagnostics

ToolOptions

back to summary

pack-priv ToolOptions(Context context, JavadocLog log, ToolOptions.ShowHelper showHelper)

Creates an object to handle tool options.

Parameters

context:Context: the context used to find other tool-related components
log:JavadocLog: the log to be used to report diagnostics

ToolOptions	back to summary
private ToolOptions() Creates a minimal object, just sufficient to check the names of the supported options.

Method Detail

breakIterator	back to summary
pack-priv boolean breakIterator() Argument for command-line option `-breakiterator`.

compilerOptions	back to summary
pack-priv Options compilerOptions() Returns the set of options to be used for the instance of the underlying compiler front-end. Returns:Options the options

compilerOptions

back to summary

pack-priv Options compilerOptions()

Returns the set of options to be used for the instance of the underlying compiler front-end.

Returns:Options: the options

dumpOnError	back to summary
pack-priv boolean dumpOnError() Argument for command-line option `--dump-on-error`. Dump stack traces for debugging etc. Similar to javac `-doe`.

excludes	back to summary
pack-priv List<String> excludes() Argument for command-line option `-exclude`.

expandRequires	back to summary
pack-priv AccessLevel expandRequires() Argument for command-line option `--expand-requires`.

fileManagerOptions	back to summary
pack-priv Map<Option, String> fileManagerOptions() Returns the set of options to be used for the file manager. Returns:Map<Option, String> the options

fileManagerOptions

back to summary

pack-priv Map<Option, String> fileManagerOptions()

Returns the set of options to be used for the file manager.

Returns:Map<Option, String>: the options

getAccessValue	back to summary
private AccessLevel getAccessValue(String arg) throws OptionException

getOption	back to summary
pack-priv ToolOptions.ToolOption getOption(String arg) Returns the option to be used to process an argument such as may be found on the command line. Parameters arg:String the argument Returns:ToolOptions.ToolOption the option

getOption

back to summary

pack-priv ToolOptions.ToolOption getOption(String arg)

Returns the option to be used to process an argument such as may be found on the command line.

Parameters

arg:String: the argument

Returns:ToolOptions.ToolOption

the option

getOptionHelper	back to summary
private OptionHelper getOptionHelper() Returns a "helper" to be used when processing compiler options. Returns:OptionHelper the helper

getOptionHelper

back to summary

private OptionHelper getOptionHelper()

Returns a "helper" to be used when processing compiler options.

Returns:OptionHelper: the helper

getSupportedOptions	back to summary
public List<ToolOptions.ToolOption> getSupportedOptions() Returns the set of options supported by the tool, excluding any options that are managed by the doclet that may be in use. Returns:List<ToolOptions.ToolOption> the set of options

getSupportedOptions

back to summary

public List<ToolOptions.ToolOption> getSupportedOptions()

Returns the set of options supported by the tool, excluding any options that are managed by the doclet that may be in use.

Returns:List<ToolOptions.ToolOption>: the set of options

ignoreSourceErrors	back to summary
pack-priv boolean ignoreSourceErrors() Argument for command-line option `--ignore-source-errors`.

illegalOptionValue back to summary

illegalOptionValue	back to summary
private IllegalOptionValue illegalOptionValue(String arg) Returns an `IllegalOptionValue` exception. Parameters arg:String the argument to include in the detail message Returns:IllegalOptionValue the exception

private IllegalOptionValue illegalOptionValue(String arg)

Returns an IllegalOptionValue exception.

Parameters

arg:String: the argument to include in the detail message

Returns:IllegalOptionValue

the exception

isSupportedOption back to summary

isSupportedOption	back to summary
public static int isSupportedOption(String option) Determines if the given option is supported and if so, the number of arguments the option takes. Parameters option:String an option Returns:int the number of arguments the given option takes or -1 if the option is not supported See Also `javax.tools.DocumentationTool#isSupportedOption(String)`

public static int isSupportedOption(String option)

Determines if the given option is supported and if so, the number of arguments the option takes.

Parameters

option:String: an option

Returns:int

the number of arguments the given option takes or -1 if the option is not supported

modules	back to summary
pack-priv List<String> modules() Argument for command-line option `--module`.

processCompilerOption	back to summary
pack-priv void processCompilerOption(Option option, String opt) throws InvalidValueException Process a compiler option. Parameters option:Option the option object to process the command-line option opt:String the command-line option Exceptions InvalidValueException: if the command-line option is invalid

processCompilerOption

back to summary

pack-priv void processCompilerOption(Option option, String opt) throws InvalidValueException

Process a compiler option.

Parameters

option:Option: the option object to process the command-line option
opt:String: the command-line option

Exceptions

InvalidValueException:: if the command-line option is invalid

processCompilerOption	back to summary
private void processCompilerOption(Option option, String opt, String arg) throws InvalidValueException Process a compiler option. Parameters option:Option the option object to process the command-line option opt:String the command-line option arg:String the argument for the command-line option Exceptions InvalidValueException: if the command-line option is invalid

processCompilerOption

back to summary

private void processCompilerOption(Option option, String opt, String arg) throws InvalidValueException

Process a compiler option.

Parameters

option:Option: the option object to process the command-line option
opt:String: the command-line option
arg:String: the argument for the command-line option

Exceptions

InvalidValueException:: if the command-line option is invalid

quiet	back to summary
pack-priv boolean quiet() Argument for command-line option `-quiet`.

rejectWarnings	back to summary
pack-priv boolean rejectWarnings() Argument for command-line option `-Werror`. Set by -Werror.

setAccess	back to summary
private void setAccess(AccessLevel accessValue)

setAccessDefault	back to summary
private void setAccessDefault()

setDumpOnError	back to summary
pack-priv void setDumpOnError(boolean v)

setExpandRequires	back to summary
private void setExpandRequires(String arg) throws OptionException

setShowMembersAccess	back to summary
private void setShowMembersAccess(String arg) throws OptionException

setShowModuleContents	back to summary
private void setShowModuleContents(String arg) throws OptionException

setShowPackageAccess	back to summary
private void setShowPackageAccess(String arg) throws OptionException

setShowTypesAccess	back to summary
private void setShowTypesAccess(String arg) throws OptionException

setSimpleAccessOption	back to summary
private void setSimpleAccessOption(String arg) throws OptionException

setSimpleFilter	back to summary
private void setSimpleFilter(String arg) throws OptionException

setVerbose	back to summary
private void setVerbose()

showMembersAccess	back to summary
pack-priv AccessLevel showMembersAccess() Argument for command-line option `--show-members`.

showModuleContents	back to summary
pack-priv AccessLevel showModuleContents() Argument for command-line option `--show-module-contents`.

showPackagesAccess	back to summary
pack-priv AccessLevel showPackagesAccess() Argument for command-line option `--show-packages`.

showTypesAccess	back to summary
pack-priv AccessLevel showTypesAccess() Argument for command-line option `--show-types`.

subpackages	back to summary
pack-priv List<String> subpackages() Argument for command-line option `-subpackages`.

verbose	back to summary
pack-priv boolean verbose() Argument for command-line option `-verbose`.

xclasses	back to summary
pack-priv boolean xclasses() Argument for command-line option `-Xclasses`. If true, names on the command line that would normally be treated as package names are treated as class names instead.

jdk.javadoc.internal.tool back to summary

pack-priv Interface ToolOptions.ShowHelper

Method Summary

Modifier and Type	Method and Description
public void	fullVersion() Show the full version information, as requested by the `--full-version` option.
public void	usage() Show command-line help for the standard options, as requested by the `--help` option and its aliases.
public void	version() Show the basic version information, as requested by the `--version` option.
public void	Xusage() Show command-line help for the extended options, as requested by the `--help-extra` option and its aliases.

Method Detail

fullVersion	back to summary
public void fullVersion() Show the full version information, as requested by the `--full-version` option.

usage	back to summary
public void usage() Show command-line help for the standard options, as requested by the `--help` option and its aliases.

version	back to summary
public void version() Show the basic version information, as requested by the `--version` option.

Xusage	back to summary
public void Xusage() Show command-line help for the extended options, as requested by the `--help-extra` option and its aliases.

jdk.javadoc.internal.tool back to summary

pack-priv Class ToolOptions.ToolOption

Class Inheritance

extends Object

java.lang.Object
jdk.javadoc.internal.tool.ToolOptions.ToolOption

Base class for all supported tool options.

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv static enum	ToolOptions.ToolOption.Kind

Field Summary

Modifier and Type	Field and Description
pack-priv final boolean	hasArg
pack-priv final boolean	hasSuffix
pack-priv final ToolOptions.ToolOption.Kind	kind
pack-priv final List<String>	names
pack-priv final String	primaryName

Constructor Summary

Access	Constructor and Description
pack-priv	ToolOption(String opt, ToolOptions.ToolOption.Kind kind)
pack-priv	ToolOption(String names, ToolOptions.ToolOption.Kind kind, boolean hasArg)

Method Summary

Modifier and Type	Method and Description
pack-priv String	getDescription(JavadocLog log)
private String	getKey(String optionName, String suffix)
pack-priv List<String>	getNames()
pack-priv String	getParameters(JavadocLog log)
pack-priv void	process(String arg)
pack-priv void	process()

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

Field Detail

hasArg	back to summary
pack-priv final boolean hasArg

hasSuffix	back to summary
pack-priv final boolean hasSuffix

kind	back to summary
pack-priv final ToolOptions.ToolOption.Kind kind

names	back to summary
pack-priv final List<String> names

primaryName	back to summary
pack-priv final String primaryName

Constructor Detail

ToolOption	back to summary
pack-priv ToolOption(String opt, ToolOptions.ToolOption.Kind kind)

ToolOption	back to summary
pack-priv ToolOption(String names, ToolOptions.ToolOption.Kind kind, boolean hasArg)

Method Detail

getDescription	back to summary
pack-priv String getDescription(JavadocLog log)

getKey	back to summary
private String getKey(String optionName, String suffix)

getNames	back to summary
pack-priv List<String> getNames()

getParameters	back to summary
pack-priv String getParameters(JavadocLog log)

process	back to summary
pack-priv void process(String arg) throws OptionException, InvalidValueException

process	back to summary
pack-priv void process() throws OptionException, InvalidValueException

jdk.javadoc.internal.tool back to summary

pack-priv final Enum ToolOptions.ToolOption.Kind

Class Inheritance

extends Enum<ToolOptions.ToolOption.Kind>

java.lang.Object
java.lang.Enum
jdk.javadoc.internal.tool.ToolOptions.ToolOption.Kind

Field Summary

Modifier and Type	Field and Description
public static final ToolOptions.ToolOption.Kind	EXTENDED
public static final ToolOptions.ToolOption.Kind	HIDDEN
public static final ToolOptions.ToolOption.Kind	STANDARD

Constructor Summary

Access	Constructor and Description
private	Kind()

Method Summary

Modifier and Type	Method and Description
public static ToolOptions.ToolOption.Kind	valueOf(String name)
public static ToolOptions.ToolOption.Kind[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

EXTENDED	back to summary
public static final ToolOptions.ToolOption.Kind EXTENDED

HIDDEN	back to summary
public static final ToolOptions.ToolOption.Kind HIDDEN

STANDARD	back to summary
public static final ToolOptions.ToolOption.Kind STANDARD

Constructor Detail

Kind	back to summary
private Kind()

Method Detail

valueOf	back to summary
public static ToolOptions.ToolOption.Kind valueOf(String name)

values	back to summary
public static ToolOptions.ToolOption.Kind[] values()

public Class ToolOptions

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Interface ToolOptions.ShowHelper

Method Summary

Method Detail

pack-priv Class ToolOptions.ToolOption

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum ToolOptions.ToolOption.Kind

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail