APIdia Launch Partner
Top Description Fields Constructors Methods
jdk.javadoc.internal.doclets.toolkit.util

public Class ElementListWriter

extends Object
Class Inheritance
Imports
java.io.*, javax.lang.model.element.ModuleElement, .PackageElement, jdk.javadoc.doclet.DocletEnvironment, jdk.javadoc.internal.doclets.toolkit.BaseConfiguration, .BaseOptions

Write out the element index.

Field Summary

Modifier and TypeField and Description
private final BaseConfiguration
private final DocFile
private final BaseOptions
private final Utils

Constructor Summary

AccessConstructor and Description
public
ElementListWriter(BaseConfiguration
the current configuration of the doclet.
configuration
)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public static void
generate(BaseConfiguration
the current configuration of the doclet.
configuration
)

Generate the element index.

protected void
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

configurationback to summary
private final BaseConfiguration configuration
fileback to summary
private final DocFile file
optionsback to summary
private final BaseOptions options
utilsback to summary
private final Utils utils

Constructor Detail

ElementListWriterback to summary
public ElementListWriter(BaseConfiguration configuration)

Constructor.

Parameters
configuration:BaseConfiguration

the current configuration of the doclet.

Method Detail

generateback to summary
public static void generate(BaseConfiguration configuration) throws DocFileIOException

Generate the element index.

Parameters
configuration:BaseConfiguration

the current configuration of the doclet.

Exceptions
DocFileIOException:
if there is a problem writing the output
generateElementListFileback to summary
protected void generateElementListFile(DocletEnvironment docEnv) throws DocFileIOException