public interface DocumentationTool extends Tool, OptionChecker
Interface to invoke Java™ programming language documentation tools from programs.
Modifier and Type | Interface and Description |
---|---|
static interface |
DocumentationTool.DocumentationTask Interface representing a future for a documentation task. |
static class |
DocumentationTool.Location Locations specific to |
DocumentationTool.DocumentationTask getTask(Writer out, JavaFileManager fileManager, DiagnosticListener<? super JavaFileObject> diagnosticListener, Class<?> docletClass, Iterable<String> options, Iterable<? extends JavaFileObject> compilationUnits)
Creates a future for a documentation task with the given components and arguments. The task might not have completed as described in the DocumentationTask interface.
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 filemanagerdiagnosticListener
- a diagnostic listener; if null
use the tool's default method for reporting diagnosticsdocletClass
- a class providing the necessary methods required of a docletoptions
- 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)
Gets a new instance of the standard file manager implementation for this tool. The file manager will use the given diagnostic listener for producing any non-fatal diagnostics. Fatal errors will be signaled with the appropriate exceptions.
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–2017, 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.