com.sun.xml.bind.taglets
Class CustomPackageSummaryBuilder

java.lang.Object
  extended by AbstractBuilder
      extended by com.sun.xml.bind.taglets.CustomPackageSummaryBuilder

public class CustomPackageSummaryBuilder
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
static java.lang.String ROOT
          The root element of the package summary XML is "PackageDoc".
 
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 CustomPackageSummaryBuilder getInstance(Configuration configuration, PackageDoc pkg, PackageSummaryWriter packageWriter)
          Construct a new PackageSummaryBuilder.
 java.lang.String getName()
          
 void invokeMethod(java.lang.String methodName, java.lang.Class[] paramClasses, java.lang.Object[] params)
          
 
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
Method Detail

getInstance

public static CustomPackageSummaryBuilder 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

Throws:
java.lang.Exception

build

public void build()
           throws java.io.IOException
Build the package summary.

Throws:
java.io.IOException

getName

public java.lang.String getName()


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.