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

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

src/share/classes/com/sun/tools/doclets/internal/toolkit/util/DeprecatedAPIListBuilder.java

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

author

aoqi

date

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

changeset 2525

2eb010b6cb22

parent 1359

25e14ad23cef

parent 0

959103a6100f

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 1998, 2012, 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.util;
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.Configuration;
aoqi@0	32
aoqi@0	33	/**
aoqi@0	34	* Build list of all the deprecated packages, classes, constructors, fields and methods.
aoqi@0	35	*
aoqi@0	36	* <p><b>This is NOT part of any supported API.
aoqi@0	37	* If you write code that depends on this, you do so at your own risk.
aoqi@0	38	* This code and its internal interfaces are subject to change or
aoqi@0	39	* deletion without notice.</b>
aoqi@0	40	*
aoqi@0	41	* @author Atul M Dambalkar
aoqi@0	42	*/
aoqi@0	43	public class DeprecatedAPIListBuilder {
aoqi@0	44
aoqi@0	45	public static final int NUM_TYPES = 12;
aoqi@0	46
aoqi@0	47	public static final int PACKAGE = 0;
aoqi@0	48	public static final int INTERFACE = 1;
aoqi@0	49	public static final int CLASS = 2;
aoqi@0	50	public static final int ENUM = 3;
aoqi@0	51	public static final int EXCEPTION = 4;
aoqi@0	52	public static final int ERROR = 5;
aoqi@0	53	public static final int ANNOTATION_TYPE = 6;
aoqi@0	54	public static final int FIELD = 7;
aoqi@0	55	public static final int METHOD = 8;
aoqi@0	56	public static final int CONSTRUCTOR = 9;
aoqi@0	57	public static final int ENUM_CONSTANT = 10;
aoqi@0	58	public static final int ANNOTATION_TYPE_MEMBER = 11;
aoqi@0	59
aoqi@0	60	/**
aoqi@0	61	* List of deprecated type Lists.
aoqi@0	62	*/
aoqi@0	63	private List<List<Doc>> deprecatedLists;
aoqi@0	64
aoqi@0	65
aoqi@0	66	/**
aoqi@0	67	* Constructor.
aoqi@0	68	*
aoqi@0	69	* @param configuration the current configuration of the doclet
aoqi@0	70	*/
aoqi@0	71	public DeprecatedAPIListBuilder(Configuration configuration) {
aoqi@0	72	deprecatedLists = new ArrayList<List<Doc>>();
aoqi@0	73	for (int i = 0; i < NUM_TYPES; i++) {
aoqi@0	74	deprecatedLists.add(i, new ArrayList<Doc>());
aoqi@0	75	}
aoqi@0	76	buildDeprecatedAPIInfo(configuration);
aoqi@0	77	}
aoqi@0	78
aoqi@0	79	/**
aoqi@0	80	* Build the sorted list of all the deprecated APIs in this run.
aoqi@0	81	* Build separate lists for deprecated packages, classes, constructors,
aoqi@0	82	* methods and fields.
aoqi@0	83	*
aoqi@0	84	* @param configuration the current configuration of the doclet.
aoqi@0	85	*/
aoqi@0	86	private void buildDeprecatedAPIInfo(Configuration configuration) {
aoqi@0	87	PackageDoc[] packages = configuration.packages;
aoqi@0	88	PackageDoc pkg;
aoqi@0	89	for (int c = 0; c < packages.length; c++) {
aoqi@0	90	pkg = packages[c];
aoqi@0	91	if (Util.isDeprecated(pkg)) {
aoqi@0	92	getList(PACKAGE).add(pkg);
aoqi@0	93	}
aoqi@0	94	}
aoqi@0	95	ClassDoc[] classes = configuration.root.classes();
aoqi@0	96	for (int i = 0; i < classes.length; i++) {
aoqi@0	97	ClassDoc cd = classes[i];
aoqi@0	98	if (Util.isDeprecated(cd)) {
aoqi@0	99	if (cd.isOrdinaryClass()) {
aoqi@0	100	getList(CLASS).add(cd);
aoqi@0	101	} else if (cd.isInterface()) {
aoqi@0	102	getList(INTERFACE).add(cd);
aoqi@0	103	} else if (cd.isException()) {
aoqi@0	104	getList(EXCEPTION).add(cd);
aoqi@0	105	} else if (cd.isEnum()) {
aoqi@0	106	getList(ENUM).add(cd);
aoqi@0	107	} else if (cd.isError()) {
aoqi@0	108	getList(ERROR).add(cd);
aoqi@0	109	} else if (cd.isAnnotationType()) {
aoqi@0	110	getList(ANNOTATION_TYPE).add(cd);
aoqi@0	111	}
aoqi@0	112	}
aoqi@0	113	composeDeprecatedList(getList(FIELD), cd.fields());
aoqi@0	114	composeDeprecatedList(getList(METHOD), cd.methods());
aoqi@0	115	composeDeprecatedList(getList(CONSTRUCTOR), cd.constructors());
aoqi@0	116	if (cd.isEnum()) {
aoqi@0	117	composeDeprecatedList(getList(ENUM_CONSTANT), cd.enumConstants());
aoqi@0	118	}
aoqi@0	119	if (cd.isAnnotationType()) {
aoqi@0	120	composeDeprecatedList(getList(ANNOTATION_TYPE_MEMBER),
aoqi@0	121	((AnnotationTypeDoc) cd).elements());
aoqi@0	122	}
aoqi@0	123	}
aoqi@0	124	sortDeprecatedLists();
aoqi@0	125	}
aoqi@0	126
aoqi@0	127	/**
aoqi@0	128	* Add the members into a single list of deprecated members.
aoqi@0	129	*
aoqi@0	130	* @param list List of all the particular deprecated members, e.g. methods.
aoqi@0	131	* @param members members to be added in the list.
aoqi@0	132	*/
aoqi@0	133	private void composeDeprecatedList(List<Doc> list, MemberDoc[] members) {
aoqi@0	134	for (int i = 0; i < members.length; i++) {
aoqi@0	135	if (Util.isDeprecated(members[i])) {
aoqi@0	136	list.add(members[i]);
aoqi@0	137	}
aoqi@0	138	}
aoqi@0	139	}
aoqi@0	140
aoqi@0	141	/**
aoqi@0	142	* Sort the deprecated lists for class kinds, fields, methods and
aoqi@0	143	* constructors.
aoqi@0	144	*/
aoqi@0	145	private void sortDeprecatedLists() {
aoqi@0	146	for (int i = 0; i < NUM_TYPES; i++) {
aoqi@0	147	Collections.sort(getList(i));
aoqi@0	148	}
aoqi@0	149	}
aoqi@0	150
aoqi@0	151	/**
aoqi@0	152	* Return the list of deprecated Doc objects of a given type.
aoqi@0	153	*
aoqi@0	154	* @param type the constant representing the type of list being returned.
aoqi@0	155	*/
aoqi@0	156	public List<Doc> getList(int type) {
aoqi@0	157	return deprecatedLists.get(type);
aoqi@0	158	}
aoqi@0	159
aoqi@0	160	/**
aoqi@0	161	* Return true if the list of a given type has size greater than 0.
aoqi@0	162	*
aoqi@0	163	* @param type the type of list being checked.
aoqi@0	164	*/
aoqi@0	165	public boolean hasDocumentation(int type) {
aoqi@0	166	return (deprecatedLists.get(type)).size() > 0;
aoqi@0	167	}
aoqi@0	168	}