Interface DocumentationTool.DocumentationTask
- Enclosing interface:
- DocumentationTool
public static interface DocumentationTool.DocumentationTask extends Callable<Boolean>
Interface representing a future for a documentation task. The task has not yet started. To start the task, call the call method.
Before calling the call method, additional aspects of the task can be configured, for example, by calling the setLocale method.
Methods
| Modifier and Type | Method and Description |
|---|---|
Boolean |
call() Performs this documentation task. |
void |
setLocale(Locale locale) Set the locale to be applied when formatting diagnostics and other localized data. |
Methods
setLocale
void setLocale(Locale locale)
Set the locale to be applied when formatting diagnostics and other localized data.
- Parameters:
-
locale- the locale to apply;nullmeans apply no locale - Throws:
-
IllegalStateException- if the task has started
call
Boolean call()
Performs this documentation task. The task may only be performed once. Subsequent calls to this method throw IllegalStateException.
- Specified by:
-
callin interfaceCallable<Boolean> - Returns:
- true if and only all the files were processed without errors; false otherwise
- Throws:
-
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, 2020, 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/javase/8/docs/api/javax/tools/DocumentationTool.DocumentationTask.html