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