• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/ConstructorBuilder.java@2eb010b6cb22 (annotated)

src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/ConstructorBuilder.java

Thu, 31 Aug 2017 15:17:03 +0800

author

aoqi

date

Thu, 31 Aug 2017 15:17:03 +0800

changeset 2525

2eb010b6cb22

parent 1606

ccbe7ffdd867

parent 0

959103a6100f

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.sun.tools.doclets.internal.toolkit.builders;
aoqi@0	27
aoqi@0	28	import java.util.*;
aoqi@0	29
aoqi@0	30	import com.sun.javadoc.*;
aoqi@0	31	import com.sun.tools.doclets.internal.toolkit.*;
aoqi@0	32	import com.sun.tools.doclets.internal.toolkit.util.*;
aoqi@0	33
aoqi@0	34	/**
aoqi@0	35	* Builds documentation for a constructor.
aoqi@0	36	*
aoqi@0	37	* <p><b>This is NOT part of any supported API.
aoqi@0	38	* If you write code that depends on this, you do so at your own risk.
aoqi@0	39	* This code and its internal interfaces are subject to change or
aoqi@0	40	* deletion without notice.</b>
aoqi@0	41	*
aoqi@0	42	* @author Jamie Ho
aoqi@0	43	* @author Bhavesh Patel (Modified)
aoqi@0	44	* @since 1.5
aoqi@0	45	*/
aoqi@0	46	public class ConstructorBuilder extends AbstractMemberBuilder {
aoqi@0	47
aoqi@0	48	/**
aoqi@0	49	* The name of this builder.
aoqi@0	50	*/
aoqi@0	51	public static final String NAME = "ConstructorDetails";
aoqi@0	52
aoqi@0	53	/**
aoqi@0	54	* The index of the current field that is being documented at this point
aoqi@0	55	* in time.
aoqi@0	56	*/
aoqi@0	57	private int currentConstructorIndex;
aoqi@0	58
aoqi@0	59	/**
aoqi@0	60	* The class whose constructors are being documented.
aoqi@0	61	*/
aoqi@0	62	private final ClassDoc classDoc;
aoqi@0	63
aoqi@0	64	/**
aoqi@0	65	* The visible constructors for the given class.
aoqi@0	66	*/
aoqi@0	67	private final VisibleMemberMap visibleMemberMap;
aoqi@0	68
aoqi@0	69	/**
aoqi@0	70	* The writer to output the constructor documentation.
aoqi@0	71	*/
aoqi@0	72	private final ConstructorWriter writer;
aoqi@0	73
aoqi@0	74	/**
aoqi@0	75	* The constructors being documented.
aoqi@0	76	*/
aoqi@0	77	private final List<ProgramElementDoc> constructors;
aoqi@0	78
aoqi@0	79	/**
aoqi@0	80	* Construct a new ConstructorBuilder.
aoqi@0	81	*
aoqi@0	82	* @param context the build context.
aoqi@0	83	* @param classDoc the class whoses members are being documented.
aoqi@0	84	* @param writer the doclet specific writer.
aoqi@0	85	*/
aoqi@0	86	private ConstructorBuilder(Context context,
aoqi@0	87	ClassDoc classDoc,
aoqi@0	88	ConstructorWriter writer) {
aoqi@0	89	super(context);
aoqi@0	90	this.classDoc = classDoc;
aoqi@0	91	this.writer = writer;
aoqi@0	92	visibleMemberMap =
aoqi@0	93	new VisibleMemberMap(
aoqi@0	94	classDoc,
aoqi@0	95	VisibleMemberMap.CONSTRUCTORS,
aoqi@0	96	configuration);
aoqi@0	97	constructors =
aoqi@0	98	new ArrayList<ProgramElementDoc>(visibleMemberMap.getMembersFor(classDoc));
aoqi@0	99	for (int i = 0; i < constructors.size(); i++) {
aoqi@0	100	if (constructors.get(i).isProtected()
aoqi@0	101	|| constructors.get(i).isPrivate()) {
aoqi@0	102	writer.setFoundNonPubConstructor(true);
aoqi@0	103	}
aoqi@0	104	}
aoqi@0	105	if (configuration.getMemberComparator() != null) {
aoqi@0	106	Collections.sort(constructors,configuration.getMemberComparator());
aoqi@0	107	}
aoqi@0	108	}
aoqi@0	109
aoqi@0	110	/**
aoqi@0	111	* Construct a new ConstructorBuilder.
aoqi@0	112	*
aoqi@0	113	* @param context the build context.
aoqi@0	114	* @param classDoc the class whoses members are being documented.
aoqi@0	115	* @param writer the doclet specific writer.
aoqi@0	116	*/
aoqi@0	117	public static ConstructorBuilder getInstance(Context context,
aoqi@0	118	ClassDoc classDoc, ConstructorWriter writer) {
aoqi@0	119	return new ConstructorBuilder(context, classDoc, writer);
aoqi@0	120	}
aoqi@0	121
aoqi@0	122	/**
aoqi@0	123	* {@inheritDoc}
aoqi@0	124	*/
aoqi@0	125	public String getName() {
aoqi@0	126	return NAME;
aoqi@0	127	}
aoqi@0	128
aoqi@0	129	/**
aoqi@0	130	* {@inheritDoc}
aoqi@0	131	*/
aoqi@0	132	public boolean hasMembersToDocument() {
aoqi@0	133	return constructors.size() > 0;
aoqi@0	134	}
aoqi@0	135
aoqi@0	136	/**
aoqi@0	137	* Returns a list of constructors that will be documented for the given class.
aoqi@0	138	* This information can be used for doclet specific documentation
aoqi@0	139	* generation.
aoqi@0	140	*
aoqi@0	141	* @return a list of constructors that will be documented.
aoqi@0	142	*/
aoqi@0	143	public List<ProgramElementDoc> members(ClassDoc classDoc) {
aoqi@0	144	return visibleMemberMap.getMembersFor(classDoc);
aoqi@0	145	}
aoqi@0	146
aoqi@0	147	/**
aoqi@0	148	* Return the constructor writer for this builder.
aoqi@0	149	*
aoqi@0	150	* @return the constructor writer for this builder.
aoqi@0	151	*/
aoqi@0	152	public ConstructorWriter getWriter() {
aoqi@0	153	return writer;
aoqi@0	154	}
aoqi@0	155
aoqi@0	156	/**
aoqi@0	157	* Build the constructor documentation.
aoqi@0	158	*
aoqi@0	159	* @param node the XML element that specifies which components to document
aoqi@0	160	* @param memberDetailsTree the content tree to which the documentation will be added
aoqi@0	161	*/
aoqi@0	162	public void buildConstructorDoc(XMLNode node, Content memberDetailsTree) {
aoqi@0	163	if (writer == null) {
aoqi@0	164	return;
aoqi@0	165	}
aoqi@0	166	int size = constructors.size();
aoqi@0	167	if (size > 0) {
aoqi@0	168	Content constructorDetailsTree = writer.getConstructorDetailsTreeHeader(
aoqi@0	169	classDoc, memberDetailsTree);
aoqi@0	170	for (currentConstructorIndex = 0; currentConstructorIndex < size;
aoqi@0	171	currentConstructorIndex++) {
aoqi@0	172	Content constructorDocTree = writer.getConstructorDocTreeHeader(
aoqi@0	173	(ConstructorDoc) constructors.get(currentConstructorIndex),
aoqi@0	174	constructorDetailsTree);
aoqi@0	175	buildChildren(node, constructorDocTree);
aoqi@0	176	constructorDetailsTree.addContent(writer.getConstructorDoc(
aoqi@0	177	constructorDocTree, (currentConstructorIndex == size - 1)));
aoqi@0	178	}
aoqi@0	179	memberDetailsTree.addContent(
aoqi@0	180	writer.getConstructorDetails(constructorDetailsTree));
aoqi@0	181	}
aoqi@0	182	}
aoqi@0	183
aoqi@0	184	/**
aoqi@0	185	* Build the signature.
aoqi@0	186	*
aoqi@0	187	* @param node the XML element that specifies which components to document
aoqi@0	188	* @param constructorDocTree the content tree to which the documentation will be added
aoqi@0	189	*/
aoqi@0	190	public void buildSignature(XMLNode node, Content constructorDocTree) {
aoqi@0	191	constructorDocTree.addContent(
aoqi@0	192	writer.getSignature(
aoqi@0	193	(ConstructorDoc) constructors.get(currentConstructorIndex)));
aoqi@0	194	}
aoqi@0	195
aoqi@0	196	/**
aoqi@0	197	* Build the deprecation information.
aoqi@0	198	*
aoqi@0	199	* @param node the XML element that specifies which components to document
aoqi@0	200	* @param constructorDocTree the content tree to which the documentation will be added
aoqi@0	201	*/
aoqi@0	202	public void buildDeprecationInfo(XMLNode node, Content constructorDocTree) {
aoqi@0	203	writer.addDeprecated(
aoqi@0	204	(ConstructorDoc) constructors.get(currentConstructorIndex), constructorDocTree);
aoqi@0	205	}
aoqi@0	206
aoqi@0	207	/**
aoqi@0	208	* Build the comments for the constructor. Do nothing if
aoqi@0	209	* {@link Configuration#nocomment} is set to true.
aoqi@0	210	*
aoqi@0	211	* @param node the XML element that specifies which components to document
aoqi@0	212	* @param constructorDocTree the content tree to which the documentation will be added
aoqi@0	213	*/
aoqi@0	214	public void buildConstructorComments(XMLNode node, Content constructorDocTree) {
aoqi@0	215	if (!configuration.nocomment) {
aoqi@0	216	writer.addComments(
aoqi@0	217	(ConstructorDoc) constructors.get(currentConstructorIndex),
aoqi@0	218	constructorDocTree);
aoqi@0	219	}
aoqi@0	220	}
aoqi@0	221
aoqi@0	222	/**
aoqi@0	223	* Build the tag information.
aoqi@0	224	*
aoqi@0	225	* @param node the XML element that specifies which components to document
aoqi@0	226	* @param constructorDocTree the content tree to which the documentation will be added
aoqi@0	227	*/
aoqi@0	228	public void buildTagInfo(XMLNode node, Content constructorDocTree) {
aoqi@0	229	writer.addTags((ConstructorDoc) constructors.get(currentConstructorIndex),
aoqi@0	230	constructorDocTree);
aoqi@0	231	}
aoqi@0	232	}