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