|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectAbstractBuilder
com.sun.xml.bind.taglets.CustomPackageSummaryBuilder
public class CustomPackageSummaryBuilder
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
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 |
---|
public static final java.lang.String ROOT
Method Detail |
---|
public static CustomPackageSummaryBuilder getInstance(Configuration configuration, PackageDoc pkg, PackageSummaryWriter packageWriter)
configuration
- the current configuration of the doclet.pkg
- the package being documented.packageWriter
- the doclet specific writer that will output the
result.
public void invokeMethod(java.lang.String methodName, java.lang.Class[] paramClasses, java.lang.Object[] params) throws java.lang.Exception
java.lang.Exception
public void build() throws java.io.IOException
java.io.IOException
public java.lang.String getName()
public void buildPackageDoc(java.util.List elements) throws java.lang.Exception
java.lang.Exception
public void buildPackageHeader()
public void buildPackageDescription()
public void buildPackageTags()
public void buildSummary(java.util.List elements)
public void buildSummaryHeader()
public void buildSummaryFooter()
public void buildClassSummary()
public void buildInterfaceSummary()
public void buildAnnotationTypeSummary()
public void buildEnumSummary()
public void buildExceptionSummary()
public void buildErrorSummary()
public void buildPackageFooter()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |