OptionChecker, Tool
public interface DocumentationTool extends Tool, OptionChecker
| Modifier and Type | Interface | Description |
|---|---|---|
static interface |
DocumentationTool.DocumentationTask |
Interface representing a future for a documentation task. |
static enum |
DocumentationTool.Location |
Locations specific to DocumentationTool. |
| Modifier and Type | Method | Description |
|---|---|---|
StandardJavaFileManager |
getStandardFileManager |
Returns a new instance of the standard file manager implementation for this tool. |
DocumentationTool.DocumentationTask |
getTask |
Creates a future for a documentation task with the given components and arguments. |
isSupportedOption
getSourceVersions, name, run
DocumentationTool.DocumentationTask getTask(Writer out, JavaFileManager fileManager, DiagnosticListener<? super JavaFileObject> diagnosticListener, Class<?> docletClass, Iterable<String> options, Iterable<? extends JavaFileObject> compilationUnits)
If a file manager is provided, it must be able to handle all locations defined in DocumentationTool.Location, as well as StandardLocation.SOURCE_PATH, StandardLocation.CLASS_PATH, and StandardLocation.PLATFORM_CLASS_PATH.
out - a Writer for additional output from the tool; use System.err if null
fileManager - a file manager; if null use the tool's standard file managerdiagnosticListener - a diagnostic listener; if null use the tool's default method for reporting diagnosticsdocletClass - a class providing the necessary methods required of a doclet; a value of null means to use the standard doclet.options - documentation tool options and doclet options, null means no optionscompilationUnits - the compilation units to compile,
null means no compilation unitsRuntimeException - if an unrecoverable error occurred in a user supplied component. The cause will be the error in user code.IllegalArgumentException - if any of the given compilation units are of other kind than source
StandardJavaFileManager getStandardFileManager(DiagnosticListener<? super JavaFileObject> diagnosticListener, Locale locale, Charset charset)
The standard file manager will be automatically reopened if it is accessed after calls to flush or close. The standard file manager must be usable with other tools.
diagnosticListener - a diagnostic listener for non-fatal diagnostics; if null use the compiler's default method for reporting diagnosticslocale - the locale to apply when formatting diagnostics; null means the default locale.charset - the character set used for decoding bytes; if null use the platform default
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.compiler/javax/tools/DocumentationTool.html