Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/util/PackageListWriter.java@8db45b13526e (annotated)
src/share/classes/com/sun/tools/doclets/internal/toolkit/util/PackageListWriter.java
Mon, 15 Oct 2012 17:07:55 -0700
- author
- jjg
- date
- Mon, 15 Oct 2012 17:07:55 -0700
- changeset 1364
- 8db45b13526e
- parent 1359
- 25e14ad23cef
- child 1372
- 78962d89f283
- permissions
- -rw-r--r--
8000666: javadoc should write directly to Writer instead of composing strings
Reviewed-by: bpatel
| duke@1 | 1 | /* |
| jjg@1357 | 2 | * Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved. |
| duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| duke@1 | 4 | * |
| duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
| duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| duke@1 | 10 | * |
| duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| duke@1 | 15 | * accompanied this code). |
| duke@1 | 16 | * |
| duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
| duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| duke@1 | 20 | * |
| ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
| ohair@554 | 23 | * questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package com.sun.tools.doclets.internal.toolkit.util; |
| duke@1 | 27 | |
| duke@1 | 28 | import java.io.*; |
| duke@1 | 29 | import java.util.*; |
| duke@1 | 30 | |
| jjg@1357 | 31 | import com.sun.javadoc.*; |
| jjg@1357 | 32 | import com.sun.tools.doclets.internal.toolkit.*; |
| jjg@1357 | 33 | |
| duke@1 | 34 | /** |
| duke@1 | 35 | * Write out the package index. |
| duke@1 | 36 | * |
| jjg@1359 | 37 | * <p><b>This is NOT part of any supported API. |
| jjg@1359 | 38 | * If you write code that depends on this, you do so at your own risk. |
| jjg@1359 | 39 | * This code and its internal interfaces are subject to change or |
| jjg@1359 | 40 | * deletion without notice.</b> |
| duke@1 | 41 | * |
| duke@1 | 42 | * @see com.sun.javadoc.PackageDoc |
| duke@1 | 43 | * @author Atul M Dambalkar |
| duke@1 | 44 | */ |
| duke@1 | 45 | public class PackageListWriter extends PrintWriter { |
| duke@1 | 46 | |
| duke@1 | 47 | private Configuration configuration; |
| duke@1 | 48 | |
| duke@1 | 49 | /** |
| duke@1 | 50 | * Constructor. |
| duke@1 | 51 | * |
| duke@1 | 52 | * @param configuration the current configuration of the doclet. |
| duke@1 | 53 | */ |
| duke@1 | 54 | public PackageListWriter(Configuration configuration) throws IOException { |
| duke@1 | 55 | super(Util.genWriter(configuration, configuration.destDirName, |
| duke@1 | 56 | DocletConstants.PACKAGE_LIST_FILE_NAME, configuration.docencoding)); |
| duke@1 | 57 | this.configuration = configuration; |
| duke@1 | 58 | } |
| duke@1 | 59 | |
| duke@1 | 60 | /** |
| duke@1 | 61 | * Generate the package index. |
| duke@1 | 62 | * |
| duke@1 | 63 | * @param configuration the current configuration of the doclet. |
| duke@1 | 64 | * @throws DocletAbortException |
| duke@1 | 65 | */ |
| duke@1 | 66 | public static void generate(Configuration configuration) { |
| duke@1 | 67 | PackageListWriter packgen; |
| duke@1 | 68 | try { |
| duke@1 | 69 | packgen = new PackageListWriter(configuration); |
| duke@1 | 70 | packgen.generatePackageListFile(configuration.root); |
| duke@1 | 71 | packgen.close(); |
| duke@1 | 72 | } catch (IOException exc) { |
| duke@1 | 73 | configuration.message.error("doclet.exception_encountered", |
| duke@1 | 74 | exc.toString(), DocletConstants.PACKAGE_LIST_FILE_NAME); |
| duke@1 | 75 | throw new DocletAbortException(); |
| duke@1 | 76 | } |
| duke@1 | 77 | } |
| duke@1 | 78 | |
| duke@1 | 79 | protected void generatePackageListFile(RootDoc root) { |
| duke@1 | 80 | PackageDoc[] packages = configuration.packages; |
| bpatel@995 | 81 | ArrayList<String> names = new ArrayList<String>(); |
| duke@1 | 82 | for (int i = 0; i < packages.length; i++) { |
| bpatel@995 | 83 | // if the -nodeprecated option is set and the package is marked as |
| bpatel@995 | 84 | // deprecated, do not include it in the packages list. |
| bpatel@995 | 85 | if (!(configuration.nodeprecated && Util.isDeprecated(packages[i]))) |
| bpatel@995 | 86 | names.add(packages[i].name()); |
| duke@1 | 87 | } |
| bpatel@995 | 88 | Collections.sort(names); |
| bpatel@995 | 89 | for (int i = 0; i < names.size(); i++) { |
| bpatel@995 | 90 | println(names.get(i)); |
| duke@1 | 91 | } |
| duke@1 | 92 | } |
| duke@1 | 93 | } |
