Class EnumConstantBuilder
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.EnumConstantBuilder
Deprecated.
Builds documentation for a enum constants.
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 class whose enum constants are being documented.private int
Deprecated.The index of the current enum constant that is being documented at this point in time.private final List<ProgramElementDoc>
Deprecated.The list of enum constants being documented.private final VisibleMemberMap
Deprecated.The visible enum constantss for the given class.private final EnumConstantWriter
Deprecated.The writer to output the enum constants documentation.Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
configuration, containingPackagesSeen, DEBUG, layoutParser, utils
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
EnumConstantBuilder
(AbstractBuilder.Context context, ClassDoc classDoc, EnumConstantWriter writer) Deprecated.Construct a new EnumConstantsBuilder. -
Method Summary
Modifier and TypeMethodDescriptionvoid
buildDeprecationInfo
(XMLNode node, Content enumConstantsTree) Deprecated.Build the deprecation information.void
buildEnumConstant
(XMLNode node, Content memberDetailsTree) Deprecated.Build the enum constant documentation.void
buildEnumConstantComments
(XMLNode node, Content enumConstantsTree) Deprecated.Build the comments for the enum constant.void
buildSignature
(XMLNode node, Content enumConstantsTree) Deprecated.Build the signature.void
buildTagInfo
(XMLNode node, Content enumConstantsTree) Deprecated.Build the tag information.static EnumConstantBuilder
getInstance
(AbstractBuilder.Context context, ClassDoc classDoc, EnumConstantWriter writer) Deprecated.Construct a new EnumConstantsBuilder.getName()
Deprecated.Return the name of this builder.Deprecated.Returns the visible member map for the enum constants of this class.Deprecated.Return the enum constant writer for this builder.boolean
Deprecated.summaryOrder.size()Deprecated.Returns a list of enum constants 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 class whose enum constants are being documented. -
visibleMemberMap
Deprecated.The visible enum constantss for the given class. -
writer
Deprecated.The writer to output the enum constants documentation. -
enumConstants
Deprecated.The list of enum constants being documented. -
currentEnumConstantsIndex
private int currentEnumConstantsIndexDeprecated.The index of the current enum constant that is being documented at this point in time.
-
-
Constructor Details
-
EnumConstantBuilder
private EnumConstantBuilder(AbstractBuilder.Context context, ClassDoc classDoc, EnumConstantWriter writer) Deprecated.Construct a new EnumConstantsBuilder.- Parameters:
context
- the build context.classDoc
- the class whoses members are being documented.writer
- the doclet specific writer.
-
-
Method Details
-
getInstance
public static EnumConstantBuilder getInstance(AbstractBuilder.Context context, ClassDoc classDoc, EnumConstantWriter writer) Deprecated.Construct a new EnumConstantsBuilder.- Parameters:
context
- the build context.classDoc
- the class whoses 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 enum constants 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 enum constants that will be documented.
-
getVisibleMemberMap
Deprecated.Returns the visible member map for the enum constants of this class.- Returns:
- the visible member map for the enum constants of this class.
-
hasMembersToDocument
public boolean hasMembersToDocument()Deprecated.summaryOrder.size()- Specified by:
hasMembersToDocument
in classAbstractMemberBuilder
- Returns:
- true if this subbuilder has anything to document.
-
buildEnumConstant
Deprecated.Build the enum constant 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 documentenumConstantsTree
- 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 documentenumConstantsTree
- the content tree to which the documentation will be added
-
buildEnumConstantComments
Deprecated.Build the comments for the enum constant. Do nothing ifConfiguration.nocomment
is set to true.- Parameters:
node
- the XML element that specifies which components to documentenumConstantsTree
- 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 documentenumConstantsTree
- the content tree to which the documentation will be added
-
getWriter
Deprecated.Return the enum constant writer for this builder.- Returns:
- the enum constant writer for this builder.
-