com.sun.tools.doclets.internal.toolkit
Class AbstractDoclet

java.lang.Object
  com.sun.tools.doclets.internal.toolkit.AbstractDoclet

Direct Known Subclasses:

HtmlDoclet

public abstract class AbstractDoclet
extends java.lang.Object

An abstract implementation of a Doclet. This code is not part of an API. It is implementation that is subject to change. Do not use it as an API.

Field Summary

Configuration	configuration The global configuration information for this run.
private static java.lang.String	TOOLKIT_DOCLET_NAME The only doclet that may use this toolkit is

Constructor Summary

AbstractDoclet()

Method Summary

abstract Configuration	configuration() Create the configuration instance and returns it.
protected abstract void	generateClassFiles(ClassDoc[] arr, ClassTree classtree) Generate the class documentation.
private void	generateClassFiles(ClassTree classtree) Generate the class files for single classes specified on the command line.
protected void	generateClassFiles(RootDoc root, ClassTree classtree) Iterate through all classes and construct documentation for them.
protected void	generateOtherFiles(RootDoc root, ClassTree classtree) Generate additional documentation that is added to the API documentation.
protected abstract void	generatePackageFiles(ClassTree classtree) Generate the package documentation.
private boolean	isValidDoclet(AbstractDoclet doclet) Verify that the only doclet that is using this toolkit is .
static LanguageVersion	languageVersion() Indicate that this doclet supports the 1.5 language features.
boolean	start(AbstractDoclet doclet, RootDoc root) The method that starts the execution of the doclet.
private void	startGeneration(RootDoc root) Start the generation of files.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configuration

public Configuration configuration

The global configuration information for this run.

TOOLKIT_DOCLET_NAME

private static final java.lang.String TOOLKIT_DOCLET_NAME

The only doclet that may use this toolkit is

Constructor Detail

AbstractDoclet

public AbstractDoclet()

Method Detail

isValidDoclet

private boolean isValidDoclet(AbstractDoclet doclet)

Verify that the only doclet that is using this toolkit is .

start

public boolean start(AbstractDoclet doclet,
                     RootDoc root)

The method that starts the execution of the doclet.

Parameters:

doclet - the doclet to start the execution for.

root - the RootDoc that points to the source to document.

Returns:

true if the doclet executed without error. False otherwise.

languageVersion

public static LanguageVersion languageVersion()

Indicate that this doclet supports the 1.5 language features.

Returns:

JAVA_1_5, indicating that the new features are supported.

configuration

public abstract Configuration configuration()

Create the configuration instance and returns it.

Returns:

the configuration of the doclet.

startGeneration

private void startGeneration(RootDoc root)
                      throws java.lang.Exception

Start the generation of files. Call generate methods in the individual writers, which will in turn genrate the documentation files. Call the TreeWriter generation first to ensure the Class Hierarchy is built first and then can be used in the later generation.

Throws:

java.lang.Exception

See Also:

RootDoc

generateOtherFiles

protected void generateOtherFiles(RootDoc root,
                                  ClassTree classtree)
                           throws java.lang.Exception

Generate additional documentation that is added to the API documentation.

Parameters:

root - the RootDoc of source to document.

classtree - the data structure representing the class tree.

Throws:

java.lang.Exception

generatePackageFiles

protected abstract void generatePackageFiles(ClassTree classtree)
                                      throws java.lang.Exception

Generate the package documentation.

Parameters:

classtree - the data structure representing the class tree.

Throws:

java.lang.Exception

generateClassFiles

protected abstract void generateClassFiles(ClassDoc[] arr,
                                           ClassTree classtree)

Generate the class documentation.

Parameters:

classtree - the data structure representing the class tree.

generateClassFiles

protected void generateClassFiles(RootDoc root,
                                  ClassTree classtree)

Iterate through all classes and construct documentation for them.

Parameters:

root - the RootDoc of source to document.

classtree - the data structure representing the class tree.

generateClassFiles

private void generateClassFiles(ClassTree classtree)

Generate the class files for single classes specified on the command line.

Parameters:

classtree - the data structure representing the class tree.