DocumentationTool.DocumentationTask (Java Platform SE 8 ) (original) (raw)

• All Superinterfaces:
  Callable<Boolean>
  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 thesetLocale method.

• • Method Summary

  All Methods Instance Methods Abstract Methods

  Modifier and Type	Method	Description
  Boolean	call()	Performs this documentation task.
  void	setLocale(Locale locale)	Set the locale to be applied when formatting diagnostics and other localized data.

• • Method Detail

     * #### setLocale  
     void setLocale([Locale](../../java/util/Locale.html "class in java.util") locale)  
     Set 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](../../java/lang/IllegalStateException.html "class in java.lang")` \- if the task has started  
     * #### call  
     [Boolean](../../java/lang/Boolean.html "class in java.lang") call()  
     Performs this documentation task. The task may only be performed once. Subsequent calls to this method throw IllegalStateException.  
     Specified by:  
     `[call](../../java/util/concurrent/Callable.html#call--)` in interface `[Callable](../../java/util/concurrent/Callable.html "interface in java.util.concurrent")<[Boolean](../../java/lang/Boolean.html "class in java.lang")>`  
     Returns:  
     true if and only all the files were processed without errors; false otherwise  
     Throws:  
     `[RuntimeException](../../java/lang/RuntimeException.html "class in java.lang")` \- if an unrecoverable error occurred in a user-supplied component. The[cause](../../java/lang/Throwable.html#getCause--) will be the error in user code.  
     `[IllegalStateException](../../java/lang/IllegalStateException.html "class in java.lang")` \- 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, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.