aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.tools.doclets.formats.html;
aoqi@0: 
aoqi@0: import java.io.*;
aoqi@0: import java.util.*;
aoqi@0: 
aoqi@0: import com.sun.javadoc.*;
aoqi@0: import com.sun.tools.doclets.formats.html.markup.*;
aoqi@0: import com.sun.tools.doclets.internal.toolkit.*;
aoqi@0: import com.sun.tools.doclets.internal.toolkit.util.*;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Writes constructor documentation.
aoqi@0:  *
aoqi@0:  *  <p><b>This is NOT part of any supported API.
aoqi@0:  *  If you write code that depends on this, you do so at your own risk.
aoqi@0:  *  This code and its internal interfaces are subject to change or
aoqi@0:  *  deletion without notice.</b>
aoqi@0:  *
aoqi@0:  * @author Robert Field
aoqi@0:  * @author Atul M Dambalkar
aoqi@0:  * @author Bhavesh Patel (Modified)
aoqi@0:  */
aoqi@0: public class ConstructorWriterImpl extends AbstractExecutableMemberWriter
aoqi@0:     implements ConstructorWriter, MemberSummaryWriter {
aoqi@0: 
aoqi@0:     private boolean foundNonPubConstructor = false;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Construct a new ConstructorWriterImpl.
aoqi@0:      *
aoqi@0:      * @param writer The writer for the class that the constructors belong to.
aoqi@0:      * @param classDoc the class being documented.
aoqi@0:      */
aoqi@0:     public ConstructorWriterImpl(SubWriterHolderWriter writer,
aoqi@0:             ClassDoc classDoc) {
aoqi@0:         super(writer, classDoc);
aoqi@0:         VisibleMemberMap visibleMemberMap = new VisibleMemberMap(classDoc,
aoqi@0:             VisibleMemberMap.CONSTRUCTORS, configuration);
aoqi@0:         List<ProgramElementDoc> constructors = new ArrayList<ProgramElementDoc>(visibleMemberMap.getMembersFor(classDoc));
aoqi@0:         for (int i = 0; i < constructors.size(); i++) {
aoqi@0:             if ((constructors.get(i)).isProtected() ||
aoqi@0:                 (constructors.get(i)).isPrivate()) {
aoqi@0:                 setFoundNonPubConstructor(true);
aoqi@0:             }
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Construct a new ConstructorWriterImpl.
aoqi@0:      *
aoqi@0:      * @param writer The writer for the class that the constructors belong to.
aoqi@0:      */
aoqi@0:     public ConstructorWriterImpl(SubWriterHolderWriter writer) {
aoqi@0:         super(writer);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     public Content getMemberSummaryHeader(ClassDoc classDoc,
aoqi@0:             Content memberSummaryTree) {
aoqi@0:         memberSummaryTree.addContent(HtmlConstants.START_OF_CONSTRUCTOR_SUMMARY);
aoqi@0:         Content memberTree = writer.getMemberTreeHeader();
aoqi@0:         writer.addSummaryHeader(this, classDoc, memberTree);
aoqi@0:         return memberTree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     public Content getConstructorDetailsTreeHeader(ClassDoc classDoc,
aoqi@0:             Content memberDetailsTree) {
aoqi@0:         memberDetailsTree.addContent(HtmlConstants.START_OF_CONSTRUCTOR_DETAILS);
aoqi@0:         Content constructorDetailsTree = writer.getMemberTreeHeader();
aoqi@0:         constructorDetailsTree.addContent(writer.getMarkerAnchor(
aoqi@0:                 SectionName.CONSTRUCTOR_DETAIL));
aoqi@0:         Content heading = HtmlTree.HEADING(HtmlConstants.DETAILS_HEADING,
aoqi@0:                 writer.constructorDetailsLabel);
aoqi@0:         constructorDetailsTree.addContent(heading);
aoqi@0:         return constructorDetailsTree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     public Content getConstructorDocTreeHeader(ConstructorDoc constructor,
aoqi@0:             Content constructorDetailsTree) {
aoqi@0:         String erasureAnchor;
aoqi@0:         if ((erasureAnchor = getErasureAnchor(constructor)) != null) {
aoqi@0:             constructorDetailsTree.addContent(writer.getMarkerAnchor((erasureAnchor)));
aoqi@0:         }
aoqi@0:         constructorDetailsTree.addContent(
aoqi@0:                 writer.getMarkerAnchor(writer.getAnchor(constructor)));
aoqi@0:         Content constructorDocTree = writer.getMemberTreeHeader();
aoqi@0:         Content heading = new HtmlTree(HtmlConstants.MEMBER_HEADING);
aoqi@0:         heading.addContent(constructor.name());
aoqi@0:         constructorDocTree.addContent(heading);
aoqi@0:         return constructorDocTree;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     public Content getSignature(ConstructorDoc constructor) {
aoqi@0:         Content pre = new HtmlTree(HtmlTag.PRE);
aoqi@0:         writer.addAnnotationInfo(constructor, pre);
aoqi@0:         addModifiers(constructor, pre);
aoqi@0:         if (configuration.linksource) {
aoqi@0:             Content constructorName = new StringContent(constructor.name());
aoqi@0:             writer.addSrcLink(constructor, constructorName, pre);
aoqi@0:         } else {
aoqi@0:             addName(constructor.name(), pre);
aoqi@0:         }
aoqi@0:         int indent = pre.charCount();
aoqi@0:         addParameters(constructor, pre, indent);
aoqi@0:         addExceptions(constructor, pre, indent);
aoqi@0:         return pre;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     @Override
aoqi@0:     public void setSummaryColumnStyle(HtmlTree tdTree) {
aoqi@0:         if (foundNonPubConstructor)
aoqi@0:             tdTree.addStyle(HtmlStyle.colLast);
aoqi@0:         else
aoqi@0:             tdTree.addStyle(HtmlStyle.colOne);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     public void addDeprecated(ConstructorDoc constructor, Content constructorDocTree) {
aoqi@0:         addDeprecatedInfo(constructor, constructorDocTree);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     public void addComments(ConstructorDoc constructor, Content constructorDocTree) {
aoqi@0:         addComment(constructor, constructorDocTree);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     public void addTags(ConstructorDoc constructor, Content constructorDocTree) {
aoqi@0:         writer.addTagsInfo(constructor, constructorDocTree);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     public Content getConstructorDetails(Content constructorDetailsTree) {
aoqi@0:         return getMemberTree(constructorDetailsTree);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     public Content getConstructorDoc(Content constructorDocTree,
aoqi@0:             boolean isLastContent) {
aoqi@0:         return getMemberTree(constructorDocTree, isLastContent);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Close the writer.
aoqi@0:      */
aoqi@0:     public void close() throws IOException {
aoqi@0:         writer.close();
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Let the writer know whether a non public constructor was found.
aoqi@0:      *
aoqi@0:      * @param foundNonPubConstructor true if we found a non public constructor.
aoqi@0:      */
aoqi@0:     public void setFoundNonPubConstructor(boolean foundNonPubConstructor) {
aoqi@0:         this.foundNonPubConstructor = foundNonPubConstructor;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     public void addSummaryLabel(Content memberTree) {
aoqi@0:         Content label = HtmlTree.HEADING(HtmlConstants.SUMMARY_HEADING,
aoqi@0:                 writer.getResource("doclet.Constructor_Summary"));
aoqi@0:         memberTree.addContent(label);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     public String getTableSummary() {
aoqi@0:         return configuration.getText("doclet.Member_Table_Summary",
aoqi@0:                 configuration.getText("doclet.Constructor_Summary"),
aoqi@0:                 configuration.getText("doclet.constructors"));
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     public Content getCaption() {
aoqi@0:         return configuration.getResource("doclet.Constructors");
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     public String[] getSummaryTableHeader(ProgramElementDoc member) {
aoqi@0:         String[] header;
aoqi@0:         if (foundNonPubConstructor) {
aoqi@0:             header = new String[] {
aoqi@0:                 configuration.getText("doclet.Modifier"),
aoqi@0:                 configuration.getText("doclet.0_and_1",
aoqi@0:                         configuration.getText("doclet.Constructor"),
aoqi@0:                         configuration.getText("doclet.Description"))
aoqi@0:             };
aoqi@0:         }
aoqi@0:         else {
aoqi@0:             header = new String[] {
aoqi@0:                 configuration.getText("doclet.0_and_1",
aoqi@0:                         configuration.getText("doclet.Constructor"),
aoqi@0:                         configuration.getText("doclet.Description"))
aoqi@0:             };
aoqi@0:         }
aoqi@0:         return header;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     public void addSummaryAnchor(ClassDoc cd, Content memberTree) {
aoqi@0:         memberTree.addContent(writer.getMarkerAnchor(
aoqi@0:                 SectionName.CONSTRUCTOR_SUMMARY));
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     public void addInheritedSummaryAnchor(ClassDoc cd, Content inheritedTree) {
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     public void addInheritedSummaryLabel(ClassDoc cd, Content inheritedTree) {
aoqi@0:     }
aoqi@0: 
aoqi@0:     public int getMemberKind() {
aoqi@0:         return VisibleMemberMap.CONSTRUCTORS;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     protected Content getNavSummaryLink(ClassDoc cd, boolean link) {
aoqi@0:         if (link) {
aoqi@0:             return writer.getHyperLink(SectionName.CONSTRUCTOR_SUMMARY,
aoqi@0:                     writer.getResource("doclet.navConstructor"));
aoqi@0:         } else {
aoqi@0:             return writer.getResource("doclet.navConstructor");
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     protected void addNavDetailLink(boolean link, Content liNav) {
aoqi@0:         if (link) {
aoqi@0:             liNav.addContent(writer.getHyperLink(
aoqi@0:                     SectionName.CONSTRUCTOR_DETAIL,
aoqi@0:                     writer.getResource("doclet.navConstructor")));
aoqi@0:         } else {
aoqi@0:             liNav.addContent(writer.getResource("doclet.navConstructor"));
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     protected void addSummaryType(ProgramElementDoc member, Content tdSummaryType) {
aoqi@0:         if (foundNonPubConstructor) {
aoqi@0:             Content code = new HtmlTree(HtmlTag.CODE);
aoqi@0:             if (member.isProtected()) {
aoqi@0:                 code.addContent("protected ");
aoqi@0:             } else if (member.isPrivate()) {
aoqi@0:                 code.addContent("private ");
aoqi@0:             } else if (member.isPublic()) {
aoqi@0:                 code.addContent(writer.getSpace());
aoqi@0:             } else {
aoqi@0:                 code.addContent(
aoqi@0:                         configuration.getText("doclet.Package_private"));
aoqi@0:             }
aoqi@0:             tdSummaryType.addContent(code);
aoqi@0:         }
aoqi@0:     }
aoqi@0: }