Class MemberSummaryBuilder
- java.lang.Object
-
- gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
-
- gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractMemberBuilder
-
- gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.MemberSummaryBuilder
-
@Deprecated public class MemberSummaryBuilder extends AbstractMemberBuilder
Deprecated.Builds the member summary.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 static String
NAME
Deprecated.The XML root for this builder.-
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
buildAnnotationTypeFieldsSummary(XMLNode node, Content memberSummaryTree)
Deprecated.Build the summary for fields.void
buildAnnotationTypeOptionalMemberSummary(XMLNode node, Content memberSummaryTree)
Deprecated.Build the summary for the optional members.void
buildAnnotationTypeRequiredMemberSummary(XMLNode node, Content memberSummaryTree)
Deprecated.Build the summary for the optional members.void
buildConstructorsSummary(XMLNode node, Content memberSummaryTree)
Deprecated.Build the constructor summary.void
buildEnumConstantsSummary(XMLNode node, Content memberSummaryTree)
Deprecated.Build the summary for the enum constants.void
buildFieldsSummary(XMLNode node, Content memberSummaryTree)
Deprecated.Build the summary for the fields.void
buildMethodsSummary(XMLNode node, Content memberSummaryTree)
Deprecated.Build the method summary.void
buildNestedClassesSummary(XMLNode node, Content memberSummaryTree)
Deprecated.Build the summary for the nested classes.void
buildPropertiesSummary(XMLNode node, Content memberSummaryTree)
Deprecated.Build the summary for the fields.static MemberSummaryBuilder
getInstance(AnnotationTypeWriter annotationTypeWriter, AbstractBuilder.Context context)
Deprecated.Construct a new MemberSummaryBuilder.static MemberSummaryBuilder
getInstance(ClassWriter classWriter, AbstractBuilder.Context context)
Deprecated.Construct a new MemberSummaryBuilder.MemberSummaryWriter
getMemberSummaryWriter(int type)
Deprecated.Return the specified member summary writer.String
getName()
Deprecated.Return the name of this builder.VisibleMemberMap
getVisibleMemberMap(int type)
Deprecated.Return the specified visible member map.boolean
hasMembersToDocument()
Deprecated.Return true it there are any members to summarize.List<ProgramElementDoc>
members(int type)
Deprecated.Returns a list of methods that will be documented for the given class.-
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractMemberBuilder
build, build
-
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
buildChildren, invokeMethod
-
-
-
-
Field Detail
-
NAME
public static final String NAME
Deprecated.The XML root for this builder.- See Also:
- Constant Field Values
-
-
Method Detail
-
getInstance
public static MemberSummaryBuilder getInstance(ClassWriter classWriter, AbstractBuilder.Context context) throws Exception
Deprecated.Construct a new MemberSummaryBuilder.- Parameters:
classWriter
- the writer for the class whose members are being summarized.context
- the build context.- Throws:
Exception
-
getInstance
public static MemberSummaryBuilder getInstance(AnnotationTypeWriter annotationTypeWriter, AbstractBuilder.Context context) throws Exception
Deprecated.Construct a new MemberSummaryBuilder.- Parameters:
annotationTypeWriter
- the writer for the class whose members are being summarized.configuration
- the current configuration of the doclet.- Throws:
Exception
-
getName
public String getName()
Deprecated.Return the name of this builder.- Specified by:
getName
in classAbstractBuilder
- Returns:
- the name of the builder.
-
getVisibleMemberMap
public VisibleMemberMap getVisibleMemberMap(int type)
Deprecated.Return the specified visible member map.- Parameters:
type
- the type of visible member map to return.- Returns:
- the specified visible member map.
- Throws:
ArrayIndexOutOfBoundsException
- when the type is invalid.- See Also:
VisibleMemberMap
-
getMemberSummaryWriter
public MemberSummaryWriter getMemberSummaryWriter(int type)
Deprecated.Return the specified member summary writer.- Parameters:
type
- the type of member summary writer to return.- Returns:
- the specified member summary writer.
- Throws:
ArrayIndexOutOfBoundsException
- when the type is invalid.- See Also:
VisibleMemberMap
-
members
public List<ProgramElementDoc> members(int type)
Deprecated.Returns a list of methods that will be documented for the given class. This information can be used for doclet specific documentation generation.- Parameters:
type
- the type of members to return.- Returns:
- a list of methods that will be documented.
- See Also:
VisibleMemberMap
-
hasMembersToDocument
public boolean hasMembersToDocument()
Deprecated.Return true it there are any members to summarize.- Specified by:
hasMembersToDocument
in classAbstractMemberBuilder
- Returns:
- true if there are any members to summarize.
-
buildEnumConstantsSummary
public void buildEnumConstantsSummary(XMLNode node, Content memberSummaryTree)
Deprecated.Build the summary for the enum constants.- Parameters:
node
- the XML element that specifies which components to documentmemberSummaryTree
- the content tree to which the documentation will be added
-
buildAnnotationTypeFieldsSummary
public void buildAnnotationTypeFieldsSummary(XMLNode node, Content memberSummaryTree)
Deprecated.Build the summary for fields.- Parameters:
node
- the XML element that specifies which components to documentmemberSummaryTree
- the content tree to which the documentation will be added
-
buildAnnotationTypeOptionalMemberSummary
public void buildAnnotationTypeOptionalMemberSummary(XMLNode node, Content memberSummaryTree)
Deprecated.Build the summary for the optional members.- Parameters:
node
- the XML element that specifies which components to documentmemberSummaryTree
- the content tree to which the documentation will be added
-
buildAnnotationTypeRequiredMemberSummary
public void buildAnnotationTypeRequiredMemberSummary(XMLNode node, Content memberSummaryTree)
Deprecated.Build the summary for the optional members.- Parameters:
node
- the XML element that specifies which components to documentmemberSummaryTree
- the content tree to which the documentation will be added
-
buildFieldsSummary
public void buildFieldsSummary(XMLNode node, Content memberSummaryTree)
Deprecated.Build the summary for the fields.- Parameters:
node
- the XML element that specifies which components to documentmemberSummaryTree
- the content tree to which the documentation will be added
-
buildPropertiesSummary
public void buildPropertiesSummary(XMLNode node, Content memberSummaryTree)
Deprecated.Build the summary for the fields.
-
buildNestedClassesSummary
public void buildNestedClassesSummary(XMLNode node, Content memberSummaryTree)
Deprecated.Build the summary for the nested classes.- Parameters:
node
- the XML element that specifies which components to documentmemberSummaryTree
- the content tree to which the documentation will be added
-
buildMethodsSummary
public void buildMethodsSummary(XMLNode node, Content memberSummaryTree)
Deprecated.Build the method summary.- Parameters:
node
- the XML element that specifies which components to documentmemberSummaryTree
- the content tree to which the documentation will be added
-
buildConstructorsSummary
public void buildConstructorsSummary(XMLNode node, Content memberSummaryTree)
Deprecated.Build the constructor summary.- Parameters:
node
- the XML element that specifies which components to documentmemberSummaryTree
- the content tree to which the documentation will be added
-
-