APIdia Launch Partner
Top Description Fields Constructors Methods
jdk.javadoc.internal.api

public Class JavadocTaskImpl

extends Object
implements DocumentationTask
Class Inheritance
All Implemented Interfaces
javax.tools.DocumentationTool.DocumentationTask, java.util.concurrent.Callable
Imports
java.util.ArrayList, .List, .Locale, .Set, java.util.concurrent.atomic.AtomicBoolean, javax.tools.DocumentationTool.DocumentationTask, .JavaFileObject, com.sun.tools.javac.main.Option, com.sun.tools.javac.util.ClientCodeException, .Context, .Options, jdk.javadoc.internal.tool.Start
Provides access to functionality specific to the JDK documentation tool, javadoc.

Field Summary

Modifier and TypeField and Description
private final List<String>
addModules

private final Context
context

private final Class<?>
docletClass

private final Iterable<? extends JavaFileObject>
fileObjects

private Locale
locale

private final Iterable<String>
options

private final AtomicBoolean
used

Constructor Summary

AccessConstructor and Description
public
JavadocTaskImpl(Context context, Class<?> docletClass, Iterable<String> options, Iterable<? extends JavaFileObject> fileObjects)

Method Summary

Modifier and TypeMethod and Description
public void
addModules(Iterable<String> moduleNames)

Implements javax.tools.DocumentationTool.DocumentationTask.addModules.

Adds root modules to be taken into account during module resolution.

public Boolean
call()

Implements javax.tools.DocumentationTool.DocumentationTask.call.

Performs this documentation task.

private void
initContext()

private static <T> Iterable<T>
nullCheck(Iterable<T> items)

public void
setLocale(Locale locale)

Implements javax.tools.DocumentationTool.DocumentationTask.setLocale.

Sets the locale to be applied when formatting diagnostics and other localized data.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

addModulesback to summary
private final List<String> addModules
contextback to summary
private final Context context
docletClassback to summary
private final Class<?> docletClass
fileObjectsback to summary
private final Iterable<? extends JavaFileObject> fileObjects
localeback to summary
private Locale locale
optionsback to summary
private final Iterable<String> options
usedback to summary
private final AtomicBoolean used

Constructor Detail

JavadocTaskImplback to summary
public JavadocTaskImpl(Context context, Class<?> docletClass, Iterable<String> options, Iterable<? extends JavaFileObject> fileObjects)

Method Detail

addModulesback to summary
public void addModules(Iterable<String> moduleNames)

Implements javax.tools.DocumentationTool.DocumentationTask.addModules.

Doc from javax.tools.DocumentationTool.DocumentationTask.addModules.

Adds root modules to be taken into account during module resolution. Invalid module names may cause either IllegalArgumentException to be thrown, or diagnostics to be reported when the task is started.

Annotations
@Override
callback to summary
public Boolean call()

Implements javax.tools.DocumentationTool.DocumentationTask.call.

Doc from javax.tools.DocumentationTool.DocumentationTask.call.

Performs this documentation task. The task may only be performed once. Subsequent calls to this method throw IllegalStateException.

Annotations
@Override
initContextback to summary
private void initContext()
nullCheckback to summary
private static <T> Iterable<T> nullCheck(Iterable<T> items)
setLocaleback to summary
public void setLocale(Locale locale)

Implements javax.tools.DocumentationTool.DocumentationTask.setLocale.

Doc from javax.tools.DocumentationTool.DocumentationTask.setLocale.

Sets the locale to be applied when formatting diagnostics and other localized data.

Annotations
@Override