/*
 * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package com.sun.tools.doclets.internal.toolkit.builders;

import java.util.*;

import com.sun.tools.doclets.internal.toolkit.util.*;
import com.sun.tools.doclets.internal.toolkit.*;
import com.sun.javadoc.*;

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.
Author:
Jamie Ho, Bhavesh Patel (Modified)
Since:
1.7/**
 * Builds documentation for a property.
 *
 *  <p><b>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.</b>
 *
 * @author Jamie Ho
 * @author Bhavesh Patel (Modified)
 * @since 1.7
 */
@Deprecated
public class PropertyBuilder extends AbstractMemberBuilder {

    
The class whose properties are being documented.
/**
     * The class whose properties are being documented.
     */
    private final ClassDoc classDoc;

    
The visible properties for the given class.
/**
     * The visible properties for the given class.
     */
    private final VisibleMemberMap visibleMemberMap;

    
The writer to output the property documentation.
/**
     * The writer to output the property documentation.
     */
    private final PropertyWriter writer;

    
The list of properties being documented.
/**
     * The list of properties being documented.
     */
    private final List<ProgramElementDoc> properties;

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

    
Construct a new PropertyBuilder.
Params:
context –  the build context.
classDoc – the class whoses members are being documented.
writer – the doclet specific writer./**
     * Construct a new PropertyBuilder.
     *
     * @param context  the build context.
     * @param classDoc the class whoses members are being documented.
     * @param writer the doclet specific writer.
     */
    private PropertyBuilder(Context context,
            ClassDoc classDoc,
            PropertyWriter writer) {
        super(context);
        this.classDoc = classDoc;
        this.writer = writer;
        visibleMemberMap =
                new VisibleMemberMap(
                classDoc,
                VisibleMemberMap.PROPERTIES,
                configuration);
        properties =
                new ArrayList<>(visibleMemberMap.getMembersFor(classDoc));
        if (configuration.getMemberComparator() != null) {
            Collections.sort(properties, configuration.getMemberComparator());
        }
    }

    
Construct a new PropertyBuilder.
Params:
context –  the build context.
classDoc – the class whoses members are being documented.
writer – the doclet specific writer./**
     * Construct a new PropertyBuilder.
     *
     * @param context  the build context.
     * @param classDoc the class whoses members are being documented.
     * @param writer the doclet specific writer.
     */
    public static PropertyBuilder getInstance(Context context,
            ClassDoc classDoc,
            PropertyWriter writer) {
        return new PropertyBuilder(context, classDoc, writer);
    }

    
{@inheritDoc}
/**
     * {@inheritDoc}
     */
    public String getName() {
        return "PropertyDetails";
    }

    
Returns a list of properties that will be documented for the given class.
This information can be used for doclet specific documentation
generation.
Params:
classDoc – the ClassDoc we want to check.
Returns:
a list of properties that will be documented./**
     * Returns a list of properties that will be documented for the given class.
     * This information can be used for doclet specific documentation
     * generation.
     *
     * @param classDoc the {@link ClassDoc} we want to check.
     * @return a list of properties that will be documented.
     */
    public List<ProgramElementDoc> members(ClassDoc classDoc) {
        return visibleMemberMap.getMembersFor(classDoc);
    }

    
Returns the visible member map for the properties of this class.
Returns:
the visible member map for the properties of this class./**
     * Returns the visible member map for the properties of this class.
     *
     * @return the visible member map for the properties of this class.
     */
    public VisibleMemberMap getVisibleMemberMap() {
        return visibleMemberMap;
    }

    
summaryOrder.size()
/**
     * summaryOrder.size()
     */
    public boolean hasMembersToDocument() {
        return properties.size() > 0;
    }

    
Build the property documentation.
Params:
node – the XML element that specifies which components to document
memberDetailsTree – the content tree to which the documentation will be added/**
     * Build the property documentation.
     *
     * @param node the XML element that specifies which components to document
     * @param memberDetailsTree the content tree to which the documentation will be added
     */
    public void buildPropertyDoc(XMLNode node, Content memberDetailsTree) {
        if (writer == null) {
            return;
        }
        int size = properties.size();
        if (size > 0) {
            Content propertyDetailsTree = writer.getPropertyDetailsTreeHeader(
                    classDoc, memberDetailsTree);
            for (currentPropertyIndex = 0; currentPropertyIndex < size;
                    currentPropertyIndex++) {
                Content propertyDocTree = writer.getPropertyDocTreeHeader(
                        (MethodDoc) properties.get(currentPropertyIndex),
                        propertyDetailsTree);
                buildChildren(node, propertyDocTree);
                propertyDetailsTree.addContent(writer.getPropertyDoc(
                        propertyDocTree, (currentPropertyIndex == size - 1)));
            }
            memberDetailsTree.addContent(
                    writer.getPropertyDetails(propertyDetailsTree));
        }
    }

    
Build the signature.
Params:
node – the XML element that specifies which components to document
propertyDocTree – the content tree to which the documentation will be added/**
     * Build the signature.
     *
     * @param node the XML element that specifies which components to document
     * @param propertyDocTree the content tree to which the documentation will be added
     */
    public void buildSignature(XMLNode node, Content propertyDocTree) {
        propertyDocTree.addContent(
                writer.getSignature((MethodDoc) properties.get(currentPropertyIndex)));
    }

    
Build the deprecation information.
Params:
node – the XML element that specifies which components to document
propertyDocTree – the content tree to which the documentation will be added/**
     * Build the deprecation information.
     *
     * @param node the XML element that specifies which components to document
     * @param propertyDocTree the content tree to which the documentation will be added
     */
    public void buildDeprecationInfo(XMLNode node, Content propertyDocTree) {
        writer.addDeprecated(
                (MethodDoc) properties.get(currentPropertyIndex), propertyDocTree);
    }

    
Build the comments for the property. Do nothing if Configuration.nocomment is set to true. 
Params:
node – the XML element that specifies which components to document
propertyDocTree – the content tree to which the documentation will be added/**
     * Build the comments for the property.  Do nothing if
     * {@link Configuration#nocomment} is set to true.
     *
     * @param node the XML element that specifies which components to document
     * @param propertyDocTree the content tree to which the documentation will be added
     */
    public void buildPropertyComments(XMLNode node, Content propertyDocTree) {
        if (!configuration.nocomment) {
            writer.addComments((MethodDoc) properties.get(currentPropertyIndex), propertyDocTree);
        }
    }

    
Build the tag information.
Params:
node – the XML element that specifies which components to document
propertyDocTree – the content tree to which the documentation will be added/**
     * Build the tag information.
     *
     * @param node the XML element that specifies which components to document
     * @param propertyDocTree the content tree to which the documentation will be added
     */
    public void buildTagInfo(XMLNode node, Content propertyDocTree) {
        writer.addTags((MethodDoc) properties.get(currentPropertyIndex), propertyDocTree);
    }

    
Return the property writer for this builder.
Returns:
the property writer for this builder./**
     * Return the property writer for this builder.
     *
     * @return the property writer for this builder.
     */
    public PropertyWriter getWriter() {
        return writer;
    }
}