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

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

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

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

author

aoqi

date

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

changeset 2525

2eb010b6cb22

parent 1985

0e6577980181

parent 0

959103a6100f

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 1998, 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.util;
aoqi@0	27
aoqi@0	28	import java.io.*;
aoqi@0	29	import java.util.*;
aoqi@0	30
aoqi@0	31	import com.sun.javadoc.*;
aoqi@0	32	import com.sun.tools.doclets.internal.toolkit.*;
aoqi@0	33
aoqi@0	34	/**
aoqi@0	35	* Write out the package index.
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	* @see com.sun.javadoc.PackageDoc
aoqi@0	43	* @author Atul M Dambalkar
aoqi@0	44	*/
aoqi@0	45	public class PackageListWriter extends PrintWriter {
aoqi@0	46
aoqi@0	47	private Configuration configuration;
aoqi@0	48
aoqi@0	49	/**
aoqi@0	50	* Constructor.
aoqi@0	51	*
aoqi@0	52	* @param configuration the current configuration of the doclet.
aoqi@0	53	*/
aoqi@0	54	public PackageListWriter(Configuration configuration) throws IOException {
aoqi@0	55	super(DocFile.createFileForOutput(configuration, DocPaths.PACKAGE_LIST).openWriter());
aoqi@0	56	this.configuration = configuration;
aoqi@0	57	}
aoqi@0	58
aoqi@0	59	/**
aoqi@0	60	* Generate the package index.
aoqi@0	61	*
aoqi@0	62	* @param configuration the current configuration of the doclet.
aoqi@0	63	* @throws DocletAbortException
aoqi@0	64	*/
aoqi@0	65	public static void generate(Configuration configuration) {
aoqi@0	66	PackageListWriter packgen;
aoqi@0	67	try {
aoqi@0	68	packgen = new PackageListWriter(configuration);
aoqi@0	69	packgen.generatePackageListFile(configuration.root);
aoqi@0	70	packgen.close();
aoqi@0	71	} catch (IOException exc) {
aoqi@0	72	configuration.message.error("doclet.exception_encountered",
aoqi@0	73	exc.toString(), DocPaths.PACKAGE_LIST);
aoqi@0	74	throw new DocletAbortException(exc);
aoqi@0	75	}
aoqi@0	76	}
aoqi@0	77
aoqi@0	78	protected void generatePackageListFile(RootDoc root) {
aoqi@0	79	PackageDoc[] packages = configuration.packages;
aoqi@0	80	ArrayList<String> names = new ArrayList<String>();
aoqi@0	81	for (int i = 0; i < packages.length; i++) {
aoqi@0	82	// if the -nodeprecated option is set and the package is marked as
aoqi@0	83	// deprecated, do not include it in the packages list.
aoqi@0	84	if (!(configuration.nodeprecated && Util.isDeprecated(packages[i])))
aoqi@0	85	names.add(packages[i].name());
aoqi@0	86	}
aoqi@0	87	Collections.sort(names);
aoqi@0	88	for (int i = 0; i < names.size(); i++) {
aoqi@0	89	println(names.get(i));
aoqi@0	90	}
aoqi@0	91	}
aoqi@0	92	}