Class ConstantsSummaryBuilder
- java.lang.Object
-
- gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
-
- gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.ConstantsSummaryBuilder
-
@Deprecated public class ConstantsSummaryBuilder extends AbstractBuilder
Deprecated.Builds the Constants Summary Page.This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.
- Since:
- 1.5
- Author:
- Jamie Ho, Bhavesh Patel (Modified)
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
AbstractBuilder.Context
-
-
Field Summary
Fields Modifier and Type Field Description protected Set<ClassDoc>
classDocsWithConstFields
Deprecated.The set of ClassDocs that have constant fields.static int
MAX_CONSTANT_VALUE_INDEX_LENGTH
Deprecated.The maximum number of package directories shown in the constant value index.protected Set<String>
printedPackageHeaders
Deprecated.The set of printed package headers.static String
ROOT
Deprecated.The root element of the constant summary XML is "ConstantSummary".protected ConstantsSummaryWriter
writer
Deprecated.The writer used to write the results.-
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
configuration, containingPackagesSeen, DEBUG, layoutParser, utils
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
build()
Deprecated.Build the documentation.void
buildClassConstantSummary(XMLNode node, Content summariesTree)
Deprecated.Build the summary for the current class.void
buildConstantMembers(XMLNode node, Content classConstantTree)
Deprecated.Build the summary of constant members in the class.void
buildConstantSummaries(XMLNode node, Content contentTree)
Deprecated.Build the summary for each documented package.void
buildConstantSummary(XMLNode node, Content contentTree)
Deprecated.Build the constant summary.void
buildContents(XMLNode node, Content contentTree)
Deprecated.Build the list of packages.void
buildPackageHeader(XMLNode node, Content summariesTree)
Deprecated.Build the header for the given package.static ConstantsSummaryBuilder
getInstance(AbstractBuilder.Context context, ConstantsSummaryWriter writer)
Deprecated.Construct a ConstantsSummaryBuilder.String
getName()
Deprecated.Return the name of this builder.-
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
build, buildChildren, invokeMethod
-
-
-
-
Field Detail
-
ROOT
public static final String ROOT
Deprecated.The root element of the constant summary XML is "ConstantSummary".- See Also:
- Constant Field Values
-
MAX_CONSTANT_VALUE_INDEX_LENGTH
public static final int MAX_CONSTANT_VALUE_INDEX_LENGTH
Deprecated.The maximum number of package directories shown in the constant value index.- See Also:
- Constant Field Values
-
writer
protected final ConstantsSummaryWriter writer
Deprecated.The writer used to write the results.
-
classDocsWithConstFields
protected final Set<ClassDoc> classDocsWithConstFields
Deprecated.The set of ClassDocs that have constant fields.
-
-
Method Detail
-
getInstance
public static ConstantsSummaryBuilder getInstance(AbstractBuilder.Context context, ConstantsSummaryWriter writer)
Deprecated.Construct a ConstantsSummaryBuilder.- Parameters:
context
- the build context.writer
- the writer for the summary.
-
build
public void build() throws IOException
Deprecated.Build the documentation.- Specified by:
build
in classAbstractBuilder
- Throws:
IOException
- if there is a problem writing the output
-
getName
public String getName()
Deprecated.Return the name of this builder.- Specified by:
getName
in classAbstractBuilder
- Returns:
- the name of the builder.
-
buildConstantSummary
public void buildConstantSummary(XMLNode node, Content contentTree) throws Exception
Deprecated.Build the constant summary.- Parameters:
node
- the XML element that specifies which components to documentcontentTree
- the content tree to which the documentation will be added- Throws:
Exception
-
buildContents
public void buildContents(XMLNode node, Content contentTree)
Deprecated.Build the list of packages.- Parameters:
node
- the XML element that specifies which components to documentcontentTree
- the content tree to which the content list will be added
-
buildConstantSummaries
public void buildConstantSummaries(XMLNode node, Content contentTree)
Deprecated.Build the summary for each documented package.- Parameters:
node
- the XML element that specifies which components to documentcontentTree
- the tree to which the summaries will be added
-
buildPackageHeader
public void buildPackageHeader(XMLNode node, Content summariesTree)
Deprecated.Build the header for the given package.- Parameters:
node
- the XML element that specifies which components to documentsummariesTree
- the tree to which the package header will be added
-
buildClassConstantSummary
public void buildClassConstantSummary(XMLNode node, Content summariesTree)
Deprecated.Build the summary for the current class.- Parameters:
node
- the XML element that specifies which components to documentsummariesTree
- the tree to which the class constant summary will be added
-
buildConstantMembers
public void buildConstantMembers(XMLNode node, Content classConstantTree)
Deprecated.Build the summary of constant members in the class.- Parameters:
node
- the XML element that specifies which components to documentclassConstantTree
- the tree to which the constant members table will be added
-
-