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

src/share/classes/com/sun/tools/doclets/internal/toolkit/builders/EnumConstantBuilder.java@959103a6100f (annotated)

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

Wed, 27 Apr 2016 01:34:52 +0800

author

aoqi

date

Wed, 27 Apr 2016 01:34:52 +0800

changeset 0

959103a6100f

child 2525

2eb010b6cb22

permissions

-rw-r--r--

Initial load
http://hg.openjdk.java.net/jdk8u/jdk8u/langtools/
changeset: 2573:53ca196be1ae
tag: jdk8u25-b17

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