DocumentationTool
public static interface DocumentationTool.DocumentationTask extends Callable<Boolean>
Modifier and Type | Method | Description |
---|---|---|
void |
addModules |
Adds root modules to be taken into account during module resolution. |
Boolean |
call() |
Performs this documentation task. |
void |
setLocale |
Sets the locale to be applied when formatting diagnostics and other localized data. |
void addModules(Iterable<String> moduleNames)
IllegalArgumentException
to be thrown, or diagnostics to be reported when the task is started.moduleNames
- the names of the root modulesIllegalArgumentException
- may be thrown for some invalid module namesIllegalStateException
- if the task has startedvoid setLocale(Locale locale)
locale
- the locale to apply; null
means apply no localeIllegalStateException
- if the task has startedBoolean call()
IllegalStateException
.call
in interface Callable<Boolean>
RuntimeException
- if an unrecoverable error occurred in a user-supplied component. The cause will be the error in user code.IllegalStateException
- if called more than once
© 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.DocumentationTask.html