Contents
Interface DocumentationTool.DocumentationTask
- Enclosing interface:
DocumentationTool
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addModules
(Iterable<String> moduleNames) Adds root modules to be taken into account during module resolution.call()
Performs this documentation task.void
Sets the locale to be applied when formatting diagnostics and other localized data.
-
Method Details
-
addModules
Adds root modules to be taken into account during module resolution. Invalid module names may cause eitherIllegalArgumentException
to be thrown, or diagnostics to be reported when the task is started.- Parameters:
moduleNames
- the names of the root modules- Throws:
IllegalArgumentException
- may be thrown for some invalid module namesIllegalStateException
- if the task has started- Since:
- 9
-
setLocale
Sets the locale to be applied when formatting diagnostics and other localized data.- Parameters:
locale
- the locale to apply;null
means 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 throwIllegalStateException
.- Specified by:
call
in 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
-