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.
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
-
Nested Class Summary
Nested classes/interfaces inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
AbstractBuilder.Context
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final ClassDoc
Deprecated.The type being documented.private MemberSummaryWriter[]
Deprecated.The member summary writers for the given class.static final String
Deprecated.The XML root for this builder.private final VisibleMemberMap[]
Deprecated.The visible members for the given class.Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
configuration, containingPackagesSeen, DEBUG, layoutParser, utils
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
MemberSummaryBuilder
(AbstractBuilder.Context context, ClassDoc classDoc) Deprecated.Construct a new MemberSummaryBuilder. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
addSummary
(MemberSummaryWriter writer, VisibleMemberMap visibleMemberMap, boolean showInheritedSummary, Content memberSummaryTree) Deprecated.Add the summary for the documentation.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.private void
buildInheritedSummary
(MemberSummaryWriter writer, VisibleMemberMap visibleMemberMap, LinkedList<Content> summaryTreeList) Deprecated.Build the inherited member summary for the given methods.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.private void
buildSummary
(MemberSummaryWriter writer, VisibleMemberMap visibleMemberMap, LinkedList<Content> summaryTreeList) Deprecated.Build the member summary for the given members.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.getMemberSummaryWriter
(int type) Deprecated.Return the specified member summary writer.getName()
Deprecated.Return the name of this builder.getVisibleMemberMap
(int type) Deprecated.Return the specified visible member map.boolean
Deprecated.Return true it there are any members to summarize.private boolean
Deprecated.Test whether the method is a getter.private boolean
Deprecated.Test whether the method is a setter.members
(int type) Deprecated.Returns a list of methods that will be documented for the given class.private void
processProperty
(VisibleMemberMap visibleMemberMap, ProgramElementDoc member, ProgramElementDoc propertyDoc) Deprecated.Process the property method, property setter and/or property getter comment text so that it contains the documentation from the property field.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 Details
-
NAME
Deprecated.The XML root for this builder.- See Also:
-
visibleMemberMaps
Deprecated.The visible members for the given class. -
memberSummaryWriters
Deprecated.The member summary writers for the given class. -
classDoc
Deprecated.The type being documented.
-
-
Constructor Details
-
MemberSummaryBuilder
Deprecated.Construct a new MemberSummaryBuilder.- Parameters:
classWriter
- the writer for the class whose members are being summarized.context
- the build context.
-
-
Method Details
-
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
Deprecated.Return the name of this builder.- Specified by:
getName
in classAbstractBuilder
- Returns:
- the name of the builder.
-
getVisibleMemberMap
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:
-
getMemberSummaryWriter
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:
-
members
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:
-
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
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
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
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
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
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
Deprecated.Build the summary for the fields. -
buildNestedClassesSummary
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
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
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
-
buildSummary
private void buildSummary(MemberSummaryWriter writer, VisibleMemberMap visibleMemberMap, LinkedList<Content> summaryTreeList) Deprecated.Build the member summary for the given members.- Parameters:
writer
- the summary writer to write the output.visibleMemberMap
- the given members to summarize.summaryTreeList
- list of content trees to which the documentation will be added
-
processProperty
private void processProperty(VisibleMemberMap visibleMemberMap, ProgramElementDoc member, ProgramElementDoc propertyDoc) Deprecated.Process the property method, property setter and/or property getter comment text so that it contains the documentation from the property field. The method adds the leading sentence, copied documentation including the defaultValue tag and the see tags if the appropriate property getter and setter are available.- Parameters:
visibleMemberMap
- the members information.member
- the member which is to be augmented.propertyDoc
- the original property documentation.
-
isGetter
Deprecated.Test whether the method is a getter.- Parameters:
ped
- property method documentation. Needs to be either property method, property getter, or property setter.- Returns:
- true if the given documentation belongs to a getter.
-
isSetter
Deprecated.Test whether the method is a setter.- Parameters:
ped
- property method documentation. Needs to be either property method, property getter, or property setter.- Returns:
- true if the given documentation belongs to a setter.
-
buildInheritedSummary
private void buildInheritedSummary(MemberSummaryWriter writer, VisibleMemberMap visibleMemberMap, LinkedList<Content> summaryTreeList) Deprecated.Build the inherited member summary for the given methods.- Parameters:
writer
- the writer for this member summary.visibleMemberMap
- the map for the members to document.summaryTreeList
- list of content trees to which the documentation will be added
-
addSummary
private void addSummary(MemberSummaryWriter writer, VisibleMemberMap visibleMemberMap, boolean showInheritedSummary, Content memberSummaryTree) Deprecated.Add the summary for the documentation.- Parameters:
writer
- the writer for this member summary.visibleMemberMap
- the map for the members to document.showInheritedSummary
- true if inherited summary should be documentedmemberSummaryTree
- the content tree to which the documentation will be added
-