All Superinterfaces:

Callable<Boolean>

Enclosing interface:

DocumentationTool

public static interface DocumentationTool.DocumentationTask
extends Callable<Boolean>

• Method Summary

  All 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 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 - 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:

    call in 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