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

src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/PropertyBuilder.java@ccbe7ffdd867 (annotated)

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

Sun, 24 Feb 2013 11:36:58 -0800

author

jjg

date

Sun, 24 Feb 2013 11:36:58 -0800

changeset 1606

ccbe7ffdd867

parent 0

959103a6100f

permissions

-rw-r--r--

7112427: The doclet needs to be able to generate JavaFX documentation.
Reviewed-by: jjg
Contributed-by: jan.valenta@oracle.com

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.tools.doclets.internal.toolkit.util.*;
aoqi@0	31	import com.sun.tools.doclets.internal.toolkit.*;
aoqi@0	32	import com.sun.javadoc.*;
aoqi@0	33
aoqi@0	34	/**
aoqi@0	35	* Builds documentation for a property.
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.7
aoqi@0	45	*/
aoqi@0	46	public class PropertyBuilder extends AbstractMemberBuilder {
aoqi@0	47
aoqi@0	48	/**
aoqi@0	49	* The class whose properties are being documented.
aoqi@0	50	*/
aoqi@0	51	private final ClassDoc classDoc;
aoqi@0	52
aoqi@0	53	/**
aoqi@0	54	* The visible properties for the given class.
aoqi@0	55	*/
aoqi@0	56	private final VisibleMemberMap visibleMemberMap;
aoqi@0	57
aoqi@0	58	/**
aoqi@0	59	* The writer to output the property documentation.
aoqi@0	60	*/
aoqi@0	61	private final PropertyWriter writer;
aoqi@0	62
aoqi@0	63	/**
aoqi@0	64	* The list of properties being documented.
aoqi@0	65	*/
aoqi@0	66	private final List<ProgramElementDoc> properties;
aoqi@0	67
aoqi@0	68	/**
aoqi@0	69	* The index of the current property that is being documented at this point
aoqi@0	70	* in time.
aoqi@0	71	*/
aoqi@0	72	private int currentPropertyIndex;
aoqi@0	73
aoqi@0	74	/**
aoqi@0	75	* Construct a new PropertyBuilder.
aoqi@0	76	*
aoqi@0	77	* @param context the build context.
aoqi@0	78	* @param classDoc the class whoses members are being documented.
aoqi@0	79	* @param writer the doclet specific writer.
aoqi@0	80	*/
aoqi@0	81	private PropertyBuilder(Context context,
aoqi@0	82	ClassDoc classDoc,
aoqi@0	83	PropertyWriter writer) {
aoqi@0	84	super(context);
aoqi@0	85	this.classDoc = classDoc;
aoqi@0	86	this.writer = writer;
aoqi@0	87	visibleMemberMap =
aoqi@0	88	new VisibleMemberMap(
aoqi@0	89	classDoc,
aoqi@0	90	VisibleMemberMap.PROPERTIES,
aoqi@0	91	configuration);
aoqi@0	92	properties =
aoqi@0	93	new ArrayList<ProgramElementDoc>(visibleMemberMap.getMembersFor(classDoc));
aoqi@0	94	if (configuration.getMemberComparator() != null) {
aoqi@0	95	Collections.sort(properties, configuration.getMemberComparator());
aoqi@0	96	}
aoqi@0	97	}
aoqi@0	98
aoqi@0	99	/**
aoqi@0	100	* Construct a new PropertyBuilder.
aoqi@0	101	*
aoqi@0	102	* @param context the build context.
aoqi@0	103	* @param classDoc the class whoses members are being documented.
aoqi@0	104	* @param writer the doclet specific writer.
aoqi@0	105	*/
aoqi@0	106	public static PropertyBuilder getInstance(Context context,
aoqi@0	107	ClassDoc classDoc,
aoqi@0	108	PropertyWriter writer) {
aoqi@0	109	return new PropertyBuilder(context, classDoc, writer);
aoqi@0	110	}
aoqi@0	111
aoqi@0	112	/**
aoqi@0	113	* {@inheritDoc}
aoqi@0	114	*/
aoqi@0	115	public String getName() {
aoqi@0	116	return "PropertyDetails";
aoqi@0	117	}
aoqi@0	118
aoqi@0	119	/**
aoqi@0	120	* Returns a list of properties that will be documented for the given class.
aoqi@0	121	* This information can be used for doclet specific documentation
aoqi@0	122	* generation.
aoqi@0	123	*
aoqi@0	124	* @param classDoc the {@link ClassDoc} we want to check.
aoqi@0	125	* @return a list of properties that will be documented.
aoqi@0	126	*/
aoqi@0	127	public List<ProgramElementDoc> members(ClassDoc classDoc) {
aoqi@0	128	return visibleMemberMap.getMembersFor(classDoc);
aoqi@0	129	}
aoqi@0	130
aoqi@0	131	/**
aoqi@0	132	* Returns the visible member map for the properties of this class.
aoqi@0	133	*
aoqi@0	134	* @return the visible member map for the properties of this class.
aoqi@0	135	*/
aoqi@0	136	public VisibleMemberMap getVisibleMemberMap() {
aoqi@0	137	return visibleMemberMap;
aoqi@0	138	}
aoqi@0	139
aoqi@0	140	/**
aoqi@0	141	* summaryOrder.size()
aoqi@0	142	*/
aoqi@0	143	public boolean hasMembersToDocument() {
aoqi@0	144	return properties.size() > 0;
aoqi@0	145	}
aoqi@0	146
aoqi@0	147	/**
aoqi@0	148	* Build the property documentation.
aoqi@0	149	*
aoqi@0	150	* @param node the XML element that specifies which components to document
aoqi@0	151	* @param memberDetailsTree the content tree to which the documentation will be added
aoqi@0	152	*/
aoqi@0	153	public void buildPropertyDoc(XMLNode node, Content memberDetailsTree) {
aoqi@0	154	if (writer == null) {
aoqi@0	155	return;
aoqi@0	156	}
aoqi@0	157	int size = properties.size();
aoqi@0	158	if (size > 0) {
aoqi@0	159	Content propertyDetailsTree = writer.getPropertyDetailsTreeHeader(
aoqi@0	160	classDoc, memberDetailsTree);
aoqi@0	161	for (currentPropertyIndex = 0; currentPropertyIndex < size;
aoqi@0	162	currentPropertyIndex++) {
aoqi@0	163	Content propertyDocTree = writer.getPropertyDocTreeHeader(
aoqi@0	164	(MethodDoc) properties.get(currentPropertyIndex),
aoqi@0	165	propertyDetailsTree);
aoqi@0	166	buildChildren(node, propertyDocTree);
aoqi@0	167	propertyDetailsTree.addContent(writer.getPropertyDoc(
aoqi@0	168	propertyDocTree, (currentPropertyIndex == size - 1)));
aoqi@0	169	}
aoqi@0	170	memberDetailsTree.addContent(
aoqi@0	171	writer.getPropertyDetails(propertyDetailsTree));
aoqi@0	172	}
aoqi@0	173	}
aoqi@0	174
aoqi@0	175	/**
aoqi@0	176	* Build the signature.
aoqi@0	177	*
aoqi@0	178	* @param node the XML element that specifies which components to document
aoqi@0	179	* @param propertyDocTree the content tree to which the documentation will be added
aoqi@0	180	*/
aoqi@0	181	public void buildSignature(XMLNode node, Content propertyDocTree) {
aoqi@0	182	propertyDocTree.addContent(
aoqi@0	183	writer.getSignature((MethodDoc) properties.get(currentPropertyIndex)));
aoqi@0	184	}
aoqi@0	185
aoqi@0	186	/**
aoqi@0	187	* Build the deprecation information.
aoqi@0	188	*
aoqi@0	189	* @param node the XML element that specifies which components to document
aoqi@0	190	* @param propertyDocTree the content tree to which the documentation will be added
aoqi@0	191	*/
aoqi@0	192	public void buildDeprecationInfo(XMLNode node, Content propertyDocTree) {
aoqi@0	193	writer.addDeprecated(
aoqi@0	194	(MethodDoc) properties.get(currentPropertyIndex), propertyDocTree);
aoqi@0	195	}
aoqi@0	196
aoqi@0	197	/**
aoqi@0	198	* Build the comments for the property. Do nothing if
aoqi@0	199	* {@link Configuration#nocomment} is set to true.
aoqi@0	200	*
aoqi@0	201	* @param node the XML element that specifies which components to document
aoqi@0	202	* @param propertyDocTree the content tree to which the documentation will be added
aoqi@0	203	*/
aoqi@0	204	public void buildPropertyComments(XMLNode node, Content propertyDocTree) {
aoqi@0	205	if (!configuration.nocomment) {
aoqi@0	206	writer.addComments((MethodDoc) properties.get(currentPropertyIndex), propertyDocTree);
aoqi@0	207	}
aoqi@0	208	}
aoqi@0	209
aoqi@0	210	/**
aoqi@0	211	* Build the tag information.
aoqi@0	212	*
aoqi@0	213	* @param node the XML element that specifies which components to document
aoqi@0	214	* @param propertyDocTree the content tree to which the documentation will be added
aoqi@0	215	*/
aoqi@0	216	public void buildTagInfo(XMLNode node, Content propertyDocTree) {
aoqi@0	217	writer.addTags((MethodDoc) properties.get(currentPropertyIndex), propertyDocTree);
aoqi@0	218	}
aoqi@0	219
aoqi@0	220	/**
aoqi@0	221	* Return the property writer for this builder.
aoqi@0	222	*
aoqi@0	223	* @return the property writer for this builder.
aoqi@0	224	*/
aoqi@0	225	public PropertyWriter getWriter() {
aoqi@0	226	return writer;
aoqi@0	227	}
aoqi@0	228	}