Package Summary Overview Summary |
public interface DocumentationTool extends Tool, OptionChecker
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 . |
Modifier and Type | Method and Description |
---|---|
StandardJavaFileManager | getStandardFileManager(DiagnosticListener<? super JavaFileObject> diagnosticListener, Locale locale, Charset charset)
Gets a new instance of the standard file manager implementation for this tool.
|
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.
|
getSourceVersions, run
isSupportedOption
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 filemanager diagnosticListener
- a diagnostic listener; if null
use the tool's default method for reporting diagnostics docletClass
- a class providing the necessary methods required of a doclet options
- documentation tool options and doclet options, null
means no options compilationUnits
- the compilation units to compile, null
means no compilation units RuntimeException
- 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 diagnostics locale
- 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
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation . That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.
DRAFT ea-b110