- 
- Enclosing interface:
- DocumentationTool
 
 public static interface DocumentationTool.DocumentationTask extends Callable<Boolean> 
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddModules(Iterable<String> moduleNames)Adds root modules to be taken into account during module resolution.Booleancall()Performs this documentation task.voidsetLocale(Locale locale)Sets the locale to be applied when formatting diagnostics and other localized data.
 
- 
- 
- 
Method Detail- 
addModulesvoid addModules(Iterable<String> moduleNames) Adds root modules to be taken into account during module resolution. Invalid module names may cause eitherIllegalArgumentExceptionto 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 names
- IllegalStateException- if the task has started
- Since:
- 9
 
 - 
setLocalevoid setLocale(Locale locale) Sets 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
 
 - 
callBoolean call() Performs this documentation task. The task may only be performed once. Subsequent calls to this method throw IllegalStateException.- Specified by:
- callin interface- Callable<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
 
 
- 
 
-