Package gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders

Class PropertyBuilder

  • @Deprecated
public class PropertyBuilder
extends AbstractMemberBuilder
    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

    • Field Detail

      • classDoc

        private final ClassDoc classDoc
        Deprecated.
        The class whose properties are being documented.

      • visibleMemberMap

        private final VisibleMemberMap visibleMemberMap
        Deprecated.
        The visible properties for the given class.

      • writer

        private final PropertyWriter writer
        Deprecated.
        The writer to output the property documentation.

      • properties

        private final java.util.List<ProgramElementDoc> properties
        Deprecated.
        The list of properties being documented.

      • currentPropertyIndex

        private int currentPropertyIndex
        Deprecated.
        The index of the current property that is being documented at this point in time.

    • Constructor Detail

      • PropertyBuilder

        private PropertyBuilder​(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.

    • Method Detail

      • 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

        public java.lang.String getName()
        Deprecated.
        Return the name of this builder.
        Specified by:
        getName in class AbstractBuilder
        Returns:
        the name of the builder.

      • members

        public java.util.List<ProgramElementDoc> members​(ClassDoc classDoc)
        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 - the ClassDoc we want to check.
        Returns:
        a list of properties that will be documented.

      • getVisibleMemberMap

        public VisibleMemberMap 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 class AbstractMemberBuilder
        Returns:
        true if this subbuilder has anything to document.

      • buildPropertyDoc

        public void buildPropertyDoc​(XMLNode node,
                             Content memberDetailsTree)
        Deprecated.
        Build the property documentation.
        Parameters:
        node - the XML element that specifies which components to document
        memberDetailsTree - the content tree to which the documentation will be added

      • buildSignature

        public void buildSignature​(XMLNode node,
                           Content propertyDocTree)
        Deprecated.
        Build the signature.
        Parameters:
        node - the XML element that specifies which components to document
        propertyDocTree - the content tree to which the documentation will be added

      • buildDeprecationInfo

        public void buildDeprecationInfo​(XMLNode node,
                                 Content propertyDocTree)
        Deprecated.
        Build the deprecation information.
        Parameters:
        node - the XML element that specifies which components to document
        propertyDocTree - the content tree to which the documentation will be added

      • buildPropertyComments

        public void buildPropertyComments​(XMLNode node,
                                  Content propertyDocTree)
        Deprecated.
        Build the comments for the property. Do nothing if Configuration.nocomment is set to true.
        Parameters:
        node - the XML element that specifies which components to document
        propertyDocTree - the content tree to which the documentation will be added

      • buildTagInfo

        public void buildTagInfo​(XMLNode node,
                         Content propertyDocTree)
        Deprecated.
        Build the tag information.
        Parameters:
        node - the XML element that specifies which components to document
        propertyDocTree - the content tree to which the documentation will be added

      • getWriter

        public PropertyWriter getWriter()
        Deprecated.
        Return the property writer for this builder.
        Returns:
        the property writer for this builder.