com.sun.tools.doclets.internal.toolkit.builders
Class PackageSummaryBuilder

java.lang.Object
  com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
      com.sun.tools.doclets.internal.toolkit.builders.PackageSummaryBuilder

public class PackageSummaryBuilder
extends AbstractBuilder

Builds the summary for a given package. This code is not part of an API. It is implementation that is subject to change. Do not use it as an API

Since:

1.5

Field Summary

private PackageDoc	packageDoc The package being documented.
private PackageSummaryWriter	packageWriter The doclet specific writer that will output the result.
static java.lang.String	ROOT The root element of the package summary XML is "PackageDoc".

Fields inherited from class com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder

configuration, containingPackagesSeen, DEBUG

Constructor Summary

private

PackageSummaryBuilder(Configuration configuration)

Method Summary

void	build() Build the package summary.
void	buildAnnotationTypeSummary() Build the summary for the enums in this package.
void	buildClassSummary() Build the summary for the classes in this package.
void	buildEnumSummary() Build the summary for the enums in this package.
void	buildErrorSummary() Build the summary for the errors in this package.
void	buildExceptionSummary() Build the summary for the exceptions in this package.
void	buildInterfaceSummary() Build the summary for the interfaces in this package.
void	buildPackageDescription() Build the description of the summary.
void	buildPackageDoc(java.util.List<?> elements) Build the package documentation.
void	buildPackageFooter() Build the footer of the summary.
void	buildPackageHeader() Build the header of the summary.
void	buildPackageTags() Build the tags of the summary.
void	buildSummary(java.util.List<?> elements) Build the package summary.
void	buildSummaryFooter() Build the overall footer.
void	buildSummaryHeader() Build the overall header.
static PackageSummaryBuilder	getInstance(Configuration configuration, PackageDoc pkg, PackageSummaryWriter packageWriter) Construct a new PackageSummaryBuilder.
java.lang.String	getName() Return the name of this builder.
void	invokeMethod(java.lang.String methodName, java.lang.Class<?>[] paramClasses, java.lang.Object[] params) Given the name and parameters, invoke the method in the builder.

Methods inherited from class com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder

build

Methods inherited from class java.lang.Object

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

Field Detail

ROOT

public static final java.lang.String ROOT

The root element of the package summary XML is "PackageDoc".

See Also:

Constant Field Values

packageDoc

private PackageDoc packageDoc

The package being documented.

packageWriter

private PackageSummaryWriter packageWriter

The doclet specific writer that will output the result.

Constructor Detail

PackageSummaryBuilder

private PackageSummaryBuilder(Configuration configuration)

Method Detail

getInstance

public static PackageSummaryBuilder getInstance(Configuration configuration,
                                                PackageDoc pkg,
                                                PackageSummaryWriter packageWriter)

Construct a new PackageSummaryBuilder.

Parameters:

configuration - the current configuration of the doclet.

pkg - the package being documented.

packageWriter - the doclet specific writer that will output the result.

Returns:

an instance of a PackageSummaryBuilder.

invokeMethod

public void invokeMethod(java.lang.String methodName,
                         java.lang.Class<?>[] paramClasses,
                         java.lang.Object[] params)
                  throws java.lang.Exception

Given the name and parameters, invoke the method in the builder. This method is required to invoke the appropriate build method as instructed by the builder XML file.

Specified by:

invokeMethod in class AbstractBuilder

Parameters:

methodName - the name of the method that we would like to invoke.

paramClasses - the types for each parameter.

params - the parameters of the method.

Throws:

java.lang.Exception

build

public void build()
           throws java.io.IOException

Build the package summary.

Specified by:

build in class AbstractBuilder

Throws:

java.io.IOException - there was a problem writing the output.

getName

public java.lang.String getName()

Return the name of this builder.

Specified by:

getName in class AbstractBuilder

Returns:

the name of the builder.

buildPackageDoc

public void buildPackageDoc(java.util.List<?> elements)
                     throws java.lang.Exception

Build the package documentation.

Throws:

java.lang.Exception

buildPackageHeader

public void buildPackageHeader()

Build the header of the summary.

buildPackageDescription

public void buildPackageDescription()

Build the description of the summary.

buildPackageTags

public void buildPackageTags()

Build the tags of the summary.

buildSummary

public void buildSummary(java.util.List<?> elements)

Build the package summary.

buildSummaryHeader

public void buildSummaryHeader()

Build the overall header.

buildSummaryFooter

public void buildSummaryFooter()

Build the overall footer.

buildClassSummary

public void buildClassSummary()

Build the summary for the classes in this package.

buildInterfaceSummary

public void buildInterfaceSummary()

Build the summary for the interfaces in this package.

buildAnnotationTypeSummary

public void buildAnnotationTypeSummary()

Build the summary for the enums in this package.

buildEnumSummary

public void buildEnumSummary()

Build the summary for the enums in this package.

buildExceptionSummary

public void buildExceptionSummary()

Build the summary for the exceptions in this package.

buildErrorSummary

public void buildErrorSummary()

Build the summary for the errors in this package.

buildPackageFooter

public void buildPackageFooter()

Build the footer of the summary.