Class AnnotationTypeRequiredMemberBuilder
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.AnnotationTypeRequiredMemberBuilder
- Direct Known Subclasses:
AnnotationTypeOptionalMemberBuilder
Deprecated.
Builds documentation for required annotation type members.
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 TypeFieldDescriptionprotected ClassDoc
Deprecated.The annotation type whose members are being documented.protected int
Deprecated.The index of the current member that is being documented at this point in time.protected List<ProgramElementDoc>
Deprecated.The list of members being documented.protected VisibleMemberMap
Deprecated.The visible members for the given class.protected AnnotationTypeRequiredMemberWriter
Deprecated.The writer to output the member documentation.Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
configuration, containingPackagesSeen, DEBUG, layoutParser, utils
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
AnnotationTypeRequiredMemberBuilder
(AbstractBuilder.Context context, ClassDoc classDoc, AnnotationTypeRequiredMemberWriter writer, int memberType) Deprecated.Construct a new AnnotationTypeRequiredMemberBuilder. -
Method Summary
Modifier and TypeMethodDescriptionvoid
buildAnnotationTypeMember
(XMLNode node, Content memberDetailsTree) Deprecated.Build the member documentation.void
buildAnnotationTypeRequiredMember
(XMLNode node, Content memberDetailsTree) Deprecated.Build the annotation type required member documentation.void
buildDeprecationInfo
(XMLNode node, Content annotationDocTree) Deprecated.Build the deprecation information.void
buildMemberComments
(XMLNode node, Content annotationDocTree) Deprecated.Build the comments for the member.void
buildSignature
(XMLNode node, Content annotationDocTree) Deprecated.Build the signature.void
buildTagInfo
(XMLNode node, Content annotationDocTree) Deprecated.Build the tag information.getInstance
(AbstractBuilder.Context context, ClassDoc classDoc, AnnotationTypeRequiredMemberWriter writer) Deprecated.Construct a new AnnotationTypeMemberBuilder.getName()
Deprecated.Return the name of this builder.Deprecated.Returns the visible member map for the members of this class.Deprecated.Return the annotation type required member writer for this builder.boolean
Deprecated.summaryOrder.size()Deprecated.Returns a list of members 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 Details
-
classDoc
Deprecated.The annotation type whose members are being documented. -
visibleMemberMap
Deprecated.The visible members for the given class. -
writer
Deprecated.The writer to output the member documentation. -
members
Deprecated.The list of members being documented. -
currentMemberIndex
protected int currentMemberIndexDeprecated.The index of the current member that is being documented at this point in time.
-
-
Constructor Details
-
AnnotationTypeRequiredMemberBuilder
protected AnnotationTypeRequiredMemberBuilder(AbstractBuilder.Context context, ClassDoc classDoc, AnnotationTypeRequiredMemberWriter writer, int memberType) Deprecated.Construct a new AnnotationTypeRequiredMemberBuilder.- Parameters:
context
- the build context.classDoc
- the class whose members are being documented.writer
- the doclet specific writer.
-
-
Method Details
-
getInstance
public static AnnotationTypeRequiredMemberBuilder getInstance(AbstractBuilder.Context context, ClassDoc classDoc, AnnotationTypeRequiredMemberWriter writer) Deprecated.Construct a new AnnotationTypeMemberBuilder.- Parameters:
context
- the build context.classDoc
- the class whose members are being documented.writer
- the doclet specific writer.
-
getName
Deprecated.Return the name of this builder.- Specified by:
getName
in classAbstractBuilder
- Returns:
- the name of the builder.
-
members
Deprecated.Returns a list of members that will be documented for the given class. This information can be used for doclet specific documentation generation.- Parameters:
classDoc
- theClassDoc
we want to check.- Returns:
- a list of members that will be documented.
-
getVisibleMemberMap
Deprecated.Returns the visible member map for the members of this class.- Returns:
- the visible member map for the members of this class.
-
hasMembersToDocument
public boolean hasMembersToDocument()Deprecated.summaryOrder.size()- Specified by:
hasMembersToDocument
in classAbstractMemberBuilder
- Returns:
- true if this subbuilder has anything to document.
-
buildAnnotationTypeRequiredMember
Deprecated.Build the annotation type required member documentation.- Parameters:
node
- the XML element that specifies which components to documentmemberDetailsTree
- the content tree to which the documentation will be added
-
buildAnnotationTypeMember
Deprecated.Build the member documentation.- Parameters:
node
- the XML element that specifies which components to documentmemberDetailsTree
- the content tree to which the documentation will be added
-
buildSignature
Deprecated.Build the signature.- Parameters:
node
- the XML element that specifies which components to documentannotationDocTree
- the content tree to which the documentation will be added
-
buildDeprecationInfo
Deprecated.Build the deprecation information.- Parameters:
node
- the XML element that specifies which components to documentannotationDocTree
- the content tree to which the documentation will be added
-
buildMemberComments
Deprecated.Build the comments for the member. Do nothing ifConfiguration.nocomment
is set to true.- Parameters:
node
- the XML element that specifies which components to documentannotationDocTree
- the content tree to which the documentation will be added
-
buildTagInfo
Deprecated.Build the tag information.- Parameters:
node
- the XML element that specifies which components to documentannotationDocTree
- the content tree to which the documentation will be added
-
getWriter
Deprecated.Return the annotation type required member writer for this builder.- Returns:
- the annotation type required member constant writer for this builder.
-