compact3
javax.tools
Interface DocumentationTool.DocumentationTask
-
- Enclosing interface:
- DocumentationTool
public static interface DocumentationTool.DocumentationTask extends Callable<Boolean>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description Booleancall()Performs this documentation task.voidsetLocale(Locale locale)Set the locale to be applied when formatting diagnostics and other localized data.
-
-
-
Method Detail
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
-
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, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
